laravel-attribute-observer - GitLite

KO | EN

gitlite — search

#javascript #python #hacktoberfest #ai #golang #go #android #deep-learning #linux #nodejs #kubernetes #vue #pytorch #openai

laravel-attribute-observer

(★ 72)

Observe (and react to) attribute changes made on Eloquent models.

File Explorer

Download Latest Version (.zip)

- - config.yml
- - php-cs-fixer.yml
  - run-tests.yml
- CONTRIBUTING.md
- FUNDING.yml
- SECURITY.md
- attribute-observer.php
- - LaravelAttributeObserverMakeCommand.php
- LaravelAttributeObserverServiceProvider.php
- Pest.php
- TestCase.php
.editorconfig
.gitattributes
.gitignore
.php_cs.dist.php
CHANGELOG.md
composer.json
LICENSE.md
phpunit.xml.dist
README.md

# Installation Guide

1. Get the code

git clone https://github.com/alexstewartja/laravel-attribute-observer

Downloads the entire project code from GitHub to your computer.

cd laravel-attribute-observer

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require alexstewartja/laravel-attribute-observer

Type this command into your terminal and run it.

composer test

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Laravel Attribute Observer

![Laravel Attribute Observer - Social Image](https://banners.beyondco.de/Laravel%20Attribute%20Observer.png?theme=light&packageManager=composer+require&packageName=alexstewartja%2Flaravel-attribute-observer&pattern=floatingCogs&style=style_2&description=Observe+%28and+react+to%29+attribute+changes+made+on+Eloquent+models.&md=1&showWatermark=0&fontSize=125px&images=https%3A%2F%2Flaravel.com%2Fimg%2Flogomark.min.svg)

[![Latest Stable Version](http://poser.pugx.org/alexstewartja/laravel-attribute-observer/v)](https://packagist.org/packages/alexstewartja/laravel-attribute-observer)
[![Total Downloads](http://poser.pugx.org/alexstewartja/laravel-attribute-observer/downloads)](https://packagist.org/packages/alexstewartja/laravel-attribute-observer)
[![License](http://poser.pugx.org/alexstewartja/laravel-attribute-observer/license)](https://packagist.org/packages/alexstewartja/laravel-attribute-observer)

[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/alexstewartja/laravel-attribute-observer/run-tests.yml?label=tests)](https://github.com/alexstewartja/laravel-attribute-observer/actions?query=workflow%3Arun-tests+branch%3Amain)
[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/alexstewartja/laravel-attribute-observer/php-cs-fixer.yml?label=code%20style)](https://github.com/alexstewartja/laravel-attribute-observer/actions?query=workflow%3A"Check+%26+fix+styling"+branch%3Amain)

[![PHP Versions Supported](http://poser.pugx.org/alexstewartja/laravel-attribute-observer/require/php)](https://packagist.org/packages/alexstewartja/laravel-attribute-observer)
[![Laravel Versions Supported](https://img.shields.io/packagist/dependency-v/alexstewartja/laravel-attribute-observer/illuminate/contracts?label=laravel)](https://packagist.org/packages/alexstewartja/laravel-attribute-observer)

[![Buy Me A Coffee](https://img.shields.io/badge/Buy_Me-A_Coffee-orange?logo=buy-me-a-coffee)](https://buymeacoffee.com/alexstewartja)

A Laravel package which allows you to observe (and react to) attribute changes made on Eloquent models.

## Installation

You can install the package via composer:

```bash
composer require alexstewartja/laravel-attribute-observer
```

## Configuration

Publish the config file (`config/attribute-observer.php`) with:
```bash
php artisan vendor:publish --provider="AlexStewartJA\LaravelAttributeObserver\LaravelAttributeObserverServiceProvider"
```

This is the default content of the published config file:

```php
return [
    /*
    |--------------------------------------------------------------------------
    | Attribute Observers
    |--------------------------------------------------------------------------
    |
    | Here you may configure all desired Models and their respective Attribute
    | Observers. For example:
    |
    | 'observers' => [
    |    \App\Models\Order::class => [
    |        \App\AttributeObservers\OrderStatusObserver::class,
    |    ],
    | ]
    |
    */

'observers' => [
        // Define your model & attribute observers here...
    ]
];
```

Populate the `observers` array with your desired **Model => Attribute Observer** mappings.

## Usage

### Attribute Observers

The `make:laravel-attribute-observer` Artisan command is the easiest way to create a new attribute observer class:

```bash
php artisan make:laravel-attribute-observer OrderStatusObserver --model=Order
```

This command will place the new attribute observer in your `App/AttributeObservers` directory. If this directory does not exist,
Artisan will create it for you. Your freshly generated attribute observer will look like the following:

```php
<?php

namespace App\AttributeObservers;

use App\Models\Order;

class OrderStatusObserver
{
    /**
     * Handle changes to the "id" field of Order on "created" events.
     *
     * @param \App\Models\Order $order
     * @param mixed $newValue The current value of the field
     * @param mixed $oldValue The previous value of the field
     * @return void
     */
    public function onIdCreated(Order $order, mixed $newValue, mixed $oldValue)
    {
        //
    }
}
```

You may then modify the code to match your business logic, for example:

```php
<?php

namespace App\AttributeObservers;

use App\Events\OrderStatusChanged;
use App\Models\Order;

class OrderStatusObserver
{
    /**
     * Handle changes to the "status" field of Order on "saved" events.
     *
     * @param \App\Models\Order $order
     * @param mixed $newValue The current value of the field
     * @param mixed $oldValue The previous value of the field
     * @return void
     */
    public function onStatusSaved(Order $order, mixed $newValue, mixed $oldValue)
    {
        // Dispatch an event that sends an order update email to the customer
        OrderStatusChanged::dispatch($order);
    }
}
```

> _Attribute Observer methods are always supplied with the **model instance**, the **new attribute value** and the **previous attribute
value**, in that order._

### Events

You may observe all the typical CRUD events dispatched by Eloquent models during their lifecycles. Supported events are:
`creating`, `created`, `updating`, `updated`, `saving`, `saved`, `deleting`, `deleted`.

The naming convention to follow when defining attribute observer methods is: **on|AttributeName|Event**

So, let's say we want to check a user's email against a global spam/vanity mail list each time they attempt to update it,
we would implement that logic in an attribute observer method called `onEmailUpdating`.

> _Note that the attribute name must be in **[PascalCase](https://techterms.com/definition/pascalcase)** and the
> event name must be **[Capitalized](https://wikipedia.org/wiki/Capitalization)**._

## Testing

```bash
composer test
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

## Security Vulnerabilities

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

## Credits

- [Alex Stewart](https://github.com/alexstewartja)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

## Donations

I maintain this package in my spare time.
If it's beneficial to you, consider buying me a coffee to keep it improving.

[![Buy Me A Coffee](https://img.shields.io/badge/Buy_Me-A_Coffee-orange?logo=buy-me-a-coffee)](https://buymeacoffee.com/alexstewartja)