Demo Bundle Laravel Package

Getting Started

Minimal Steps

1. Installation:

   composer require dataspring/demo-bundle
   

   Ensure your composer.json has "minimum-stability": "dev" if using unreleased versions.

2. Enable the Bundle: Add to config/bundles.php:

   DataSpring\DemoBundle\DataSpringDemoBundle::class => ['all' => true],
   

3. First Use Case:

   • Check if the bundle registers its services by inspecting php bin/console debug:container dataspring in your CLI.
   • Verify the bundle’s Resources/config/services.yml (if it exists) loads expected services.

Implementation Patterns

Core Workflows

1. Service Integration:

   • If the bundle provides services (e.g., demo.service), autowire them in controllers:

     use DataSpring\DemoBundle\Service\DemoService;
     
     class MyController extends AbstractController {
         public function __construct(private DemoService $demoService) {}
     }
     

   • Override services via config/packages/dataspring_demo.yaml:

     dataspring_demo:
         demo_service: '@custom.demo_service'
     

2. Routing:

   • If the bundle includes routes (unlikely given its age), extend them in config/routes.yaml:

     dataspring_demo:
         resource: "@DataSpringDemoBundle/Resources/config/routing.yml"
     

3. Twig Extensions:

   • Use provided Twig functions/filters (if any) in templates:

     {{ demo_filter('input') }}
     

4. Event Listeners:

   • Subscribe to bundle events (if documented) via EventSubscriber:

     class MySubscriber implements EventSubscriberInterface {
         public static function getSubscribedEvents() {
             return [
                 'dataspring.demo.event' => 'onDemoEvent',
             ];
         }
     }
     

Integration Tips

• Dependency Injection: Prefer constructor injection over setters for bundle services.
• Configuration: Use config/packages/dataspring_demo.yaml for runtime overrides.
• Testing: Mock bundle services in PHPUnit tests:

  $this->container->set('dataspring.demo_service', $mockService);
  

Gotchas and Tips

Pitfalls

1. Outdated Symfony Version:

   • The bundle targets Symfony 2.3 (released 2013). Use a compatibility layer (e.g., symfony/polyfill) if integrating with modern Laravel/Lumen (Symfony 5+).
   • Workaround: Fork the bundle and update dependencies manually.

2. No Active Maintenance:

   • Last release: 2016. Assume no bug fixes or feature updates.
   • Tip: Audit the bundle’s composer.json for vulnerable dependencies (e.g., monolog/monolog:1.0).

3. Lack of Documentation:

   • The README is a tutorial for creating bundles, not using this one.
   • Debugging: Inspect src/DataSpring/DemoBundle/ for:
     • Resources/config/services.yml (services)
     • Controller/ (routes)
     • Twig/ (extensions)

4. Namespace Conflicts:

   • The bundle uses DataSpring\DemoBundle. Ensure your project doesn’t shadow this namespace.

Debugging

• Service Not Found: Clear cache after enabling the bundle:

  php artisan cache:clear  # Laravel
  php bin/console cache:clear  # Symfony
  

• Routing Issues: Dump routes to verify registration:

  php bin/console debug:router
  

Extension Points

1. Override Services: Define a custom service in config/services.yaml:

   services:
       dataspring.demo_service:
           class: App\Service\CustomDemoService
           arguments: ['@service_id']
   

2. Extend Controllers: Create a decorator for bundle controllers (if they exist):

   class CustomDemoControllerDecorator implements ControllerDecoratorInterface {
       public function __construct(private DemoController $decorated) {}
       public function indexAction(Request $request) {
           // Pre/post-processing
           return $this->decorated->indexAction($request);
       }
   }
   

3. Add Configuration: Extend config/packages/dataspring_demo.yaml:

   dataspring_demo:
       custom_option: value
   

Pro Tips

• Isolate Dependencies: Use a separate composer.json for the bundle if integrating into Laravel (Symfony’s autoload-dev may conflict).
• Fallback: Treat as a learning resource. For production, consider modern alternatives like:
  • api-platform/core (for APIs)
  • symfony/demo (official Symfony demo).