Redis Bundle Laravel Package

Getting Started

Install the package via Composer:

composer require vendor/package-name

Ensure your project meets the updated PHP 8.0 requirement (check via php -v). Register the package service provider in config/app.php under providers:

Vendor\PackageName\PackageServiceProvider::class,

Publish the config file (if available) with:

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

Test basic functionality by invoking the package’s core feature (e.g., Artisan command, facade, or helper) in a tinker session or route:

use Vendor\PackageName\Facades\PackageFacade;
PackageFacade::exampleMethod();

Implementation Patterns

Core Workflows

1. Service Integration: Bind the package’s core services in AppServiceProvider’s register() method:

   $this->app->bind(
       Vendor\PackageName\Contracts\ServiceInterface::class,
       Vendor\PackageName\Services\Service::class
   );
   

   Use dependency injection in controllers or commands:

   public function __construct(private ServiceInterface $service) {}
   

2. Artisan Commands: Extend Vendor\PackageName\Console\Command for custom logic:

   namespace App\Console\Commands;
   use Vendor\PackageName\Console\Command;
   class CustomCommand extends Command {
       protected $signature = 'custom:task';
       public function handle() { ... }
   }
   

3. Event Listeners: Listen to package events in EventServiceProvider:

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

4. Middleware: Apply package-specific middleware to routes or groups:

   Route::middleware([\Vendor\PackageName\Http\Middleware\Authenticate::class])->group(...);
   

Configuration

Override default settings in config/package-name.php:

'option' => env('PACKAGE_OPTION', 'default_value'),

Gotchas and Tips

Breaking Changes (PHP 8.0 Migration)

• Named Arguments: The package may now rely on PHP 8.0’s named arguments in constructors/methods. Update calls to:

  // Old (PHP 7.4)
  new Class($arg1, $arg2);
  
  // New (PHP 8.0)
  new Class(arg1: $arg1, arg2: $arg2);
  

• Union Types: Check for new union types (e.g., array|string) in method signatures. Adjust type hints if extending the package.
• Attributes: If the package uses PHP 8.0 attributes (e.g., #[\Override]), ensure your IDE supports them.

Debugging

• Strict Typing: Enable strict_types=1 in composer.json to catch type-related issues early.
• Error Reporting: Use error_reporting(E_ALL) and ini_set('display_errors', 1) during development.
• Log Levels: Configure Monolog to capture package logs:

  'channels' => [
      'single' => [
          'driver' => 'single',
          'path' => storage_path('logs/package.log'),
          'level' => env('LOG_LEVEL', 'debug'),
      ],
  ],
  

Performance Tips

• Lazy Loading: Defer heavy package initialization until first use (e.g., via lazy service binding).
• Caching: Leverage Laravel’s cache for repeated package operations:

  Cache::remember('package_key', 3600, function() {
      return $package->expensiveOperation();
  });
  

Extension Points

• Service Providers: Override or extend the package’s PackageServiceProvider for custom logic.
• Views/Blades: Extend the package’s view paths in config/view.php:

  'paths' => [
      resource_path('views/vendor/package'),
  ],
  

• Testing: Use the package’s test utilities (if provided) in phpunit.xml:

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

Deprecations

• PHP 7.4 Features: Avoid:
  • create_function(), call_user_func_array() with variadic args.
  • Dynamic properties (use #[AllowDynamicProperties] if needed).
  • array_column() with non-string keys (PHP 8.0 enforces stricter checks).