Pertemuandosenbundle Laravel Package

Getting Started

Minimal Setup Steps

1. Install via Composer Add to your composer.json:

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

   Run:

   composer update
   

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

   new Ais\PertemuanDosenBundle\AisPertemuanDosenBundle(),
   

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

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

   ais_pertemuandosens:
       type: rest
       prefix: /api
       resource: "@AisPertemuanDosenBundle/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: Fetching Meetings

Use the API to retrieve faculty meetings (PertemuanDosen) via:

• GET /api/pertemuandosens – List all meetings.
• GET /api/pertemuandosens/{id} – Fetch a single meeting by ID.

Example (cURL):

curl -X GET http://localhost/api/pertemuandosens

Implementation Patterns

Core Workflows

1. CRUD Operations Leverage FOSRestBundle for standardized RESTful endpoints:

   • Create: POST /api/pertemuandosens (with JSON payload).
   • Update: PUT /api/pertemuandosens/{id}.
   • Delete: DELETE /api/pertemuandosens/{id}.

   Example payload:

   {
       "title": "Faculty Meeting",
       "date": "2023-12-01",
       "faculty": "Computer Science"
   }
   

2. Serialization Use JMS Serializer for custom data formatting. Override serialization groups in entities (e.g., @Serializer\ExclusionPolicy("ALL") for sensitive fields).

3. Validation Integrate Symfony’s Validator component with entities (e.g., @Assert\NotBlank on required fields).

4. Event Listeners Extend core logic via Doctrine lifecycle events (e.g., @PrePersist to auto-set timestamps).

Integration Tips

• Doctrine ORM: The bundle assumes Doctrine ORM for database interactions. Customize AisPertemuanDosenBundle/Resources/config/doctrine/ for your schema.
• API Documentation: Use NelmioApiDocBundle to auto-generate Swagger/OpenAPI docs. Extend with custom annotations:

  /**
   * @ApiDoc(
   *   resource=true,
   *   description="List all faculty meetings"
   * )
   */
  

• Testing: Use PHPUnit with liip/functional-test-bundle for API endpoint tests. Example:

  $client->request('GET', '/api/pertemuandosens');
  $this->assertEquals(200, $client->getResponse()->getStatusCode());
  

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Legacy

   • The bundle targets Symfony 2.7, which may lack modern features (e.g., Symfony 4+ components). Test thoroughly for compatibility.
   • Fix: Use symfony/symfony:2.7.* in composer.json to avoid version conflicts.

2. Missing Dependencies

   • NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle are required but not auto-installed. Forgetting to register them causes 404 errors.
   • Fix: Verify AppKernel.php and run composer require for missing bundles.

3. Route Overrides The bundle’s routes.yml may conflict with existing routes. Prefix routes explicitly:

   ais_pertemuandosens:
       prefix: /api/v1
   

4. Serialization Issues Custom entities may fail serialization if not properly annotated. Example:

   use JMS\Serializer\Annotation as Serializer;
   class PertemuanDosen {
       /**
        * @Serializer\Type("string")
        */
       private $date;
   }
   

Debugging Tips

1. Enable Debug Mode Set APP_DEBUG=true in .env to view detailed error logs (Symfony 2.7 uses app/config/parameters.yml).

2. Check Doctrine Events Use doctrine:events:list to debug lifecycle callbacks:

   php app/console doctrine:events:list
   

3. API Doc Errors Clear cache after adding new annotations:

   php app/console cache:clear
   

Extension Points

1. Custom Entities Extend the base PertemuanDosen entity by overriding the bundle’s Entity/PertemuanDosen.php in your project.

2. Additional Fields Add fields to the entity and update the corresponding form/type classes (e.g., PertemuanDosenType.php).

3. Custom Controllers Override bundle controllers by creating a Controller/ directory in your project and extending the bundle’s logic:

   namespace AppBundle\Controller;
   use Ais\PertemuanDosenBundle\Controller\PertemuanDosenController as BaseController;
   
   class PertemuanDosenController extends BaseController {
       public function customAction() { ... }
   }
   

4. Event Subscribers Listen to bundle events (e.g., pertemuan_dosen.pre_save) via Symfony’s event dispatcher:

   $dispatcher->addListener('pertemuan_dosen.pre_save', function ($event) {
       $event->getEntity()->setLastUpdated(new \DateTime());
   });