Pertemuanbundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add to composer.json:

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

   Run:

   composer update ais/pertemuanbundle
   

2. Register Bundle In AppKernel.php, add:

   new Ais\PertemuanBundle\AisPertemuanBundle(),
   new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
   new FOS\RestBundle\FOSRestBundle(),
   new JMS\SerializerBundle\JMSSerializerBundle(),
   

3. Configure Routing In app/config/routing.yml:

   ais_pertemuans:
     type: rest
     prefix: /api
     resource: "@AisPertemuanBundle/Resources/config/routes.yml"
   NelmioApiDocBundle:
     resource: "@NelmioApiDocBundle/Resources/config/routing.yml"
     prefix: /api/doc
   

4. First Use Case Access the API docs at:

   http://localhost/web/app_dev.php/api/doc
   

   Test endpoints (e.g., GET /api/pertemuans).

Implementation Patterns

Core Workflows

1. RESTful API Development

   • Leverage FOSRestBundle for standardized API responses (e.g., @Route, @QueryParam).
   • Use NelmioApiDocBundle for auto-generated Swagger docs (document endpoints as you build).

2. Entity Management

   • Extend AisPertemuanBundle's base entities (e.g., Pertemuan) via Doctrine:

     // src/Acme/AppBundle/Entity/CustomPertemuan.php
     use Ais\PertemuanBundle\Entity\Pertemuan as BasePertemuan;
     
     class CustomPertemuan extends BasePertemuan {
         // Add custom fields/methods
     }
     

3. Serialization

   • Customize JMS Serializer annotations for API responses:

     use JMS\Serializer\Annotation as Serializer;
     
     class CustomPertemuan {
         /**
          * @Serializer\ExclusionPolicy("all")
          */
         private $sensitiveData;
     
         /**
          * @Serializer\Expose
          */
         public function getFormattedDate() { ... }
     }
     

4. Validation

   • Use Symfony’s Validator with constraints:

     use Symfony\Component\Validator\Constraints as Assert;
     
     class CustomPertemuan {
         /**
          * @Assert\NotBlank
          * @Assert\Length(min=3)
          */
         private $topic;
     }
     

5. Event Listeners

   • Hook into Doctrine lifecycle events (e.g., prePersist):

     // src/Acme/AppBundle/EventListener/PertemuanListener.php
     use Doctrine\Common\PersistenceEventArgs;
     
     class PertemuanListener {
         public function prePersist(Pertemuan $pertemuan, PersistenceEventArgs $args) {
             $pertemuan->setCreatedAt(new \DateTime());
         }
     }
     

     Register in services.yml:

     services:
         acme.listener.pertemuan:
             class: Acme\AppBundle\EventListener\PertemuanListener
             tags:
                 - { name: doctrine.event_listener, event: prePersist }
     

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Dependency

   • The bundle is hardcoded for Symfony 2.7.4. Avoid mixing with newer Symfony versions (e.g., 3.x/4.x) without forking.
   • Workaround: Use a custom fork or containerize the app with symfony/symfony:2.7.

2. Missing Documentation

   • No clear entity structure or API contract in the README. Inspect src/Ais/PertemuanBundle/Entity/ for base models.
   • Tip: Enable debug:container to list all services:

     php app/console debug:container | grep pertemuan
     

3. NelmioApiDocBundle Dependency

   • API docs won’t render without NelmioApiDocBundle configured. Ensure:
     • fos_rest routes are properly prefixed.
     • @ApiDoc annotations are added to controllers.

4. JMS Serializer Conflicts

   • If responses are malformed, check for serializer group conflicts:

     # app/config/config.yml
     jms_serializer:
         metadata:
             directories:
                 Acme:
                     namespace_prefix: "Acme\\AppBundle\\Serializer"
                     path: "%kernel.root_dir%/serializer"
     

5. Dev-Master Instability

   • The dev-master branch may break. Pin to a commit in composer.json:

     "ais/pertemuanbundle": "dev-abc1234"
     

Debugging Tips

1. Enable Profiler

   php app/console debug:router | grep pertemuan
   

   Check the profiler for Doctrine queries or validation errors.

2. Log Serialization Issues Add to config.yml:

   jms_serializer:
       handlers:
           datetime:
               default_format: "Y-m-d H:i:s"
               format: "Y-m-d H:i:s"
   

3. Override Bundle Templates Copy AisPertemuanBundle/Resources/views/ to AcmeAppBundle/Resources/AisPertemuanBundle/views/ to customize templates.

Extension Points

1. Custom Controllers Extend the bundle’s controllers (e.g., PertemuanController) by:

   • Creating a new controller in Acme/AppBundle/Controller/PertemuanController.
   • Override actions with prepend/append in routing:

     ais_pertemuans_custom:
         type: rest
         prefix: /api
         resource: "@AcmeAppBundle/Resources/config/routing.yml"
         requirements:
             _controller: Acme\AppBundle\Controller\PertemuanController::*
     

2. Add Fields to Entities Use Doctrine inheritance:

   // src/Acme/AppBundle/Entity/PertemuanExtension.php
   use Ais\PertemuanBundle\Entity\Pertemuan as BasePertemuan;
   
   class PertemuanExtension extends BasePertemuan {
       /**
        * @ORM\Column(type="string")
        */
       private $customField;
   }
   

3. Event Dispatching Trigger custom events for pertemuan actions:

   // src/Acme/AppBundle/Event/PertemuanEvent.php
   class PertemuanEvent extends Event {
       protected $pertemuan;
   }
   

   Dispatch in a controller:

   $event = new PertemuanEvent($pertemuan);
   $this->get('event_dispatcher')->dispatch('pertemuan.create', $event);