README

这是从Neurony/laravel-duplicate分叉的，使其能够与新的Laravel 10.x一起使用

复制任何Eloquent模型及其关系

概述
安装
使用
自定义
事件

概述

此包允许您复制任何Eloquent模型记录及其底层关系。

可以复制且具有实际意义的关系类型：hasOne、morphOne、hasMany、morphMany、belongsToMany、morphToMany

安装

通过Composer安装包

composer require coliving/laravel-duplicate

使用

步骤 1

您的Eloquent模型应使用Neurony\Duplicate\Traits\HasDuplicates特性和Neurony\Duplicate\Options\DuplicateOptions类。

该特性包含一个抽象方法getDuplicateOptions()，您必须自己实现。

以下是如何实现该特性的示例

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Neurony\Duplicate\Options\DuplicateOptions;
use Neurony\Duplicate\Traits\HasDuplicates;

class YourModel extends Model
{
    use HasDuplicates;

    /**
     * Get the options for duplicating the model.
     *
     * @return DuplicateOptions
     */
    public function getDuplicateOptions(): DuplicateOptions
    {
        return DuplicateOptions::instance();
    }
}

步骤 2

一旦您在Eloquent模型中使用了Neurony\Duplicate\Traits\HasDuplicates特性，您就可以使用该特性上的saveAsDuplicate()方法来复制模型记录。

$model = YourModel::find($id);

$duplicatedModel = $model->saveAsDuplicate(); // returns the newly duplicated model instance

自定义

排除某些列

在复制模型时，您可以通过在getDuplicateOptions()方法的定义中使用excludeColumns()方法来排除某些列不被复制。

excludeColumns()方法中指定的字段将使用其默认值（null、false、0等）保存。

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->excludeColumns('column_one', 'column_two');
}

指定唯一列

在复制模型时，您可以通过在getDuplicateOptions()方法的定义中使用uniqueColumns()方法以唯一格式保存某些列。

uniqueColumns()方法中指定的字段将通过在末尾追加(n)来以唯一格式保存。例如：原始名称 (1)、原始名称 (2)

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->uniqueColumns('column_one', 'column_two');
}

排除整个关系

默认情况下，在复制模型时，其所有“子”关系（见概述）也将与其一起复制。

您可以通过在getDuplicateOptions()方法的定义中使用excludeRelations()方法来排除某些关系不被复制。

excludeRelations()方法中指定的关系将不会与目标模型一起复制，这意味着新复制的模型将不会有与指定关系关联的任何记录。

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->excludeRelations('relationOne', 'relationTwo');
}

从某些关系中排除某些列

在复制模型时，您可以通过在getDuplicateOptions()方法的定义中使用excludeRelationColumns()方法来排除其“子”关系的某些列不被复制。

此方法仅接受一个参数，应该是一个包含以下内容的关联数组：键 -> 关系的名称值 -> 包含要排除该关系的列的数组

excludeRelationColumns()方法中指定的字段将使用其默认值（null、false、0等）保存。

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->excludeRelationColumns([
            'relationOne' => ['column_one', 'column_two'],
            'relationTwo' => ['column_one'],
        ]);
}

为某些关系指定唯一列

在复制模型时，您可以通过在getDuplicateOptions()方法的定义中使用uniqueRelationColumns()方法以唯一格式保存其“子”关系的某些列。

此方法仅接受一个参数，该参数应是一个关联数组，包含：键 -> 关系名称值 -> 包含该关系唯一列的数组

uniqueRelationColumns() 方法中指定的字段将被保存为唯一的格式，通过在末尾附加 (n) 实现。例如： 原始关系名称 (1)，原始关系名称 (2)

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->uniqueRelationColumns([
            'relationOne' => ['column_one', 'column_two'],
            'relationTwo' => ['column_one'],
        ]);
}

仅复制目标模型

如果您只想复制目标模型而不复制任何关系，您可以在 getDuplicateOptions() 方法的定义中使用 disableDeepDuplication() 方法来指定此操作。

使用此方法时，复制模型时将忽略所有类型的所有关系。

/**
 * Get the options for duplicating the model.
 *
 * @return DuplicateOptions
 */
public function getDuplicateOptions() : DuplicateOptions
{
    return DuplicateOptions::instance()
        ->disableDeepDuplication();
}

事件

复制功能包含两个 Eloquent 事件： duplicating 和 duplicated

您可以将这些事件实现到您的 Eloquent 模型中，就像实现 Laravel 框架中提供的任何其他 Eloquent 事件一样。

<?php

namespace App;

use Illuminate\Database\Eloquent\Model;
use Neurony\Duplicate\Options\DuplicateOptions;
use Neurony\Duplicate\Traits\HasDuplicates;

class YourModel extends Model
{
    use HasDuplicates;

    /**
     * Boot the model.
     *
     * @return DuplicateOptions
     */
    public static function boot()
    {
        parent::boot();

        static::duplicating(function ($model) {
            // your logic here
        });

        static::duplicated(function ($model) {
            // your logic here
        });
    }

    /**
     * Get the options for duplicating the model.
     *
     * @return DuplicateOptions
     */
    public function getDuplicateOptions(): DuplicateOptions
    {
        return DuplicateOptions::instance();
    }
}

致谢

安全性

如果您发现任何与安全相关的问题，请通过电子邮件 andrei.badea@neurony.ro 联系，而不是使用问题跟踪器。

许可协议

MIT 许可协议 (MIT)。有关更多信息，请参阅 LICENSE

变更日志

请参阅 CHANGELOG 了解最近更改的内容。

贡献

请参阅 CONTRIBUTING 了解详细信息。

coliving / laravel-duplicate

维护者

详细信息