Mahasiswabundle Laravel Package

Getting Started

Minimal Steps

1. Installation:

   • Add the package to composer.json under require:

     "ais/mahasiswabundle": "dev-master"
     

   • Run composer update in your project root.

2. Register the Bundle:

   • Add Ais\MahasiswaBundle\AisMahasiswaBundle() to AppKernel.php under registerBundles().
   • Ensure NelmioApiDocBundle, FOSRestBundle, and JMSSerializerBundle are also registered.

3. Configure Routing:

   • Import routes in app/config/routing.yml:

     ais_mahasiswas:
       type: rest
       prefix: /api
       resource: "@AisMahasiswaBundle/Resources/config/routes.yml"
     

4. Access API Docs:

   • Navigate to /api/doc (e.g., http://localhost/web/app_dev.php/api/doc) to explore endpoints.

First Use Case

Fetching Student Data:

• The bundle appears to manage "Dosen" (Lecturers) data, despite the name MahasiswaBundle (likely a typo).
• Use GET /api/dosen (or similar) to retrieve a list of lecturers via the API.
• Verify the response structure using NelmioApiDoc.

Implementation Patterns

Core Workflows

1. RESTful API Integration:

   • Leverage FOSRestBundle for standardized API responses (e.g., JSON).
   • Use NelmioApiDocBundle to auto-generate Swagger/OpenAPI documentation for client-side tooling.

2. Entity Management:

   • The bundle likely includes a Dosen entity (class) with CRUD operations.
   • Example workflow:

     // Create a lecturer
     $dosen = new \Ais\MahasiswaBundle\Entity\Dosen();
     $dosen->setName('Dr. Smith');
     $em->persist($dosen);
     $em->flush();
     

   • Inject the DosenRepository (if available) for queries:

     $repository = $this->get('ais_mahasiswa.dosen.repository');
     $lecturers = $repository->findAll();
     

3. Serialization:

   • JMSSerializerBundle handles data transformation (e.g., converting entities to JSON).
   • Customize serialization via annotations (e.g., @Serializer\ExclusionPolicy).

4. Testing:

   • Use LiipFunctionalTestBundle for API endpoint testing:

     $client = static::createClient();
     $client->request('GET', '/api/dosen');
     $this->assertEquals(200, $client->getResponse()->getStatusCode());
     

Integration Tips

1. Database Schema:

   • Check AisMahasiswaBundle/Resources/config/doctrine/Dosen.orm.yml for entity mappings.
   • Extend the Dosen entity if additional fields are needed:

     namespace Ais\MahasiswaBundle\Entity;
     
     use Doctrine\ORM\Mapping as ORM;
     
     /** @ORM\Entity */
     class Dosen {
         // ...
     }
     

2. Custom Controllers:

   • Override default routes by creating a controller in your app:

     namespace AppBundle\Controller;
     
     use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
     use Symfony\Component\HttpFoundation\Response;
     
     class CustomDosenController extends \Ais\MahasiswaBundle\Controller\DosenController {
         /**
          * @Route("/api/dosen/custom", name="custom_dosen")
          */
         public function customAction() {
             return new Response('Custom logic here');
         }
     }
     

3. Validation:

   • Use Symfony’s validator with constraints (e.g., @Assert\NotBlank) on the Dosen entity.

4. Event Listeners:

   • Subscribe to Doctrine lifecycle events (e.g., prePersist) for side effects:

     namespace AppBundle\EventListener;
     
     use Doctrine\ORM\Event\LifecycleEventArgs;
     
     class DosenListener {
         public function prePersist(LifecycleEventArgs $args) {
             $dosen = $args->getEntity();
             if ($dosen instanceof \Ais\MahasiswaBundle\Entity\Dosen) {
                 $dosen->setCreatedAt(new \DateTime());
             }
         }
     }
     

   • Register in services.yml:

     services:
         app.dosen_listener:
             class: AppBundle\EventListener\DosenListener
             tags:
                 - { name: doctrine.event_listener, event: prePersist }
     

Gotchas and Tips

Pitfalls

1. Bundle Naming Inconsistency:

   • The bundle is named MahasiswaBundle (Students) but manages Dosen (Lecturers). Clarify requirements with stakeholders to avoid confusion.

2. Symfony Version Lock:

   • The bundle is tied to Symfony 2.7.4. Upgrading may break compatibility. Use a wrapper or fork if migrating to Symfony 3+/4/5.

3. Missing Documentation:

   • No clear docs on entity structure, routes, or customization points. Inspect:
     • AisMahasiswaBundle/Resources/config/routing.yml for available routes.
     • AisMahasiswaBundle/Controller/ for controller logic.
     • AisMahasiswaBundle/Entity/ for data models.

4. Dependency Conflicts:

   • FOSRestBundle, NelmioApiDocBundle, and JMSSerializerBundle are required but may conflict with newer versions. Pin versions in composer.json:

     "fos/rest-bundle": "1.11.*",
     "nelmio/api-doc-bundle": "2.14.*",
     "jms/serializer-bundle": "0.15.*"
     

5. API Doc Access:

   • NelmioApiDoc may not work if app_dev.php is not used in production. Configure nelmio_api_doc in config.yml:

     nelmio_api_doc:
         areas: [api] # Ensure this matches your route prefix
     

Debugging Tips

1. Route Debugging:

   • Dump all registered routes to verify ais_mahasiswas is loaded:

     php app/console debug:router
     

   • Look for ais_mahasiswas_* routes.

2. Entity Debugging:

   • Check if the Dosen entity is mapped:

     php app/console doctrine:schema:validate
     

   • If errors occur, ensure AisMahasiswaBundle is enabled in AppKernel.

3. API Response Issues:

   • Validate JSON responses with tools like JSONLint.
   • Check JMSSerializerBundle configuration in config.yml:

     jms_serializer:
         metadata:
             directories:
                 AisMahasiswaBundle: ~
     

4. Event Listener Debugging:

   • Enable Doctrine debug mode in config.yml:

     doctrine:
         dbal:
             logging: true
     

   • Check logs (app/log/dev.log) for lifecycle event triggers.

Extension Points

1. Custom Fields:

   • Extend the Dosen entity by creating a child class:

     namespace AppBundle\Entity;
     
     use Ais\MahasiswaBundle\Entity\Dosen as BaseDosen;
     use Doctrine\ORM\Mapping as ORM;
     
     /** @ORM\Entity */
     class Dosen extends BaseDosen {
         /** @ORM\Column(type="string") */
         private $customField;
     }
     

   • Override the repository if custom queries are needed.

2. New Routes:

   • Add routes in app/config/routing.yml:

     app_custom_dosen:
         type: rest
         resource: "@AppBundle/Resources/config/routing/dosen.yml"
     

   • Define the route file (dosen.yml):

     custom_route:
         path: /api/dosen/custom
         defaults: { _controller: AppBundle:Dosen:custom }
     

3. Custom Serialization:

   • Create a custom handler for the Dosen entity:

     namespace AppBundle\Serializer;
     
     use JMS\Serializer\Context;
     use JMS\Serializer\GraphNavigator;
     use JMS\Serializer\Metadata\ClassMetadata;
     use JMS\Serializer\VisitorInterface;
     
     class DosenHandler {
         public static function getClassMetadata(ClassMetadata $metadata) {
             $metadata->xmlRootName = 'lecturer';
             $metadata->xmlNamespace = 'http://example.com';
         }
     }
     

   • Register the handler in services.yml:

     services:
         app.serializer.dosen_handler:
             class: AppBundle\Serializer\DosenHandler
             tags:
                 - { name: jms_serializer.subscribing_handler }
     

4. Fixtures:

   • Use doctrine-fixtures-bundle to seed test