Haribundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package to your composer.json under require:

   "ais/haribundle": "dev-master"
   

   Run composer update.

2. Register the Bundle Add Ais\HariBundle\AisHariBundle() to your AppKernel.php under registerBundles(). Ensure NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle are also registered.

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

   ais_haris:
     type: rest
     prefix: /api
     resource: "@AisHariBundle/Resources/config/routes.yml"
   

4. Access API Docs Navigate to /api/doc in your dev environment (e.g., http://localhost/web/app_dev.php/api/doc).

First Use Case

• Explore Hari-Related Endpoints: Use the API docs to discover available Hari-related routes (e.g., CRUD operations for Hari entities).
• Test a Hari Endpoint: Example: Send a GET request to /api/haris to fetch a list of Hari resources.

Implementation Patterns

Common Workflows

1. Hari Entity Management

   • Use FOSRestBundle’s annotations (@Route, @QueryParam, @View) to define Hari-related API endpoints.
   • Example:

     use FOS\RestBundle\Controller\Annotations as Rest;
     use Ais\HariBundle\Entity\Hari;
     
     class HariController extends Controller
     {
         /**
          * @Rest\Get("/haris")
          * @Rest\View()
          */
         public function getHarisAction()
         {
             $haris = $this->getDoctrine()->getRepository(Hari::class)->findAll();
             return $haris;
         }
     }
     

2. Serialization with JMS

   • Annotate Hari entities for serialization:

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

3. API Documentation

   • Leverage NelmioApiDocBundle to auto-generate docs for Hari endpoints.
   • Customize docs via config.yml:

     nelmio_api_doc:
         documentation:
             info:
                 title: Hari API
                 description: API for Hari resources
     

4. Integration with Doctrine

   • Extend Hari entities with Doctrine behaviors (e.g., timestamps, soft deletes):

     use Gedmo\Mapping\Annotation as Gedmo;
     
     class Hari
     {
         /**
          * @Gedmo\Timestampable(on="create")
          */
         private $createdAt;
     }
     

Integration Tips

• Dependency Injection: Inject HariManager (if provided) into services for Hari-specific logic.
• Event Listeners: Attach listeners to Hari lifecycle events (e.g., prePersist, postRemove).
• Validation: Use Symfony’s validators for Hari entities:

  use Symfony\Component\Validator\Constraints as Assert;
  
  class Hari
  {
      /**
       * @Assert\NotBlank
       */
      private $name;
  }
  

Gotchas and Tips

Pitfalls

1. Symfony 2.7 Legacy

   • The bundle targets Symfony 2.7, which may lack modern features (e.g., Symfony Flex, PHP 8+ support).
   • Workaround: Use compatibility layers or fork the bundle for updates.

2. Missing Documentation

   • The bundle lacks detailed docs. Reverse-engineer routes/entities from routes.yml and Entity/ directory.

3. Dependency Conflicts

   • FOSRestBundle@dev, NelmioApiDocBundle@dev, and JMSSerializerBundle@dev may conflict with newer versions.
   • Fix: Pin versions in composer.json or use replace:

     "replace": {
         "friendsofsymfony/rest-bundle": "2.8.0",
         "nelmio/api-doc-bundle": "2.18.0"
     }
     

4. No Hari Entity Defined

   • The bundle assumes a Hari entity exists but doesn’t provide one. Create it manually:

     php app/console generate:doctrine:entity --entity="Hari"
     

Debugging Tips

1. Enable Profiler

   • Use Symfony’s profiler (/profiler) to inspect Hari-related requests/responses.

2. Check Routes

   • Dump routes to verify Hari endpoints are registered:

     php app/console debug:router | grep hari
     

3. Log Hari Actions

   • Add Monolog handlers for Hari events:

     monolog:
         handlers:
             hari_handler:
                 type: stream
                 path: "%kernel.logs_dir%/hari.log"
                 level: debug
                 channels: [hari]
     

Extension Points

1. Custom Hari Services

   • Create a service to extend Hari functionality:

     services:
         ais.hari.custom_service:
             class: AppBundle\Service\CustomHariService
             arguments: ["@ais.hari.manager"]
     

2. Override Templates

   • Extend Hari templates (if any) by copying from AisHariBundle/Resources/views/ to AppBundle/Resources/AisHariBundle/views/.

3. Add Hari Commands

   • Create console commands for Hari management:

     php app/console generate:bundle --namespace="AppBundle/Command" --format=yml --dir="src/AppBundle/Command"
     

Pro Tips

• Use Hari in Forms: Integrate Hari entities with Symfony Forms:

  $form = $this->createFormBuilder($hari)
      ->add('name', TextType::class)
      ->getForm();
  

• API Rate Limiting: Combine with HWIOAuthBundle or LexikJWTAuthenticationBundle for secure Hari APIs.
• Testing: Write functional tests for Hari endpoints using LiipFunctionalTestBundle.