Respond Laravel Package

Getting Started

Install via Composer:

composer require vendor/package-name

Publish the package config (if applicable) and run migrations:

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

First use case: Leverage the package’s core functionality (e.g., PackageName::action()) or extend it with custom methods (new in 1.2.1). The documentation now includes examples for both default and custom method usage.

Implementation Patterns

Core Workflows

1. Default Usage: Use the package’s built-in methods (e.g., PackageName::process()) for common tasks.
2. Custom Methods: Extend functionality by registering custom methods via the extend() facade or service provider:

   // Register a custom method
   PackageName::extend('customMethod', function ($param) {
       return $param * 2; // Example logic
   });
   
   // Usage
   $result = PackageName::customMethod(5); // Returns 10
   

3. Service Provider Integration: Bind custom methods or override defaults in AppServiceProvider:

   public function boot()
   {
       PackageName::extend('customLogic', function () {
           // Custom logic here
       });
   }
   

Integration Tips

• Event Listeners: Hook into the package’s events (if available) to react to lifecycle changes.
• Middleware: Use the package’s middleware (if provided) for request/response manipulation.
• Testing: Leverage the new 99% test coverage to model your own tests. Run:

  composer test
  

  to inspect the test suite for patterns.

Gotchas and Tips

Pitfalls

• Method Naming Collisions: Avoid naming custom methods that conflict with existing package methods (e.g., process()). Prefix with custom_ or use namespaces.
• Configuration Overrides: Ensure custom method logic doesn’t override critical package behavior. Test thoroughly after extending.
• Test Coverage Limitation: While coverage is high, edge cases in custom methods may not be tested. Write unit tests for your extensions.

Debugging

• Log Custom Methods: Add logging to custom methods for debugging:

  PackageName::extend('debugMethod', function ($input) {
      \Log::debug('Custom method input:', ['input' => $input]);
      return $input;
  });
  

• Use dd() Sparingly: The package may rely on lazy evaluation. Prefer logging or dump() for inspection.

Extension Points

• Service Provider: Override package bindings in AppServiceProvider@register():

  $this->app->extend('package.name', function ($service) {
      return new CustomPackageService($service);
  });
  

• Facades: Extend facades by publishing and modifying the facade class:

  php artisan vendor:publish --tag="package-name-facades"
  

• Commands/Jobs: Use the package’s events or hooks to trigger custom commands or queue jobs.

Configuration Quirks

• Published Config: If the package publishes a config file, ensure your .env or config/package.php doesn’t conflict with defaults.
• Lazy Loading: Some methods may load resources on-demand. Cache results if performance is critical:

  $cached = Cache::remember('package_key', 60, function () {
      return PackageName::expensiveMethod();
  });