README

此包为BelongsToMany关系中的sync()、attach()、detach()或updateExistingPivot()方法引入了新的Eloquent事件。

Laravel问题

在Laravel中，当使用sync()、attach()、detach()或updateExistingPivot()方法更新BelongsToMany关系（关联表）时，不会触发事件，但此包将帮助解决这个问题。

版本兼容性

• 您仍然可以使用laravel 5.4.x或更旧的版本的不活跃分支。

安装

1.使用composer安装包

composer require fico7489/laravel-pivot

此语句将安装与您当前Laravel版本兼容的最高版本包。

2.在您的基模型或特定模型中使用Fico7489\Laravel\Pivot\Traits\PivotEventTrait特性。

use Fico7489\Laravel\Pivot\Traits\PivotEventTrait;
use Illuminate\Database\Eloquent\Model;

abstract class BaseModel extends Model
{
    use PivotEventTrait;
...

就这样，享受吧。

新的Eloquent事件

您可以在此处查看所有Eloquent事件：https://laravel.net.cn/docs/5.5/eloquent#events)

新事件有

pivotAttaching, pivotAttached
pivotDetaching, pivotDetached,
pivotUpdating, pivotUpdated

捕获事件的最好方式是使用这些模型函数

public static function boot()
{
    parent::boot();

    static::pivotAttaching(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        //
    });
    
    static::pivotAttached(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        //
    });
    
    static::pivotDetaching(function ($model, $relationName, $pivotIds) {
        //
    });

    static::pivotDetached(function ($model, $relationName, $pivotIds) {
        //
    });
    
    static::pivotUpdating(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        //
    });
    
    static::pivotUpdated(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        //
    });
    
    static::updating(function ($model) {
        //this is how we catch standard eloquent events
    });
}

您也可以在此处看到这些事件

\Event::listen('eloquent.*', function ($eventName, array $data) {
    echo $eventName;  //e.g. 'eloquent.pivotAttached'
});

支持的关联

BelongsToMany和MorphToMany

哪些事件被触发以及它们何时被触发

四个BelongsToMany方法从这个包中触发事件

attach()
触发一个和事件。
即使添加了更多行，也只为所有行触发一个事件。在这种情况下，您可以在变量中看到所有更改的行ID，以及在变量中更改的行ID及其属性。

detach()
触发一个和事件。
即使删除了更多行，也只为所有行触发一个事件。在这种情况下，您可以在变量中看到所有更改的行ID。

updateExistingPivot()
触发一个和事件。
您只能使用updateExistingPivot更改关联表中的一行。

sync()
根据在关联表中添加的行数触发多个和事件。如果没有添加任何行，则不会触发这些事件。
触发一个和事件，但您可以在变量中看到所有删除的ID。如果没有删除任何行，则不会触发此事件。
例如，当调用sync()时，添加了两行并删除了两行，将触发两个和事件以及一个和事件。
如果调用sync()但没有添加或删除行，则不会触发事件。

用法

数据库中有三个表：users(id, name)，roles(id, name)，role_user(user_id, role_id)。我们有两个模型

class User extends Model
{
    use PivotEventTrait;
    ....
    
    public function roles()
    {
        return $this->belongsToMany(Role::class);
    }
    
    static::pivotAttached(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        echo 'pivotAttached';
        echo get_class($model);
        echo $relationName;
        print_r($pivotIds);
        print_r($pivotIdsAttributes);
    });
    
    static::pivotUpdated(function ($model, $relationName, $pivotIds, $pivotIdsAttributes) {
        echo 'pivotUpdated';
        echo get_class($model);
        echo $relationName;
        print_r($pivotIds);
        print_r($pivotIdsAttributes);
    });
    
    static::pivotDetached(function ($model, $relationName, $pivotIds) {
        echo 'pivotDetached';
        echo get_class($model);
        echo $relationName;
        print_r($pivotIds);
    });

class Role extends Model
{
    ....

附加

对于attach()或detach()，为每个关联ID触发一个事件。

使用整数附加

运行此代码

$user = User::first();
$user->roles()->attach(1);

您将看到以下输出

pivotAttached
App\Models\User
roles
[1]
[1 => []]

使用数组附加

运行此代码

$user = User::first();
$user->roles()->attach([1]);

您将看到以下输出

pivotAttached
App\Models\User
roles
[1]
[1 => []]

使用模型附加

运行此代码

$user = User::first();
$user->roles()->attach(Role::first());

您将看到以下输出

pivotAttached
App\Models\User
roles
[1]
[1 => []]

使用集合附加

运行此代码

$user = User::first();
$user->roles()->attach(Role::get());

您将看到以下输出

pivotAttached
App\Models\User
roles
[1, 2]
[1 => [], 2 => []]

使用数组(id => 属性)附加

运行此代码

$user = User::first();
$user->roles()->attach([1, 2 => ['attribute' => 'test']], ['attribute2' => 'test2']);

您将看到以下输出

pivotAttached
App\Models\User
roles
[1, 2]
[1 => [], 2 => ['attribute' => 'test', 'attribute2' => 'test2']]

同步

对于sync()方法，为每个关联行触发一个事件。

运行此代码

$user = User::first();
$user->roles()->sync([1, 2]);

您将看到以下输出

pivotAttached
App\Models\User
roles
[1]
[1 => []]

pivotAttached
App\Models\User
roles
[2]
[2 => []]

解除

运行此代码

$user = User::first();
$user->roles()->detach([1, 2]);

您将看到以下输出

pivotDetached
App\Models\User
roles
[1, 2]

更新

运行此代码

$user = User::first();
$user->roles()->updateExistingPivot(1, ['attribute' => 'test']);

您将看到以下输出

pivotUpdated
App\Models\User
roles
[1]
[1 => ['attribute' => 'test']]

许可

MIT 协议

自由软件，太棒了！