Neurony\Duplicate\Options\DuplicateOptions

Complexity

Total Complexity

9

Size/Duplication

Total Lines	155
Duplicated Lines	0 %

Coupling/Cohesion

Components	6
Dependencies	1

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	__get()	0	10	2
A	instance()	0	4	1
A	excludeColumns()	0	6	1
A	uniqueColumns()	0	6	1
A	excludeRelations()	0	6	1
A	excludeRelationColumns()	0	6	1
A	uniqueRelationColumns()	0	6	1
A	disableDeepDuplication()	0	6	1

<?php

namespace Neurony\Duplicate\Options;

use Exception;
use Illuminate\Support\Arr;

class DuplicateOptions
{
    /**
     * The database columns that should be ignored when duplicating the record.
     *
     * @var array|string
     */
    private $excludedColumns;

    /**
     * The database columns that should be unique when duplicating the record.
     *
     * @var array|string
     */
    private $uniqueColumns;

    /**
     * The relations of the model that should be ignored when duplicating the record.
     *
     * @var array|string
     */
    private $excludedRelations;

    /**
     * The database columns for each model's relation that should be ignored when duplicating the record.
     *
     * @var array
     */
    private $excludedRelationColumns;

    /**
     * The database columns for each model's relation that should be unique when duplicating the record.
     *
     * @var array
     */
    private $uniqueRelationColumns;

    /**
     * Flag indicating if when duplicating a record, the script should also duplicate it's relations.
     *
     * @var bool
     */
    private $shouldDuplicateDeeply = true;

    /**
     * Get the value of a property of this class.
     *
     * @param $name
     * @return mixed
     * @throws Exception
     */
    public function __get($name)
    {
        if (property_exists(static::class, $name)) {
            return $this->{$name};
        }

        throw new Exception(
            'The property "'.$name.'" does not exist in class "'.static::class.'"'
        );
    }

    /**
     * Get a fresh instance of this class.
     *
     * @return DuplicateOptions
     */
    public static function instance(): self
    {
        return new static();
    }

    /**
     * Set the $excludedColumns to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * @param array|string $columns
     * @return DuplicateOptions
     */
    public function excludeColumns(...$columns): self
    {
        $this->excludedColumns = Arr::flatten($columns);

$columns is of type array<integer,array|string>, but the function expects a object<Illuminate\Support\iterable>.

        return $this;
    }

    /**
     * Set the $uniqueColumns to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * @param array|string $columns
     * @return DuplicateOptions
     */
    public function uniqueColumns(...$columns): self
    {
        $this->uniqueColumns = Arr::flatten($columns);

$columns is of type array<integer,array|string>, but the function expects a object<Illuminate\Support\iterable>.

        return $this;
    }

    /**
     * Set the $excludedRelations to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * @param array|string $relations
     * @return DuplicateOptions
     */
    public function excludeRelations(...$relations): self
    {
        $this->excludedRelations = Arr::flatten($relations);

$relations is of type array<integer,array|string>, but the function expects a object<Illuminate\Support\iterable>.

        return $this;
    }

    /**
     * Set the $excludedRelationColumns to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * Param $columns:
     * --- associative array with keys containing each relation name and values (array) containing the excluded columns for each relation.
     *
     * @param array $columns
     * @return DuplicateOptions
     */
    public function excludeRelationColumns(array $columns = []): self
    {
        $this->excludedRelationColumns = $columns;

        return $this;
    }

    /**
     * Set the $uniqueRelationColumns to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * Param $columns:
     * --- associative array with keys containing each relation name and values (array) containing the unique columns for each relation.
     *
     * @param array $columns
     * @return DuplicateOptions
     */
    public function uniqueRelationColumns(array $columns = []): self
    {
        $this->uniqueRelationColumns = $columns;

        return $this;
    }

    /**
     * Set the $shouldDuplicateDeeply to work with in the Neurony\Duplicate\Traits\HasDuplicates trait.
     *
     * @return DuplicateOptions
     */
    public function disableDeepDuplication(): self
    {
        $this->shouldDuplicateDeeply = false;

        return $this;
    }
}