Pertemuanmahasiswabundle Laravel Package

Getting Started

Minimal Setup Steps

1. Install via Composer Add to composer.json:

   "require": {
       "ais/pertemuanmahasiswabundle": "dev-master"
   }
   

   Run:

   composer update
   

2. Register the Bundle Add to app/AppKernel.php:

   new Ais\PertemuanMahasiswaBundle\AisPertemuanMahasiswaBundle(),
   

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

3. Configure Routing Add to app/config/routing.yml:

   ais_pertemuanmahasiswas:
     type: rest
     prefix: /api
     resource: "@AisPertemuanMahasiswaBundle/Resources/config/routes.yml"
   

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

First Use Case: CRUD for PertemuanMahasiswa

• Create a Meeting: Send a POST to /api/pertemuanmahasiswas with JSON payload:

  {
      "nama_pertemuan": "Seminar AI",
      "tanggal": "2023-12-01",
      "deskripsi": "Diskusi tentang AI trends"
  }
  

• Fetch Meetings: Use GET /api/pertemuanmahasiswas to retrieve all meetings or filter by ID (/api/pertemuanmahasiswas/{id}).

Implementation Patterns

Workflows

1. RESTful API Integration

   • Leverage FOSRestBundle for standardized API responses (e.g., 201 Created on success, 404 Not Found for missing resources).
   • Use NelmioApiDocBundle to auto-generate Swagger/OpenAPI docs for client-side SDKs.

2. Entity Management

   • The bundle likely includes a PertemuanMahasiswa entity (check src/Ais/PertemuanMahasiswaBundle/Entity/).
   • Extend or override entity behavior via Doctrine Events (e.g., pre-save validation):

     // src/Ais/PertemuanMahasiswaBundle/EventListener/PertemuanListener.php
     public function prePersist(PertemuanMahasiswa $pertemuan)
     {
         $pertemuan->setCreatedAt(new \DateTime());
     }
     

3. Serialization

   • Customize serialization with JMS Serializer (e.g., exclude sensitive fields):

     # config/config.yml
     jms_serializer:
         metadata:
             directories:
                 AisPertemuanMahasiswa:
                     namespace_prefix: "Ais\\PertemuanMahasiswaBundle\\Entity"
                     path: "%kernel.root_dir%/serializer"
     

4. Validation

   • Add constraints to the PertemuanMahasiswa entity:

     use Symfony\Component\Validator\Constraints as Assert;
     
     /**
      * @Assert\NotBlank()
      * @Assert\Length(min=3)
      */
     private $nama_pertemuan;
     

Integration Tips

• Database Migrations: Run:

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

• Testing: Use LiipFunctionalTestBundle for API tests:

  // Tests/AisPertemuanMahasiswaBundle/Controller/PertemuanControllerTest.php
  public function testCreatePertemuan()
  {
      $client = static::createClient();
      $client->request('POST', '/api/pertemuanmahasiswas', [
          'json' => ['nama_pertemuan' => 'Test Meeting']
      ]);
      $this->assertEquals(201, $client->getResponse()->getStatusCode());
  }
  

• Frontend Integration: Use fetch or axios to call the API:

  // Example with Axios
  axios.post('/api/pertemuanmahasiswas', {
      nama_pertemuan: 'New Meeting',
      tanggal: '2023-12-15'
  });
  

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Legacy:

   • Avoid modern Laravel/Symfony 5+ features (e.g., attributes for routing). Stick to YAML/XML configs.
   • Fix: Use sensio/framework-extra-bundle for annotations if needed.

2. Missing Documentation:

   • The bundle lacks detailed docs. Inspect:
     • src/Ais/PertemuanMahasiswaBundle/Resources/config/routing.yml for endpoints.
     • src/Ais/PertemuanMahasiswaBundle/Entity/PertemuanMahasiswa.php for entity structure.

3. NelmioApiDocBundle Dependency:

   • API docs won’t render without it. Ensure:

     # app/config/config.yml
     nelmio_api_doc:
         areas: [default]
     

4. Dev-Master Instability:

   • The dev-master branch may break. Fork and pin a stable commit:

     "ais/pertemuanmahasiswabundle": "dev-v1.0.0"
     

Debugging Tips

1. Enable Profiler: Add to app/config/config_dev.yml:

   web_profiler: { toolbar: true, intercept_redirects: false }
   

2. Doctrine Logging: Enable SQL logging in config_dev.yml:

   doctrine:
       dbal:
           logging: true
   

3. Common Errors:

   • 404 Not Found: Verify routing in routing.yml and AppKernel.php.
   • 500 Server Error: Check Symfony logs (app/logs/dev.log) for exceptions.

Extension Points

1. Custom Controllers: Override the default controller:

   // src/Ais/PertemuanMahasiswaBundle/Controller/PertemuanController.php
   class PertemuanController extends ContainerAwareController
   {
       public function customAction()
       {
           return $this->json(['custom' => 'data']);
       }
   }
   

   Update routing.yml to include the new route.

2. Event Subscribers: Listen to prePersist/preUpdate events:

   // src/Ais/PertemuanMahasiswaBundle/EventListener/AuditListener.php
   class AuditListener implements EventSubscriber
   {
       public function getSubscribedEvents()
       {
           return ['prePersist', 'preUpdate'];
       }
   
       public function prePersist(LifecycleEventArgs $args)
       {
           $pertemuan = $args->getEntity();
           $pertemuan->setUpdatedBy('current_user');
       }
   }
   

3. Custom Validation: Add constraints dynamically:

   // src/Ais/PertemuanMahasiswaBundle/Validator/Constraints/TanggalValidator.php
   class TanggalValidator extends ConstraintValidator
   {
       public function validate($value, Constraint $constraint)
       {
           if ($value < new \DateTime('today')) {
               $this->context->buildViolation('Tanggal must be in the future')->addViolation();
           }
       }
   }
   

4. API Extensions: Add new endpoints by extending the bundle’s routing:

   # app/config/routing.yml
   ais_pertemuan_custom:
       type: rest
       resource: "@AisPertemuanMahasiswaBundle/Resources/config/custom_routes.yml"