Prestasibundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require ais/prestasibundle:dev-master
   

   Ensure your composer.json includes the required dependencies (FOSRestBundle, JMSSerializerBundle, NelmioApiDocBundle).

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

   new Ais\PrestasiBundle\AisPrestasiBundle(),
   new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
   new FOS\RestBundle\FOSRestBundle(),
   new JMS\SerializerBundle\JMSSerializerBundle(),
   

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

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

4. First Use Case: Access the API docs at /api/doc to explore available endpoints. The bundle likely provides RESTful endpoints for "Prestasi" (Indonesian for "achievement" or "performance") entities.

Implementation Patterns

Workflows

1. Entity Management: The bundle likely abstracts CRUD operations for a Prestasi entity. Use FOSRestBundle annotations to define routes:

   use FOS\RestBundle\Controller\Annotations\Route;
   use FOS\RestBundle\Controller\Annotations\NamePrefix;
   
   /**
    * @NamePrefix("prestasi_")
    */
   class PrestasiController extends FOS\RestBundle\Controller\FOSRestController
   {
       /**
        * @Route("/prestasi", name="get_prestasi")
        */
       public function getPrestasiAction()
       {
           // Fetch and return Prestasi entities
       }
   }
   

2. Serialization: Leverage JMSSerializerBundle for custom serialization:

   # app/config/config.yml
   jms_serializer:
       metadata:
           directories:
               AisPrestasiBundle:
                   namespace_prefix: "Ais\\PrestasiBundle\\Serializer"
                   path: "%kernel.root_dir%/../vendor/ais/prestasibundle/Resources/config/serializer"
   

3. API Documentation: Use NelmioApiDocBundle to auto-generate Swagger docs. Annotate controllers:

   use Nelmio\ApiDocBundle\Annotation\ApiDoc;
   
   /**
    * @ApiDoc(
    *     resource=true,
    *     description="List all Prestasi"
    * )
    */
   public function getPrestasiAction()
   

4. Integration with Doctrine: Extend the Prestasi entity (likely in Ais\PrestasiBundle\Entity\Prestasi) and use Doctrine repositories for complex queries:

   $prestasi = $this->getDoctrine()
       ->getRepository('AisPrestasiBundle:Prestasi')
       ->findBy(['user' => $userId]);
   

Gotchas and Tips

Pitfalls

1. Symfony Version Mismatch: The bundle targets Symfony 2.7.4. Ensure your project matches this version or fork the bundle for compatibility with Symfony 4/5/6.

   • Fix: Use symfony/symfony:2.7.* in composer.json or override dependencies.

2. Missing Dependencies: The bundle requires NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle. Forgetting to install these will break routing/API docs.

   • Fix: Run composer require nelmio/api-doc-bundle fos/rest-bundle jms/serializer-bundle.

3. Route Conflicts: The prefix: /api in routing.yml may clash with other bundles. Use unique prefixes or namespaces.

   • Fix: Adjust prefix or use route namespacing:

     ais_prestasi:
       resource: "@AisPrestasiBundle/Resources/config/routes.yml"
       type: rest
       prefix: /v1/prestasi
     

4. Dev-Master Instability: The bundle is in dev-master. Expect breaking changes or missing features.

   • Fix: Fork the repo and pin to a specific commit in composer.json.

Debugging Tips

1. Check API Docs: If endpoints aren’t visible in /api/doc, verify:

   • NelmioApiDocBundle is registered.
   • Controllers have @ApiDoc or @Route annotations.
   • No PHP errors in logs (app/logs/dev.log).

2. Doctrine Migrations: The bundle may include migrations. Run:

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

3. Serialization Issues: If responses are malformed, validate:

   • JMSSerializerBundle is configured in config.yml.
   • Entity properties are annotated with @SerializedName or @Type.

Extension Points

1. Custom Entities: Extend the Prestasi entity by creating a child class:

   namespace AppBundle\Entity;
   
   use Ais\PrestasiBundle\Entity\Prestasi as BasePrestasi;
   
   class CustomPrestasi extends BasePrestasi
   {
       // Add custom fields/methods
   }
   

2. Event Listeners: Hook into bundle events (e.g., prestasi.pre_save) via Symfony’s event dispatcher:

   $dispatcher->addListener('prestasi.pre_save', function ($event) {
       $prestasi = $event->getPrestasi();
       // Modify $prestasi before save
   });
   

3. Override Templates: Override bundle templates by copying files from:

   vendor/ais/prestasibundle/Resources/views/
   

   to:

   app/Resources/AisPrestasiBundle/views/
   

4. Add New Routes: Extend routes.yml in your bundle or create a custom route file:

   # app/config/routing.yml
   app_prestasi_custom:
     resource: "@AppBundle/Resources/config/routing/prestasi.yml"
     prefix: /api