Symfony Yii2 Bridge Laravel Package

Getting Started

Install the package via Composer:

composer require vendor/package-name

Register the service provider in config/app.php under the providers array:

Vendor\PackageName\PackageServiceProvider::class,

Publish the config file (if applicable) with:

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

First use case: Use the package’s facade or helper methods directly in your controllers or services. For example:

use Vendor\PackageName\Facades\PackageFacade;

$response = PackageFacade::doSomething();

Implementation Patterns

Core Workflows

1. Dependency Injection: Prefer constructor injection over facades for better testability:

   public function __construct(Vendor\PackageName\Contracts\PackageContract $package) {}
   

2. Configuration: Override defaults in config/package-name.php (published via vendor:publish).
3. Service Binding: Extend functionality by binding custom implementations:

   $this->app->bind(
       Vendor\PackageName\Contracts\PackageContract::class,
       CustomPackageService::class
   );
   

Integration Tips

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

  protected $listen = [
      'Vendor\PackageName\Events\PackageEvent' => [
          'App\Listeners\HandlePackageEvent',
      ],
  ];
  

• Middleware: Use the package’s middleware (if provided) in app/Http/Kernel.php:

  protected $middleware = [
      // ...
      \Vendor\PackageName\Http\Middleware\PackageMiddleware::class,
  ];
  

Gotchas and Tips

Breaking Changes (v0.2.0)

• Removed symfony/framework-bundle Dependency: If your project relied on Symfony components indirectly, ensure no compatibility issues arise. Test thoroughly, especially if using:
  • Symfony’s HttpFoundation, Console, or DependencyInjection.
  • Custom integrations with Symfony’s event system or bundles.

Debugging

• Config Overrides: Always check config/package-name.php for overrides. Use php artisan config:clear if changes aren’t reflected.
• Logging: Enable debug mode (config('app.debug' = true)) to surface hidden errors or warnings.

Extension Points

• Custom Contracts: Implement Vendor\PackageName\Contracts\PackageContract to replace core functionality.
• Views/Blade: If the package includes views, extend them via resources/views/vendor/package-name/ overrides.
• Artisan Commands: Extend or replace commands by binding new implementations:

  $this->app->singleton(
      \Vendor\PackageName\Console\PackageCommand::class,
      CustomPackageCommand::class
  );
  

Performance

• Lazy Loading: Avoid eager-loading package services unless necessary (e.g., in service providers).
• Caching: If the package supports caching (e.g., config, API responses), leverage Laravel’s cache drivers:

  Cache::remember('package_key', now()->addHours(1), function () {
      return PackageFacade::expensiveOperation();
  });