README

很遗憾，此包现已停止维护。
请查看Varbox（Laravel管理面板）以获取此功能以及更多功能。

购买: https://varbox.io/buy
文档: https://varbox.io/docs
演示: https://demo.varbox.test/admin
仓库 https://github.com/VarboxInternational/varbox

谢谢！

复制任何Eloquent模型及其关系

概述
安装
用法
自定义
事件

概述

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

可以和应该被复制的关联类型： hasOne、morphOne、hasMany、morphMany、belongsToMany、morphToMany

安装

通过Composer安装包

composer require neurony/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() 方法，以独特格式保存其“子”关系的一定列。

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

在 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 了解详细信息。

radeer10 / laravel-duplicate

维护者

详情