Breeze Bootstrap Ui Laravel Package

Getting Started

Install via Composer:

composer require vendor/package-name

Publish the package’s assets/configuration (if applicable) with:

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

Register the service provider in config/app.php under providers (if not auto-discovered). First use case: Authenticate users via Laravel Breeze (now required). Example:

use Vendor\PackageName\Facades\PackageName;

$authResult = PackageName::authenticate($request->user());

Implementation Patterns

Core Workflow

1. Authentication Integration Extend Laravel Breeze’s default auth flow by hooking into PackageName::events():

   PackageName::events()->listen('auth.attempted', function ($user) {
       // Custom logic post-auth
   });
   

2. Middleware Use the package’s built-in middleware (auth.package-name) in routes:

   Route::middleware(['auth.package-name'])->group(function () {
       // Protected routes
   });
   

3. Blade Directives Leverage package-specific directives (e.g., @packageNameCheck) in views:

   @packageNameCheck
       <p>User is authenticated via PackageName.</p>
   @endpackageNameCheck
   

Common Use Cases

• User Roles: Attach roles via PackageName::assignRole($user, 'admin').
• API Tokens: Generate tokens with PackageName::generateToken($user).
• Event Listeners: Subscribe to PackageName::events()->on('user.created').

Gotchas and Tips

Breaking Changes (v1.0.2)

• Laravel Breeze Dependency: Package now requires Breeze v2.3+. Migrate existing auth systems or install Breeze first:

  composer require laravel/breeze --dev
  php artisan breeze:install
  

• PHP 8.2+ Mandatory: Upgrade PHP if using older versions (e.g., 8.1).

Debugging

• Event Debugging: Enable verbose logging for events:

  PackageName::events()->debug(true);
  

• Middleware Conflicts: Ensure auth.package-name is placed after auth middleware in $routeMiddleware to avoid bypassing Laravel’s default auth.

Extension Points

• Custom Guards: Extend the guard logic by publishing the config and modifying config/package-name.php:

  'guards' => [
      'web' => [
          'driver' => 'session',
          'provider' => 'users',
          'custom_logic' => \App\Logic\CustomAuth::class,
      ],
  ],
  

• API Resources: Override default API responses by extending Vendor\PackageName\Http\Resources\UserResource.

Performance

• Caching: Cache role/permission checks for high-traffic apps:

  PackageName::cachePermissions($user, now()->addHours(1));