Jadwalbundle Laravel Package

Getting Started

Minimal Setup

1. Installation:

   composer require ais/jadwalbundle:dev-master
   

   Add to AppKernel.php:

   new Ais\JadwalBundle\AisJadwalBundle(),
   new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
   new FOS\RestBundle\FOSRestBundle(),
   new JMS\SerializerBundle\JMSSerializerBundle(),
   

2. Routing: Update app/config/routing.yml:

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

3. First Use Case: Access the API documentation at:

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

   Explore endpoints under /api/jadwal.

Implementation Patterns

Core Workflows

1. RESTful API Integration:

   • Leverage FOSRestBundle for standardized API responses (e.g., GET /api/jadwal returns JSON).
   • Use JMS Serializer for custom entity serialization (e.g., @Serializer\Annotation\Groups for partial responses).

2. Entity Management:

   • Extend Ais\JadwalBundle\Entity\Jadwal for custom fields (e.g., class CustomJadwal extends Jadwal).
   • Override repository methods (e.g., findByDateRange) in Ais\JadwalBundle\Repository\JadwalRepository.

3. Validation:

   • Add constraints to entities (e.g., @Assert\NotBlank on date field).
   • Use Symfony’s validator component for form/API request validation.

4. Testing:

   • Functional tests via LiipFunctionalTestBundle (dev dependency).
   • Mock API responses with Guzzle plugins (e.g., Guzzle\Plugin\Mock).

Integration Tips

• Doctrine ORM: Sync database schema with:

  php app/console doctrine:schema:update --force
  

• Event Listeners: Subscribe to JadwalEvents (if available) for pre/post-actions (e.g., logging, notifications).
• Custom Controllers: Extend Ais\JadwalBundle\Controller\JadwalController for business logic (e.g., @Route("/api/jadwal/export")).

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Dependency:

   • Avoid using newer Symfony features (e.g., Symfony 3+ components) without backward-compatible wrappers.
   • Fix: Use symfony/polyfill-* packages if needed.

2. Missing Documentation:

   • Bundle lacks detailed API specs or entity structure.
   • Workaround: Inspect src/Ais/JadwalBundle/Resources/config/doctrine/ for entity mappings.

3. NelmioApiDocBundle Dependency:

   • API docs require this bundle; omit if not needed (but may break routes).
   • Tip: Disable with nelmio_api_doc: false in config.

4. Dev Dependencies:

   • doctrine-fixtures-bundle and liip/functional-test-bundle are dev-only; remove from composer.json for production.

Debugging

• Entity Not Found: Clear cache after schema updates:

  php app/console cache:clear
  

• Serialization Errors: Ensure entities use JMS\Serializer\Annotation (e.g., @Serializer\ExclusionPolicy).

Extension Points

1. Custom Routes: Override routes.yml in your bundle’s Resources/config/ to add endpoints.
2. Event Dispatching: Listen for jadwal.pre_save/jadwal.post_load events (if bundle supports them).
3. Twig Integration: Extend Ais\JadwalBundle\Twig\JadwalExtension for template helpers.

Configuration Quirks

• Parameter Handling: Use incenteev/composer-parameter-handler for environment-specific configs (e.g., parameters.yml).
• SCSS Preprocessing: leafo/scssphp is included for asset compilation; configure in config.yml:

  assetic:
      filters:
          scssphp: ~