Kontrakmahasiswabundle Laravel Package

Getting Started

Minimal Setup Steps

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

   "ais/kontrakmahasiswabundle": "dev-master"
   

   Run:

   composer update ais/kontrakmahasiswabundle
   

2. Register the Bundle Add to AppKernel.php:

   new Ais\KontrakMahasiswaBundle\AisKontrakMahasiswaBundle(),
   new Nelmio\ApiDocBundle\NelmioApiDocBundle(),
   new FOS\RestBundle\FOSRestBundle(),
   new JMS\SerializerBundle\JMSSerializerBundle(),
   

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

   ais_kontrakmahasiswas:
     type: rest
     prefix: /api
     resource: "@AisKontrakMahasiswaBundle/Resources/config/routes.yml"
   

4. Access API Docs Visit /api/doc to explore endpoints (e.g., http://localhost/web/app_dev.php/api/doc).

First Use Case: Fetching Student Contracts

• Endpoint: GET /api/contracts (or similar, check routes.yml).
• Response: JSON array of student contracts (e.g., { "id": 1, "student_name": "John Doe", "contract_date": "2023-10-01" }).
• Dependencies: Ensure NelmioApiDocBundle is configured for Swagger UI.

Implementation Patterns

Workflows

1. CRUD Operations

   • Use FOSRestBundle’s annotations (e.g., @Route, @Method) for RESTful endpoints.
   • Example controller method:

     use FOS\RestBundle\Controller\Annotations\Route;
     use FOS\RestBundle\Controller\Annotations\Method;
     
     /**
      * @Route("/contracts/{id}", name="get_contract")
      * @Method("GET")
      */
     public function getContractAction($id) { ... }
     

2. Data Serialization

   • Leverage JMSSerializerBundle for converting entities to/from JSON.
   • Example entity annotation:

     use JMS\Serializer\Annotation\Type;
     
     /**
      * @Type("array<string>")
      */
     private $courses;
     

3. API Documentation

   • Automatically generate docs via NelmioApiDocBundle.
   • Customize with nelmio_api.yaml (e.g., title, host).

4. Database Integration

   • Use Doctrine ORM for persistence (e.g., Contract entity with @ORM\Entity).
   • Example migration:

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

Integration Tips

• Symfony 2.7 Compatibility: Ensure your project matches the bundle’s Symfony version (2.7.x).
• Dependency Conflicts: Resolve version clashes (e.g., fos/rest-bundle) via composer.lock.
• Testing: Use phpunit (included in require-dev) for unit/functional tests.
• Frontend Integration: Consume APIs via Axios/Fetch in React/Vue.js:

  axios.get('/api/contracts').then(response => console.log(response.data));
  

Gotchas and Tips

Pitfalls

1. Bundle Maturity

   • Low stars (1) and no dependents suggest untested production use. Validate core features first.
   • Fix: Fork the repo and test thoroughly before adoption.

2. Symfony 2.7 Legacy

   • Outdated Symfony version may lack modern features (e.g., Symfony 5’s HTTP client).
   • Fix: Use Docker to isolate the environment or upgrade Symfony incrementally.

3. Missing Documentation

   • No clear entity structure or API specs in the README.
   • Fix: Inspect src/Ais/KontrakMahasiswaBundle/Resources/config/routing.yml and Entity/ for clues.

4. Hard Dependencies

   • Requires NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle.
   • Fix: Install all dependencies explicitly in composer.json.

Debugging Tips

1. Enable Debug Mode Set APP_DEBUG=true in .env to see detailed errors (e.g., missing routes).

2. Check Doctrine Migrations Run:

   php app/console doctrine:schema:validate
   

   Fix schema errors before testing.

3. API Doc Issues Clear cache if docs don’t load:

   php app/console cache:clear
   

4. Serialization Errors Ensure entities are properly annotated for JMSSerializer:

   use JMS\Serializer\Annotation as Serializer;
   
   /**
    * @Serializer\ExclusionPolicy("all")
    * @Serializer\Expose
    */
   class Contract { ... }
   

Extension Points

1. Custom Entities Extend the Contract entity (e.g., add status field):

   /**
    * @ORM\Column(type="string")
    * @Serializer\Type("string")
    */
   private $status;
   

2. New Endpoints Add routes in routing.yml:

   contract_create:
     path: /api/contracts
     defaults: { _controller: AisKontrakMahasiswaBundle:Contract:new }
   

3. Validation Use Symfony’s Validator component:

   use Symfony\Component\Validator\Constraints as Assert;
   
   /**
    * @Assert\NotBlank()
    */
   private $studentId;
   

4. Event Listeners Hook into Doctrine lifecycle (e.g., log contract creation):

   // src/Ais/KontrakMahasiswaBundle/EventListener/ContractListener.php
   public function postPersist(LifecycleEventArgs $args) {
       $entity = $args->getObject();
       // Log logic here
   }