Course Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer (though note the archived status):

   composer require beloop/course-bundle
   

   Register the bundle in config/bundles.php:

   return [
       // ...
       Beloop\CourseBundle\BeloopCourseBundle::class => ['all' => true],
   ];
   

2. Database Migrations Run migrations to set up core tables (if included):

   php bin/console doctrine:migrations:migrate
   

   Check src/Resources/migrations/ for schema definitions.

3. First Use Case Create a basic course entity via CLI:

   php bin/console make:entity Course --bundle=BeloopCourseBundle
   

   Verify the Course model in src/Entity/Course.php (if auto-generated).

Implementation Patterns

Core Workflows

1. Course Management

   • CRUD via API/Controller:

     use Beloop\CourseBundle\Entity\Course;
     use Beloop\CourseBundle\Repository\CourseRepository;
     
     $course = new Course();
     $course->setTitle('Laravel Fundamentals');
     $course->setDescription('Intro to Laravel');
     $entityManager->persist($course);
     $entityManager->flush();
     

   • Repository Integration:

     $repository = $this->getDoctrine()->getRepository(Course::class);
     $courses = $repository->findBy(['active' => true]);
     

2. Event-Driven Extensions Subscribe to course lifecycle events (if documented):

   // config/services.yaml
   services:
       App\EventListener\CourseListener:
           tags:
               - { name: kernel.event_listener, event: course.pre_publish, method: onPrePublish }
   

3. API Resource Layer Use Symfony Serializer for course DTOs:

   # config/packages/serializer.yaml
   resources:
       - 'config/serializer/Course.yaml'
   

   Example Course.yaml:

   Beloop\CourseBundle\Entity\Course:
       attributes:
           id: ~
           title: ~
           description: ~
   

4. Dependency Injection Inject services like CourseManager (if provided):

   public function __construct(private CourseManager $courseManager) {}
   

Gotchas and Tips

Pitfalls

1. Archived Status

   • No active maintenance; expect no bug fixes or feature updates.
   • Fork the repo if customization is needed (e.g., composer fork beloop/course-bundle).

2. Documentation Gaps

   • Missing: API docs, event system details, or customization guides.
   • Workaround: Inspect src/Entity/ and src/Repository/ for undocumented features.

3. Doctrine Schema Quirks

   • Check for hardcoded table names (e.g., course) in migrations.
   • Override with custom Doctrine configurations if needed:

     # config/packages/doctrine.yaml
     orm:
         entity_managers:
             default:
                 mappings:
                     BeloopCourseBundle: false # Disable if using custom schema
     

4. Event System

   • Events may not be documented. Use reflection to discover them:

     $events = (new \ReflectionClass(Course::class))->getMethod('prePersist')->getDeclaringClass()->getNamespaceName();
     

Debugging Tips

1. Enable SQL Logging

   php bin/console doctrine:query:sql "SELECT * FROM course LIMIT 10"
   

2. Check for Deprecated Methods Use PHPStan or Psalm to flag outdated API usage.

3. Fallback to Core Components If the bundle lacks features, reference the parent beloop/components for alternatives.

Extension Points

1. Custom Fields Extend the Course entity via inheritance:

   namespace App\Entity;
   
   use Beloop\CourseBundle\Entity\Course as BaseCourse;
   
   class Course extends BaseCourse
   {
       #[ORM\Column]
       private ?string $customField = null;
   }
   

2. Override Templates Copy templates/ from the bundle to templates/beloop_course/ in your project.

3. API Versioning Use Symfony’s API Platform for versioned endpoints:

   # config/packages/api_platform.yaml
   resources:
       Beloop\CourseBundle\Entity\Course:
           collectionOperations:
               get:
                   path: /api/v1/courses