Demo Bundle Laravel Package

Getting Started

Minimal Setup

1. Installation Add the package via Composer:

   composer require bene/demo-bundle
   

   Publish the bundle’s configuration (if applicable):

   php artisan vendor:publish --provider="Bene\DemoBundle\DemoBundleServiceProvider"
   

2. First Use Case The bundle appears to be a demo/boilerplate for Beneficium (a German open-source eGovernment framework). Start by checking:

   • Routes: Inspect routes/demo.php (if auto-loaded) or the DemoBundle's routes/ directory.
   • Controllers: Look for DemoController or similar in src/Controller/ or app/Http/Controllers/Demo/.
   • Views: Check resources/views/demo/ for templates (if using Blade).
   • Configuration: Review config/demo.php for default settings (e.g., demo mode, API endpoints).

3. Quick Test Run the demo endpoint (if available):

   php artisan serve
   

   Visit http://localhost:8000/demo (or the defined route).

Implementation Patterns

Core Workflows

1. Demo Mode Integration

   • Use the bundle’s DemoService to toggle demo mode (e.g., mocking data for testing):

     use Bene\DemoBundle\Services\DemoService;
     
     $demoService = app(DemoService::class);
     if ($demoService->isEnabled()) {
         return $demoService->getMockData();
     }
     

   • Tip: Extend DemoService to add custom mock logic.

2. Route Prefixing The bundle likely uses route namespacing (e.g., demo.*). Override or extend routes in routes/web.php:

   Route::prefix('admin')->group(function () {
       Route::namespace('Demo')->group(base_path('vendor/bene/demo-bundle/routes.php'));
   });
   

3. View Composition

   • Extend demo views by creating a resources/views/demo/partials/ directory and overriding bundle templates.
   • Use @include('demo::partials.header') to embed bundle views.

4. API Mocking If the bundle includes API demo endpoints (e.g., for Beneficium’s eGovernment APIs), use it to stub responses:

   Route::get('/api/demo/users', [DemoController::class, 'mockUsers']);
   

Integration Tips

• Laravel Mix/Webpack: If the bundle includes assets (JS/CSS), configure Mix to ignore or compile them:

  // webpack.mix.js
  mix.ignore('vendor/bene/demo-bundle/public/');
  

• Service Providers: Bind custom demo services by extending the bundle’s provider:

  public function register()
  {
      $this->app->singleton(DemoService::class, function ($app) {
          return new CustomDemoService($app['config']['demo']);
      });
  }
  

• Testing: Use the demo bundle to seed test databases or mock external services in phpunit.xml:

  <env name="DEMO_MODE" value="true"/>
  

Gotchas and Tips

Pitfalls

1. Namespace Collisions

   • The bundle may use Demo namespace. Avoid naming conflicts by:
     • Prefixing custom classes (e.g., App\Services\CustomDemoService).
     • Using fully qualified paths in config files.

2. Missing Documentation

   • With 0 stars/dependents, assume minimal docs. Inspect:
     • src/ for class methods.
     • tests/ for usage examples.
     • composer.json for dependencies (e.g., beneficium/core).

3. Configuration Overrides

   • Published config (config/demo.php) may not exist. Check if the bundle uses environment variables (e.g., .env):

     DEMO_ENABLED=true
     

4. Asset Paths

   • Hardcoded asset paths (e.g., /vendor/bene/demo-bundle/public/) may break in production. Override via:

     config(['demo.assets_path' => public_path('custom-demo-assets')]);
     

Debugging

• Enable Debug Mode:

  if (config('app.debug')) {
      \Bene\DemoBundle\Debug::enable();
  }
  

• Log Demo Events:

  \Bene\DemoBundle\Events\DemoEvent::dispatch('test_event');
  

  Listen in EventServiceProvider:

  protected $listen = [
      \Bene\DemoBundle\Events\DemoEvent::class => [
          \App\Listeners\LogDemoEvent::class,
      ],
  ];
  

Extension Points

1. Custom Demo Data Extend the DemoData class to add domain-specific mocks:

   namespace App\Services;
   
   use Bene\DemoBundle\Services\DemoData;
   
   class CustomDemoData extends DemoData
   {
       public function getUsers()
       {
           return array_merge(parent::getUsers(), [
               ['id' => 999, 'name' => 'Custom User']
           ]);
       }
   }
   

   Bind it in a service provider:

   $this->app->bind(DemoData::class, CustomDemoData::class);
   

2. Hooks for Demo Mode Use events or middleware to trigger logic when demo mode is active:

   // app/Http/Kernel.php
   protected $middlewareGroups = [
       'web' => [
           // ...
           \Bene\DemoBundle\Http\Middleware\CheckDemoMode::class,
       ],
   ];
   

3. API Response Wrapping If the bundle provides API mocks, wrap responses to add headers/metadata:

   use Bene\DemoBundle\Http\Resources\DemoResource;
   
   return new DemoResource($data)
       ->response()
       ->header('X-Demo', 'true');