search
HomePHP FrameworkLaravelLet's talk about how to use model events in Laravel

Let's talk about how to use model events in Laravel

When working with Eloquent models, it is common to take advantage of events dispatched through the model lifecycle. There are a few different ways to do this, and in this tutorial I'll cover them and explain the pros and cons of each. [Related recommendations: laravel video tutorial]

I will use the same example for each method so that you can compare directly. This example assigns the model's UUID property to the UUID during creation of the model itself.

Our first approach uses the model's static bootstrap method to register the behavior. This allows us to work directly on the model and create it when the model is created .

declare(strict_types=1);

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class Office extends Model
{
    public static function boot(): void
    {
        static::creating(fn (Model $model) =>
            $model->uuid = Str::uuid(),
        );
    }
}

This approach is great for small, direct reactions to model events, like adding UUIDs, because it's very easy to understand and you can see exactly what's happening on the model. The biggest problem with this approach is code duplication, if you have multiple models that need to be assigned UUIDs, you will be doing the same thing repeatedly.

This leads us nicely into the second approach, using a feature. In Laravel, if you create a method on a trait that starts with boot and ends with the trait name, your models can inherit the trait and automatically start them. Here is an example:

declare(strict_types=1);

namespace App\Models\Concerns;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

trait HasUuid
{
    public static function bootHasUuid(): void
    {
        static::creating(fn (Model $model) =>
            $model->uuid = Str::uuid(),
        );
    }
}

Using traits allows you to add this behavior to every model that requires it and is easy to implement. My biggest drawback is that stacking these behaviors can cause problems when multiple features want to take advantage of the same model event. They start fighting for priority and it quickly becomes a mess.

This leads us to the next option, model observers. A model observer is a class-based way to respond to model events, where the method corresponds to the specific event that was triggered.

declare(strict_types=1);

namespace App\Observers;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class OfficeObserver
{
    public function creating(Model $model): void
    {
        $model->uuid = Str::uuid();
    }
}

This class needs to be registered somewhere, either with the service provider or the model itself (which is where I recommend it). Registering this observer in the model allows you to see the side effects of changing eloquent behavior at the model level. The problem with hiding it from the service provider is that it's hard to know unless everyone knows it exists. The biggest disadvantage of this approach is its visibility. In my opinion this method is great when used correctly.

Another way to solve this problem is to take advantage of the $dispatchesEvents property of the Eloquent model itself. This is a property on every Eloquent model that allows you to list events to listen to and the classes to call for those events.

declare(strict_types=1);

namespace App\Models;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class Office extends Model
{
    protected $dispatchesEvents = [
        'creating' => SetModelUuid::class,
    ];
}

SetModelUuid will be instantiated during the life cycle of the Eloquent model, which is your opportunity to add behaviors and properties to the model.

declare(strict_types=1);

namespace App\Models\Events;

use Illuminate\Database\Eloquent\Model;
use Illuminate\Support\Str;

class SetModelUuid
{
    public function __construct(Model $model)
    {
        $model->uuid = Str::uuid();
    }
}

This approach is one of the cleanest and easiest to understand because the model has a lot of visibility and you can easily share this class between models. The biggest question you'll face is whether you need to trigger multiple actions on model events.

Anyway, honestly, there is no right way to do this. You can choose any of the above methods and they will all work, but you should choose the method that works for you and your specific use case. I'd like to see more options for this specific feature.

For example, if you need to add multiple properties to a model on model events, observers are a good choice. However, is this the best option? What if we use the dispatch events attribute to run a custom pipeline for this model?

declare(strict_types=1);

namespace App\Models\Pipelines;

use App\Models\Office

class OfficeCreatingPipeline
{
    public function __construct(Office $model)
    {
        app(Pipeline::class)
            ->send($model)
            ->through([
                ApplyUuidProperty::class,
                TapCreatedBy::class,
            ]);
    }
}

As you can see, we can start using pipelines to add multiple behaviors for event modeling. Now, this hasn't been tested, so I don't know 100% if it's possible - but as a concept, it could open up a composable way to react to model events.

How do you handle model events in your Laravel project? Tell us on Twitter!

Original address: https://laravel-news.com/working-with-laravel-model-events

Translation address: https://learnku.com/laravel/ t/71183

For more programming related knowledge, please visit: Programming Video! !

The above is the detailed content of Let's talk about how to use model events in Laravel. For more information, please follow other related articles on the PHP Chinese website!

