Kontrakdosenbundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require ais/kontrakdosenbundle:dev-master
   

   Ensure your composer.json includes the required dependencies (e.g., fos/rest-bundle, nelmio/api-doc-bundle).

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

   new Ais\KontrakDosenBundle\AisKontrakDosenBundle(),
   new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
   new FOS\RestBundle\FOSRestBundle(),
   new JMS\SerializerBundle\JMSSerializerBundle(),
   

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

   ais_kontrakdosens:
     type: rest
     prefix: /api
     resource: "@AisKontrakDosenBundle/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 to explore endpoints (e.g., GET /api/kontrakdosens).

Implementation Patterns

Workflows

1. CRUD Operations: Leverage FOSRestBundle annotations (e.g., @Route, @Method) for RESTful endpoints. Example:

   use FOS\RestBundle\Controller\Annotations\Route;
   use FOS\RestBundle\Controller\Annotations\Method;
   
   /**
    * @Route("/kontrakdosens", name="get_kontrakdosens")
    * @Method("GET")
    */
   public function getKontrakDosenAction()
   {
       return $this->get('kontrak_dosen.manager')->findAll();
   }
   

2. Serialization: Use JMS Serializer for DTOs. Example:

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

3. API Documentation: NelmioApiDocBundle auto-generates docs. Customize with nelmio_api_doc config:

   nelmio_api_doc:
       areas: [api]  # Your routing prefix
       sandbox: ~
   

4. Dependency Injection: Inject services via constructor or setter. Example:

   public function __construct(KontrakDosenManager $manager)
   {
       $this->manager = $manager;
   }
   

Integration Tips

• Doctrine ORM: Use kontrak_dosen.manager (likely a custom service) for database operations.
• Validation: Extend Symfony\Validator with custom constraints (e.g., @Assert\Valid()).
• Testing: Use LiipFunctionalTestBundle for API tests:

  $client = static::createClient();
  $client->request('GET', '/api/kontrakdosens');
  

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Legacy:

   • Avoid modern Laravel/Lumen patterns (e.g., Eloquent, routes in PHP files). Use Symfony 2.7 conventions.
   • Example: Routes must be YAML/XML in Resources/config/routes.yml.

2. Missing Documentation:

   • The bundle lacks clear entity/manager structure. Inspect AisKontrakDosenBundle/Resources/config/services.yml for services.
   • Example: If kontrak_dosen.manager is undefined, check for typos or missing service definitions.

3. NelmioApiDocBundle Dependency:

   • API docs won’t render without NelmioApiDocBundle registered. Ensure fos/rest-bundle is also installed.

4. Dev-Master Instability:

   • Use with caution; the dev-master branch may break. Fork and pin a version if needed.

Debugging

• Routing Errors: Clear cache after adding routes:

  php app/console cache:clear
  

• Service Not Found: Dump services to verify registration:

  php app/console debug:container | grep kontrak
  

• Serialization Issues: Check jms_serializer configuration for custom handlers.

Extension Points

1. Custom Controllers: Extend existing controllers (e.g., AisKontrakDosenBundle\Controller\KontrakDosenController) by overriding methods.

2. Event Listeners: Add listeners for Doctrine lifecycle events (e.g., prePersist):

   # app/config/services.yml
   services:
       kontrak_dosen.listener:
           class: AppBundle\EventListener\KontrakDosenListener
           tags:
               - { name: doctrine.event_listener, event: prePersist }
   

3. API Extensions: Add new routes in app/config/routing.yml and extend the bundle’s routes.yml.

4. Testing: Mock the kontrak_dosen.manager in PHPUnit tests:

   $manager = $this->createMock(KontrakDosenManager::class);
   $this->get('kontrak_dosen.manager') = $manager;