Barcode Bundle Laravel Package

Getting Started

1. Prerequisites Check: Ensure your project meets the updated requirements:

   • PHP ≥ 7.1 (drop-in replacement for older versions is not supported).
   • Symfony ≥ 3.0 (if using Symfony components; Laravel core remains unaffected).
   • Verify compatibility with your Laravel version (tested on LTS releases: 7.x, 8.x, 9.x).

2. Installation:

   composer require vendor/package-name
   

   For Symfony users, install via:

   composer require vendor/package-name --with-all-dependencies
   

3. First Use Case:

   • Laravel: Publish the config (if applicable) and bind the package’s service provider in config/app.php under providers.
   • Symfony: Register the bundle in config/bundles.php (if applicable).
   • Test a basic feature (e.g., Package::performAction()) in routes/web.php or a controller.

   use Vendor\Package\Facades\Package;
   
   Route::get('/test', function () {
       return Package::performAction(); // Replace with actual method
   });
   

Implementation Patterns

Laravel-Specific Workflows

1. Service Providers:

   • Extend the package’s provider by binding additional interfaces or extending its boot logic in AppServiceProvider:

     public function boot()
     {
         $this->app->extend('package', function ($instance) {
             $instance->setCustomConfig(config('app.custom_key'));
             return $instance;
         });
     }
     

2. Configuration:

   • Publish and customize the config:

     php artisan vendor:publish --provider="Vendor\Package\PackageServiceProvider" --tag="config"
     

   • Override defaults in config/package.php.

3. Event Listeners:

   • Listen to package events (if supported) in EventServiceProvider:

     protected $listen = [
         'Vendor\Package\Events\ActionPerformed' => [
             'App\Listeners\LogAction',
         ],
     ];
     

Symfony Integration

1. Bundle Configuration:

   • Override bundle parameters in config/packages/package.yaml:

     parameters:
         package.custom_setting: true
     

2. Dependency Injection:

   • Extend services via compiler passes or decorators in a custom bundle.

Cross-Framework Patterns

• Middleware: Use the package’s middleware in Laravel’s app/Http/Kernel.php or Symfony’s kernel.php.
• Commands: Register custom artisan commands (Laravel) or Symfony console commands by extending the package’s base command class.
• Testing: Mock the package’s facade or service container bindings in PHPUnit:

  $this->app->instance('package', $mock);
  

Gotchas and Tips

Breaking Changes (v2.0.0)

1. PHP/Symfony Drop Support:

   • Migration Path: Upgrade PHP to 7.1+ and Symfony to 3.0+ before updating.
   • Symfony 2.x Users: Rewrite integration logic to use Symfony 3/4’s DI container or abstract the package behind a wrapper.

2. Deprecated Features:

   • Remove any code relying on pre-7.1 PHP features (e.g., create_function, call_user_func_array with variadic arguments).
   • Update Symfony-specific code to use ContainerInterface (PSR-11) instead of legacy container methods.

Debugging

1. Configuration Conflicts:

   • Clear cached config after publishing:

     php artisan config:clear
     

   • For Symfony, dump container parameters:

     php bin/console debug:container --parameters
     

2. Facade vs. Container:

   • Prefer dependency injection over facades for testability:

     // Bad (facade)
     $result = Package::performAction();
     
     // Good (injected)
     public function __construct(private Package $package) {}
     $result = $this->package->performAction();
     

3. Symfony-Laravel Hybrid Issues:

   • If using Symfony components in Laravel, ensure symfony/console and symfony/dependency-injection are pinned to compatible versions in composer.json.

Extension Points

1. Customizing Core Logic:

   • Override package classes by binding them in the service container:

     $this->app->bind('Vendor\Package\Contracts\ActionInterface', function () {
         return new App\CustomAction();
     });
     

2. Adding New Features:

   • Extend the package’s base classes (e.g., BaseAction, BaseService) in your app namespace.
   • Example:

     namespace App\Extensions;
     
     use Vendor\Package\BaseAction;
     
     class CustomAction extends BaseAction {
         public function extraMethod() { ... }
     }
     

3. Event-Driven Extensions:

   • Dispatch custom events after package actions:

     event(new \App\Events\ActionLogged($data));
     

Performance

• Lazy Loading: Defer heavy package initialization until first use by leveraging Laravel’s boot() or Symfony’s onKernelRequest event.
• Caching: Cache package responses if applicable (e.g., Cache::remember() in Laravel or Symfony’s CacheInterface).

Community Resources

• Check the package’s UPGRADING.md for version-specific notes.
• Search GitHub issues for Symfony/Laravel-specific workarounds (e.g., "symfony 3.4 laravel 8").