Core Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer (though note the read-only status):

   composer require beloop/core-bundle
   

   Enable the bundle in config/bundles.php:

   Beloop\CoreBundle\BeloopCoreBundle::class => ['all' => true],
   

2. First Use Case: Dependency Injection The bundle likely provides base services for LMS workflows (e.g., user roles, course structures). Check src/DependencyInjection/ for available services. Example:

   # config/packages/beloop_core.yaml
   beloop_core:
       default_role: 'student'  # Hypothetical config key
   

3. Key Classes Scan src/ for core abstractions (e.g., UserProvider, CourseManager). Verify with:

   php bin/console debug:container beloop
   

Implementation Patterns

Workflow: Extending Core Entities

1. User Roles If the bundle defines role hierarchies, extend via:

   // src/Entity/User.php
   use Beloop\CoreBundle\Model\UserInterface;
   
   class AppUser implements UserInterface {
       public function getRoles(): array {
           return ['ROLE_APP_STUDENT', ...parent::getRoles()];
       }
   }
   

2. Event Listeners Hook into LMS events (e.g., user.registered). Example:

   // src/EventListener/CourseListener.php
   use Beloop\CoreBundle\Event\CourseEvent;
   
   class CourseListener {
       public function onCourseCreated(CourseEvent $event) {
           // Custom logic
       }
   }
   

   Register in services.yaml:

   services:
       App\EventListener\CourseListener:
           tags:
               - { name: 'kernel.event_listener', event: 'beloop.course.created' }
   

3. Twig Integration Use provided Twig extensions (if any) for LMS-specific templates:

   {{ beloop_course_path(course) }}  {# Hypothetical helper #}
   

Integration Tips

• Symfony Flex: If the bundle used Flex (unlikely given its age), check config/bundles.php for auto-configuration.
• Database Migrations: Review src/Resources/migrations/ for schema changes (if included).
• Testing: Mock core services in tests:

  $this->container->set('beloop.user_provider', $mockProvider);
  

Gotchas and Tips

Pitfalls

1. Archived Status

   • No active maintenance; expect breaking changes if Symfony 5+ is used.
   • Fork the repo if critical fixes are needed.

2. Outdated Symfony

   • Likely built for Symfony 3/4. Test thoroughly with newer versions.

3. Undocumented Features

   • The bundle may lack clear docs. Use php bin/console debug:container to explore services.

Debugging

• Service Not Found? Verify the bundle is enabled and dependencies are installed:

  composer show beloop/core-bundle
  

• Event Not Triggered? Check event names in src/Event/ and ensure listeners are tagged correctly.

Extension Points

1. Custom Providers Override default providers (e.g., user_provider) by defining your own service with higher priority:

   services:
       app.user_provider:
           class: App\Service\CustomUserProvider
           decorates: 'beloop.user_provider'
           arguments: ['@app.user_provider.inner']
   

2. Configuration Overrides Extend config/packages/beloop_core.yaml to modify bundle behavior:

   beloop_core:
       max_courses_per_user: 10
   

3. Twig Extensions If the bundle provides Twig functions, override them in your app:

   {% extends 'beloop_base.html.twig' %}
   {% block beloop_course_path %}{{ custom_path(course) }}{% endblock %}