LaravelFlare\Flare\Admin\Models\Traits\ModelCloning

Complexity

Total Complexity

7

Size/Duplication

Total Lines	89
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	beforeClone()	0	3	1
A	clone()	0	12	1
A	doClone()	0	12	2
A	afterClone()	0	3	1
A	excludeOnClone()	0	8	1
A	unCloneableColumns()	0	6	1

<?php

namespace LaravelFlare\Flare\Admin\Models\Traits;

trait ModelCloning
{
    /**
     * Method fired before the Clone action is undertaken.
     * 
     * @return
     */
    protected function beforeClone()
    {
    }

    /**
     * Clone Action.
     *
     * Fires off beforeClone(), doClone() and afterClone()
     *
     * @param int $modelitemId
     * 
     * @return
     */
    public function clone($modelitemId)

The parameter $modelitemId is not used and could be removed.

    {
        event(new BeforeClone($this));

        $this->beforeClone();

        $this->doClone();

        $this->afterClone();

        event(new AfterClone($this));
    }

    /**
     * The actual Clone action, which does all of hte pre-processing
     * required before we are able to perform the save() function.
     * 
     * @return
     */
    private function doClone()
    {
        if (is_callable(array('self', 'save'))) {
            $this->find($modelitemId)->replicate($this->excludeOnClone())->save();

The variable $modelitemId does not exist. Did you forget to declare it?

It seems like find() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            event(new ModelClone($this));

            return;
        }

        throw new WriteableException('For a Model to be Creatable the ModelAdmin must have the Save method implemented using the ModelWriting trait', 1);
    }

    /**
     * Method fired after the Clone action is complete.
     * 
     * @return
     */
    protected function afterClone()
    {
    }

    /**
     * An Array of Fields to Exclude on Clone.
     *
     * When cloning a Model ceratin data might need to be skipped
     * either because it is irrelevant (such as datestamps) or
     * because it is primary or unique data in the database.
     * 
     * @return array
     */
    public function excludeOnClone()
    {
        return [
            $this->model->getKeyName(),
            $this->model->getCreatedAtColumn(),
            $this->model->getUpdatedAtColumn(),
        ];
    }

    /**
     * 
     */
    public function unCloneableColumns()
    {
        // We will use this: SHOW INDEXES FROM users WHERE Non_unique != 0 AND Column_name != 'id'
        // To determine if there are unCloneable Columns and if that is the case, we will render
        // the clone view and validate the unCloneable Columns to be unique before saving.
    }
}