README

概述
安装
使用
自定义
事件

概述

此包允许您复制任何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()方法以唯一格式保存其"子"关系的某些列。

此方法只接受一个参数，应为一个包含以下内容的关联数组：
键 -> 关系的名称
值 -> 包含该关系的唯一列的数组

在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以获取详细信息。

gaspertrix / laravel-duplicate

维护者

详细信息