Thailand Provinces Laravel Package

Getting Started

Install the package via Composer:

composer require vendor/package-name

Publish the configuration file (if applicable) with:

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

For Laravel 6/7/8 compatibility, ensure your composer.json requires the updated version:

"require": {
    "vendor/package-name": "^2.0"
}

Verify compatibility by checking the package's composer.json for Laravel version constraints. Start with a simple use case, such as:

use Vendor\PackageName\Facades\PackageName;

$response = PackageName::doSomething();

Implementation Patterns

Laravel Version-Specific Workflows

• Laravel 6/7/8: Leverage the updated version for new projects or migrations. The package now follows Laravel’s newer conventions (e.g., dependency injection, service containers).
• Legacy Projects: If maintaining Laravel 5.x projects, pin to ^1.x to avoid breaking changes. Use feature flags or conditional logic to handle version-specific behavior:

  if (app()->version() >= '6.0') {
      // Use v2.x features
  }
  

Integration Tips

• Service Providers: Register the package’s bindings in config/app.php under providers:

  Vendor\PackageName\PackageServiceProvider::class,
  

• Facades: Prefer facades for simplicity in Blade/views:

  {{ PackageName::action() }}
  

• Dependency Injection: Inject the package’s core class into controllers/services:

  public function __construct(Vendor\PackageName\Contracts\PackageContract $package) {
      $this->package = $package;
  }
  

Migration Strategies

• Database Changes: If the package introduces schema updates, run:

  php artisan migrate
  

• Configuration: Update config/package-name.php to match the new structure (if applicable).

Gotchas and Tips

Breaking Changes in v2.0.0

• Laravel 5.x Drop: The package no longer supports Laravel 5.x. Test thoroughly in Laravel 6/7/8 environments.
• API Changes: Check the changelog for renamed methods/classes (e.g., OldClass::method() → NewClass::method()).
• Configuration: Some config keys may have moved or been renamed. Validate against the updated config/package-name.php.

Debugging

• Version Conflicts: Ensure no other packages are locking the package to ^1.x. Run:

  composer why-not vendor/package-name:^2.0
  

• Deprecation Warnings: Use strict mode in PHP (7.4+) or deprecation mode in Laravel to catch warnings early:

  // In AppServiceProvider@boot()
  if (app()->version() >= '6.0') {
      error_reporting(E_ALL);
  }
  

Extension Points

• Custom Providers: Extend the package’s service provider to add bindings:

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

• Middleware: Add middleware to the package’s HTTP layer (if applicable):

  Route::middleware(['package.middleware'])->group(function () {
      // Routes
  });
  

Performance

• Caching: Utilize Laravel’s cache (e.g., Cache::remember) for expensive operations:

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

• Queue Jobs: Offload long-running tasks to queues:

  PackageName::dispatchJob($data)->onQueue('package-queue');