Laravel Treats Laravel Package

Getting Started

Minimal Steps

1. Installation:

   composer require mopo922/laravel-treats
   

   Add the service provider to config/app.php if using view layouts:

   LaravelTreats\LaravelTreatsServiceProvider::class,
   

2. First Use Case:

   • Controllers: Extend LaravelTreats\Controller for built-in methods like index(), create(), store(), show(), edit(), update(), and destroy().

     use LaravelTreats\Controller;
     
     class PostController extends Controller {
         // Inherits CRUD methods
     }
     

   • Models: Extend LaravelTreats\Model for soft deletes, timestamps, and UUID support.

     use LaravelTreats\Model;
     
     class Post extends Model {
         // Inherits traits like soft deletes
     }
     

   • Views: Publish the default layout with:

     php artisan vendor:publish --provider="LaravelTreats\LaravelTreatsServiceProvider"
     

     Then use extends treats::layouts.app in your Blade templates.

Implementation Patterns

Controllers

• CRUD Workflow: Extend LaravelTreats\Controller to auto-generate RESTful routes and methods. Customize logic in overridden methods.

  class UserController extends Controller {
      public function store(Request $request) {
          // Custom store logic
      }
  }
  

• Route Binding: Use Route::resource('posts', PostController::class) for automatic route registration.

Models

• Soft Deletes: Enable via use SoftDeletes; trait. Add deleted_at column to DB.

  class Post extends Model {
      use SoftDeletes;
      protected $dates = ['deleted_at'];
  }
  

• UUIDs: Use use HasUuid; trait for UUID primary keys.

  class Post extends Model {
      use HasUuid;
  }
  

Views

• Layouts: Extend treats::layouts.app for consistent styling. Override sections like @yield('content').

  @extends('treats::layouts.app')
  @section('content')
      <!-- Custom content -->
  @endsection
  

• Components: Use published Blade components (e.g., treats::partials.form) for reusable UI.

Integration Tips

• Middleware: Bind middleware to controller methods:

  class AdminController extends Controller {
      public function __construct() {
          $this->middleware('auth:admin');
      }
  }
  

• Validation: Leverage Laravel’s built-in validation in controller methods.

Gotchas and Tips

Pitfalls

1. Deprecation Warning: The package is unmaintained (Laravel 5.x only). Avoid for new projects; migrate logic to Laravel 8+.
2. Service Provider: Only required for view layouts. Skip if unused to avoid unnecessary overhead.
3. UUID Conflicts: Ensure HasUuid is used before Model in inheritance chain to avoid primary key conflicts.
4. Soft Deletes: Requires deleted_at column in DB. Run migrations manually if not using Laravel’s migrate:

   Schema::table('posts', function (Blueprint $table) {
       $table->softDeletes();
   });
   

Debugging

• Route Conflicts: Use php artisan route:list to debug overlapping routes from Route::resource().
• View Issues: Clear cached views:

  php artisan view:clear
  

• Model Errors: Check for missing traits or incorrect column names (e.g., deleted_at vs. deletedAt).

Extension Points

1. Custom Traits: Extend LaravelTreats\Model or Controller to add domain-specific logic.

   trait CustomSoftDeletes {
       public function restoreWithData() { ... }
   }
   

2. View Overrides: Publish and modify layouts/components:

   php artisan vendor:publish --tag=treats-views
   

3. Service Provider: Override bindings in register() or boot():

   public function boot() {
       View::composer('*', function ($view) {
           $view->with('custom_data', 'value');
       });
   }
   

Performance Tips

• Avoid Bloat: Disable unused features (e.g., skip LaravelTreatsServiceProvider if not using views).
• Caching: Cache repeated view layouts:

  @cache(['treats.layouts.app'], 60)