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()方法来排除其“子”关系的某些列不被复制。

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

在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()方法以唯一格式保存其“子”关系的某些列。

此方法仅接受一个参数，应为一个关联数组，包含以下内容：
key -> 关系名称
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
• 所有贡献者

安全

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

许可

MIT许可（MIT）。有关更多信息，请参阅LICENSE。

变更日志

请参阅变更日志获取有关最近更改的更多信息。

贡献

请参阅贡献指南获取详细信息。