Mahasiswaprofilebundle Laravel Package

## Getting Started
### Minimal Setup
1. **Installation**:
   - Add the package to `composer.json` under `require`:
     ```json
     "ais/mahasiswaprofilebundle": "dev-master"
     ```
   - Run `composer update` in your project root.

2. **Register Bundle**:
   Add the bundle to `AppKernel.php` under `registerBundles()`:
   ```php
   new Ais\MahasiswaProfileBundle\AisMahasiswaProfileBundle(),

Ensure dependencies (NelmioApiDocBundle, FOSRestBundle, JMSSerializerBundle) are also included.

3. Routing: Import routes in app/config/routing.yml:

   ais_mahasiswaprofiles:
     type: rest
     prefix: /api
     resource: "@AisMahasiswaProfileBundle/Resources/config/routes.yml"
   

4. Access API Docs: Navigate to /api/doc (e.g., http://localhost/web/app_dev.php/api/doc) to explore endpoints.

First Use Case: Fetching a Student Profile

• Use the API endpoint (e.g., GET /api/mahasiswaprofiles/{id}) to retrieve a student profile.
• Leverage NelmioApiDocBundle to inspect available routes and request/response formats.

Implementation Patterns

Workflows

1. CRUD Operations:

   • Use RESTful endpoints (e.g., POST /api/mahasiswaprofiles for creation, PUT /api/mahasiswaprofiles/{id} for updates).
   • Validate requests with Symfony’s validation component (e.g., @Assert\NotBlank in entities).

2. Data Serialization:

   • Customize serialization/deserialization via JMSSerializerBundle (e.g., override serializer.yml for specific fields).
   • Example:

     # app/config/config.yml
     jms_serializer:
         metadata:
             directories:
                 AisMahasiswaProfileBundle:
                     namespace_prefix: "Ais\\MahasiswaProfileBundle\\Serializer"
                     path: "%kernel.root_dir%/serializer"
     

3. Integration with Doctrine:

   • Extend the MahasiswaProfile entity (e.g., src/Ais/MahasiswaProfileBundle/Entity/MahasiswaProfile.php) to add custom fields or behaviors.
   • Example:

     namespace Ais\MahasiswaProfileBundle\Entity;
     use Doctrine\ORM\Mapping as ORM;
     
     /**
      * @ORM\Entity
      */
     class MahasiswaProfile {
         // ...
         /**
          * @ORM\Column(type="string", length=255)
          */
         private $customField;
     }
     

4. API Documentation:

   • Use NelmioApiDocBundle annotations to document endpoints (e.g., @SWG\Tag(name="Mahasiswa")).
   • Example:

     use Nelmio\ApiDocBundle\Annotation\ApiDoc;
     
     /**
      * @ApiDoc(
      *     resource=true,
      *     description="Get a student profile"
      * )
      */
     

Integration Tips

1. Event Listeners:

   • Subscribe to Doctrine lifecycle events (e.g., prePersist, preUpdate) to modify data before saving.
   • Example:

     // src/Ais/MahasiswaProfileBundle/EventListener/MahasiswaProfileListener.php
     namespace Ais\MahasiswaProfileBundle\EventListener;
     use Doctrine\ORM\Event\LifecycleEventArgs;
     
     class MahasiswaProfileListener {
         public function prePersist(LifecycleEventArgs $args) {
             $entity = $args->getEntity();
             if ($entity instanceof MahasiswaProfile) {
                 $entity->setCreatedAt(new \DateTime());
             }
         }
     }
     

   • Register in services.yml:

     services:
         ais_mahasiswaprofile.listener:
             class: Ais\MahasiswaProfileBundle\EventListener\MahasiswaProfileListener
             tags:
                 - { name: doctrine.event_listener, event: prePersist }
     

2. Custom Controllers:

   • Override or extend controllers (e.g., src/Ais/MahasiswaProfileBundle/Controller/MahasiswaProfileController.php) to add business logic.
   • Example:

     namespace Ais\MahasiswaProfileBundle\Controller;
     use FOS\RestBundle\Controller\FOSRestController;
     use Symfony\Component\HttpFoundation\Request;
     
     class MahasiswaProfileController extends FOSRestController {
         public function customAction(Request $request) {
             // Custom logic
             return $this->handleView($this->view(['data' => 'custom']));
         }
     }
     

3. Form Handling:

   • Use Symfony forms to validate and process input (e.g., MahasiswaProfileType).
   • Example:

     // src/Ais/MahasiswaProfileBundle/Form/MahasiswaProfileType.php
     namespace Ais\MahasiswaProfileBundle\Form;
     use Symfony\Component\Form\AbstractType;
     use Symfony\Component\Form\FormBuilderInterface;
     
     class MahasiswaProfileType extends AbstractType {
         public function buildForm(FormBuilderInterface $builder, array $options) {
             $builder->add('name', 'text');
             $builder->add('email', 'email');
         }
     }
     

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Legacy:

   • The bundle targets Symfony 2.7, which is end-of-life. Ensure compatibility with your project’s dependencies (e.g., Doctrine ORM 2.4.8).
   • Avoid using modern Symfony features (e.g., Symfony 4/5 components) without polyfills.

2. Missing Type Safety:

   • The bundle lacks modern PHP type hints (e.g., return MahasiswaProfile instead of return array). Add type hints manually for better IDE support.

3. Undocumented Dependencies:

   • The bundle requires NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle but doesn’t document their versions explicitly. Pin versions in composer.json to avoid conflicts:

     "nelmio/api-doc-bundle": "2.15.*",
     "friendsofsymfony/rest-bundle": "2.5.*",
     "jms/serializer-bundle": "1.1.*"
     

4. Route Overrides:

   • If you override routes (e.g., in routing.yml), ensure the prefix and resource paths match the bundle’s structure (@AisMahasiswaProfileBundle/Resources/config/routes.yml).

Debugging

1. API Doc Issues:

   • If /api/doc fails, verify:
     • NelmioApiDocBundle is registered in AppKernel.php.
     • The routing.yml includes the NelmioApiDocBundle route.
     • No PHP errors in logs (app/logs/dev.log).

2. Serialization Errors:

   • Check JMSSerializerBundle configuration (config.yml) for correct metadata paths.
   • Clear cache after adding custom serializers:

     php app/console cache:clear
     

3. Doctrine Migrations:

   • If the MahasiswaProfile entity schema changes, create a migration:

     php app/console doctrine:migrations:diff
     php app/console doctrine:migrations:migrate
     

Tips

1. Extending Entities:

   • To add fields, extend the base entity and update the database schema:

     php app/console doctrine:schema:update --force
     

   • Example extension:

     namespace AppBundle\Entity;
     use Ais\MahasiswaProfileBundle\Entity\MahasiswaProfile as BaseProfile;
     
     class MahasiswaProfile extends BaseProfile {
         /**
          * @ORM\Column(type="string")
          */
         private $extensionField;
     }
     

2. Testing:

   • Use LiipFunctionalTestBundle (dev dependency) to write functional tests for API endpoints.
   • Example test case:

     namespace Tests\Ais\MahasiswaProfileBundle;
     use Liip\FunctionalTestBundle\Test\WebTestCase;
     
     class MahasiswaProfileTest extends WebTestCase {
         public function testGetProfile() {
             $client = static::createClient();
             $client->request('GET', '/api/mahasiswaprofiles/1');
             $this->assertEquals(200, $client->getResponse()->getStatusCode());
         }
     }
     

3. Performance:

   • Use DQL or repository methods to optimize queries (e.g., findBy with pagination):

     $repository->findBy(array(), null, 10, 0); // Limit 10 results
     

4. Custom Validation:

   • Add constraints to entities for validation (e.g., @Assert\Length):

     use Symfony\Component\Validator\Constraints as Assert;
     
     /**
      * @ORM\Entity
      * @Assert\Callback(methods={"validateCustomRules"})
      */
     class MahasiswaProfile {
         // ...
         public function validateCustomRules($context) {
             // Custom validation