Core Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the bundle via Composer:

   composer require akuma/core-bundle
   

   Register the bundle in config/bundles.php (Symfony):

   return [
       // ...
       Akuma\CoreBundle\AkumaCoreBundle::class => ['all' => true],
   ];
   

2. First Use Case The bundle provides a AkumaCoreService for basic operations. Inject it into a controller or service:

   use Akuma\CoreBundle\Service\AkumaCoreService;
   
   class ExampleController extends AbstractController
   {
       public function index(AkumaCoreService $akumaCore)
       {
           $result = $akumaCore->doSomething(); // Hypothetical method
           return new Response($result);
       }
   }
   

3. Where to Look First

   • Service Container: Check src/Akuma/CoreBundle/DependencyInjection/ for configuration.
   • Services: Explore src/Akuma/CoreBundle/Service/ for available utilities.
   • Tests: If available, review tests/ for usage examples.

Implementation Patterns

Common Workflows

1. Service Integration Use the bundle’s services as dependencies in your own services:

   # config/services.yaml
   services:
       App\Service\MyService:
           arguments:
               $akumaCore: '@akuma_core.service'
   

2. Event Listeners/Subscribers If the bundle dispatches events (e.g., AkumaEvent), create a subscriber:

   use Akuma\CoreBundle\Event\AkumaEvent;
   use Symfony\Component\EventDispatcher\EventSubscriberInterface;
   
   class MySubscriber implements EventSubscriberInterface
   {
       public static function getSubscribedEvents()
       {
           return [
               AkumaEvent::NAME => 'onAkumaEvent',
           ];
       }
   
       public function onAkumaEvent(AkumaEvent $event)
       {
           // Handle event logic
       }
   }
   

3. Configuration Overrides Override default bundle settings via config/packages/akuma_core.yaml:

   akuma_core:
       option1: value1
       option2: value2
   

4. Command Integration Extend or use bundle commands (if provided) in app/console:

   php bin/console akuma:command --help
   

Integration Tips

• Laravel-Specific: If using Laravel (not Symfony), alias the bundle’s services in config/app.php:

  'aliases' => [
      'AkumaCore' => Akuma\CoreBundle\Service\AkumaCoreService::class,
  ],
  

• Dependency Injection: Prefer constructor injection for services to ensure immutability.
• Testing: Mock the AkumaCoreService in unit tests:

  $this->mock(AkumaCoreService::class)->shouldReceive('doSomething')->andReturn('test');
  

Gotchas and Tips

Pitfalls

1. Namespace Conflicts The bundle uses Akuma\CoreBundle. Ensure your project doesn’t shadow this namespace. Fix: Use fully qualified namespaces (e.g., \Akuma\CoreBundle\Service\...).

2. Lack of Documentation With no stars/dependents, assume minimal docs. Reverse-engineer usage from:

   • Service method signatures.
   • Example tests (if any).
   • Symfony event names (check EventDispatcher).

3. PHP Version Constraint The composer.json requires PHP ≥5.4, which may conflict with modern Laravel (PHP ≥8.0). Workaround: Fork the package or use a compatibility layer.

4. No Clear Extension Points Without hooks/events documented, extending functionality may require:

   • Overriding services via DI.
   • Monkey-patching (not recommended).

Debugging Tips

• Enable Debug Mode: Symfony’s APP_DEBUG=true reveals bundle errors.
• Log Service Calls: Add debug logs in service methods:

  public function doSomething()
  {
      \Log::debug('AkumaCoreService called', ['bundle' => 'akuma/core-bundle']);
      return 'result';
  }
  

• Check for Deprecated Methods: Use phpstan or psalm to detect unused/undocumented methods.

Extension Points

1. Custom Services Override the default service in config/services.yaml:

   services:
       akuma_core.service:
           class: App\Service\CustomAkumaService
           decorates: 'akuma_core.service'
   

2. Event Dispatching If the bundle lacks events, create your own:

   $dispatcher->dispatch(new AkumaCustomEvent($data));
   

3. Configuration Validation Add validation in config/packages/akuma_core.yaml:

   akuma_core:
       option1: "%env(AKUMA_OPTION1)%"  # Use env vars for safety
   

4. Testing Coverage Write tests for critical paths to ensure bundle stability:

   public function testAkumaService()
   {
       $service = new AkumaCoreService();
       $this->assertEquals('expected', $service->doSomething());
   }