kettasoft/booter

The Laravel Model Event Booter package provides a flexible way to organize and manage model event handling in Laravel applications. It allows developers to define specific actions for model events (such as created, updated, deleted, etc.) by associating them with custom classes. The package simplifi

v1.0.2 2024-10-02 02:06 UTC

Requires

• php: >=8.1
• laravel/framework: ^10.0

MIT

• Abdalrhman Emad Saad

README

Laravel Model Event Booter is a package that simplifies managing model events in Laravel by allowing you to define and map model events (e.g., created, updated, deleted, etc.) to custom classes. These classes handle the logic associated with those events, making your code cleaner, modular, and easier to maintain.

Features

• Automatically boot and trigger model events with custom logic.
• Organize event-specific logic into separate, reusable classes.
• Works with Laravel's built-in model events (created, updated, deleted, etc.).
• Easy-to-use HasBooter trait that handles event firing.

Installation

1. • Install the package via Composer:

composer require kettasoft/booter

1. • Add the HasBooter trait to any model where you want to manage events.
2. • Define the $events array in the model to map events to the classes that will handle them.
3. • Publish the package's configuration file by running:

php artisan vendor:publish --provider="Scaffolding\Booter\Providers\BooterServiceProvider" --tag=config

Usage

1. • Add the HasBooter Trait to Your Model

   • Use the HasBooter trait in your model to enable event handling:

use Scaffolding\Booter\Traits\HasBooter;

class Post extends Model
{
    use HasBooter;

    /**
     * The event-to-class mappings.
     *
     * @var array
     */
    protected static $events = [
        'created' => [
            \App\Boot\AttachAuthorIdBoot::class,
        ],
        'updated' => [
            \App\Boot\LogChangesBoot::class,
        ],
    ];
}

1. • Create Event Handler Classes Create a class for each event that you want to handle. Each class should have a handle method where you define the logic to run when the event is triggered.

namespace App\Boots;

use Scaffolding\Booter\HasBooter;

class AttachAuthorIdBoot extends HasBooter
{
    /**
     * Handle the model event.
     *
     * @param  \Illuminate\Database\Eloquent\Model $model
     * @return void
     */
    public function handle(\Illuminate\Database\Eloquent\Model $model)
    {
        // Custom logic for 'created' event
        $model->author_id = auth()->id();
        $model->save();
    }
}

The class defined in the event will be called automatically when the event occurs.

1. • Handle Multiple Events

You can define multiple events in the $events array for a single model. Each event can have one or more classes that will be triggered in sequence.

protected static $events = [
    'created' => [
        \App\Boot\AttachAuthorIdBoot::class,
        \App\Boot\SendNotificationBoot::class,
    ],
    'updated' => [
        \App\Boot\LogChangesBoot::class,
    ],
];

1. • Event Handling Flow

   • When the model event (like created, updated, etc.) is triggered, the package automatically fires the associated class.

   • Each class must have a handle method where you implement the custom logic.

Contributing

Contributions are welcome! If you find any issues or have ideas for improvements, feel free to submit a pull request or open an issue.

License

This package is open-source software licensed under the MIT license.