Statement
This article is reproduced at:learnku. If there is any infringement, please contact admin@php.cn delete
php怎么把负数转为正整数php怎么把负数转为正整数Apr 19, 2022 pm 08:59 PM

php把负数转为正整数的方法:1、使用abs()函数将负数转为正数,使用intval()函数对正数取整,转为正整数,语法“intval(abs($number))”;2、利用“~”位运算符将负数取反加一,语法“~$number + 1”。

php怎么实现几秒后执行一个函数php怎么实现几秒后执行一个函数Apr 24, 2022 pm 01:12 PM

实现方法:1、使用“sleep(延迟秒数)”语句,可延迟执行函数若干秒;2、使用“time_nanosleep(延迟秒数,延迟纳秒数)”语句,可延迟执行函数若干秒和纳秒;3、使用“time_sleep_until(time()+7)”语句。

php怎么除以100保留两位小数php怎么除以100保留两位小数Apr 22, 2022 pm 06:23 PM

php除以100保留两位小数的方法:1、利用“/”运算符进行除法运算,语法“数值 / 100”;2、使用“number_format(除法结果, 2)”或“sprintf("%.2f",除法结果)”语句进行四舍五入的处理值,并保留两位小数。

php怎么根据年月日判断是一年的第几天php怎么根据年月日判断是一年的第几天Apr 22, 2022 pm 05:02 PM

判断方法:1、使用“strtotime("年-月-日")”语句将给定的年月日转换为时间戳格式;2、用“date("z",时间戳)+1”语句计算指定时间戳是一年的第几天。date()返回的天数是从0开始计算的,因此真实天数需要在此基础上加1。

php怎么判断有没有小数点php怎么判断有没有小数点Apr 20, 2022 pm 08:12 PM

php判断有没有小数点的方法:1、使用“strpos(数字字符串,'.')”语法,如果返回小数点在字符串中第一次出现的位置,则有小数点;2、使用“strrpos(数字字符串,'.')”语句,如果返回小数点在字符串中最后一次出现的位置,则有。

php字符串有没有下标php字符串有没有下标Apr 24, 2022 am 11:49 AM

php字符串有下标。在PHP中,下标不仅可以应用于数组和对象,还可应用于字符串,利用字符串的下标和中括号“[]”可以访问指定索引位置的字符,并对该字符进行读写,语法“字符串名[下标值]”;字符串的下标值(索引值)只能是整数类型,起始值为0。

php怎么替换nbsp空格符php怎么替换nbsp空格符Apr 24, 2022 pm 02:55 PM

方法:1、用“str_replace(" ","其他字符",$str)”语句,可将nbsp符替换为其他字符;2、用“preg_replace("/(\s|\&nbsp\;||\xc2\xa0)/","其他字符",$str)”语句。

php怎么读取字符串后几个字符php怎么读取字符串后几个字符Apr 22, 2022 pm 08:31 PM

在php中,可以使用substr()函数来读取字符串后几个字符,只需要将该函数的第二个参数设置为负值,第三个参数省略即可;语法为“substr(字符串,-n)”,表示读取从字符串结尾处向前数第n个字符开始,直到字符串结尾的全部字符。

See all articles

Hot AI Tools

Undresser.AI Undress

Undresser.AI Undress

AI-powered app for creating realistic nude photos

AI Clothes Remover

AI Clothes Remover

Online AI tool for removing clothes from photos.

Undress AI Tool

Undress AI Tool

Undress images for free

Clothoff.io

Clothoff.io

AI clothes remover

AI Hentai Generator

AI Hentai Generator

Generate AI Hentai for free.

Hot Article

R.E.P.O. Energy Crystals Explained and What They Do (Yellow Crystal)
2 weeks agoBy尊渡假赌尊渡假赌尊渡假赌
Repo: How To Revive Teammates
1 months agoBy尊渡假赌尊渡假赌尊渡假赌
Hello Kitty Island Adventure: How To Get Giant Seeds
4 weeks agoBy尊渡假赌尊渡假赌尊渡假赌

Hot Tools

Zend Studio 13.0.1

Zend Studio 13.0.1

Powerful PHP integrated development environment

Atom editor mac version download

Atom editor mac version download

The most popular open source editor

ZendStudio 13.5.1 Mac

ZendStudio 13.5.1 Mac

Powerful PHP integrated development environment

SublimeText3 Mac version

SublimeText3 Mac version

God-level code editing software (SublimeText3)

Dreamweaver Mac version

Dreamweaver Mac version

Visual web development tools