https://github.com/stayallive/laravel-eloquent-observable

Register Eloquent model event listeners just-in-time directly on the model.
https://github.com/stayallive/laravel-eloquent-observable

eloquent laravel-package

Last synced: 1 day ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/stayallive/laravel-eloquent-observable
• Owner: stayallive
• License: mit
• Created: 2022-02-28T14:11:38.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-04T14:04:01.000Z (5 months ago)
• Last Synced: 2025-01-16T15:10:09.795Z (1 day ago)
• Topics: eloquent, laravel-package
• Language: PHP
• Homepage:
• Size: 37.1 KB
• Stars: 28
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Laravel Eloquent Observable

[![Latest Version](https://img.shields.io/github/release/stayallive/laravel-eloquent-observable.svg?style=flat-square)](https://github.com/stayallive/laravel-eloquent-observable/releases)

[![Software License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE.md)

[![Build Status](https://img.shields.io/github/actions/workflow/status/stayallive/laravel-eloquent-observable/ci.yaml?branch=master&style=flat-square)](https://github.com/stayallive/laravel-eloquent-observable/actions/workflows/ci.yaml)

[![Total Downloads](https://img.shields.io/packagist/dt/stayallive/laravel-eloquent-observable.svg?style=flat-square)](https://packagist.org/packages/stayallive/laravel-eloquent-observable)

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

Using [Observers](https://laravel.com/docs/10.x/eloquent#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](https://laravel-news.com/laravel-10-44-0#content-new-observedby-attribute-for-models) 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

```bash

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

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 `[email protected]`. All security vulnerabilities will be swiftly

addressed.

## License

This package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).