stayallive/laravel-eloquent-observable

Register Eloquent model event listeners just-in-time directly from the model.

v1.0.3 2024-03-13 21:25 UTC

Requires

• php: ^8.0.2
• laravel/framework: ^9||^10||^11

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• orchestra/testbench: ^8|^9
• phpunit/phpunit: ^10.0

MIT

• Alex Bouma

• laravel
• eloquent
• observers

README

Register Eloquent model event listeners just-in-time directly from the model.

Using Observers can introduce a (significant) overhead on the application since they are usually registered in a service provider which results in every model in your application with a observer is "booted" a startup of the application even though the model is never touched in the request. This package aims to reduce that overhead by connecting listeners just-in-time whenever the Eloquent model is booted (first used) in the request. The event callbacks are also defined on the model itself keeping the code cleaner, althought this is my preference of course and if you disagree this might not be the package for you.

Note

Laravel 10.44 introduced the ObservedBy attribute which allows you to define the observer on the model itself which negates all the performance benefits of this package. However this package still provides an alternative way to define the event handler methods on the model itself so might still be considered useful but using the ObservedBy attribute will solve the performance issue with registering the model observers inside a service provider.

Installation

composer require stayallive/laravel-eloquent-observable

Usage

Adding the Observable trait will ensure that the observable events are connected to the event handlers defined on the model.

<?php

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Stayallive\Laravel\Eloquent\Observable\Observable;

class SomeModel extends Model
{
    use Observable;

    // Event handlers are defined by `onEventName` where `EventName` is any valid Eloquent event (or custom event)
    // See a full list of Eloquent events: https://laravel.com/docs/9.x/eloquent#events
    public static function onSaving(self $model): void
    {
        // For example:
        $model->slug = str_slug($model->title);
    }
}

Security Vulnerabilities

If you discover a security vulnerability within this package, please send an e-mail to Alex Bouma at [e-mail]. All security vulnerabilities will be swiftly addressed.

License

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