LaravelFlare\Flare\Traits\ModelAdmin\ModelSaving

Complexity

Total Complexity

19

Size/Duplication

Total Lines	143
Duplicated Lines	4.9 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes	1
Bugs	1	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	beforeSave()	0	6	1
A	save()	0	16	3
B	doSave()	4	25	6
A	afterSave()	3	14	4
B	saveRelation()	0	13	5

<?php

namespace LaravelFlare\Flare\Traits\ModelAdmin;

use LaravelFlare\Flare\Events\ModelSave;
use LaravelFlare\Flare\Events\AfterSave;
use LaravelFlare\Flare\Events\BeforeSave;
use LaravelFlare\Flare\Exceptions\ModelAdminWriteableException as WriteableException;

trait ModelSaving
{
    /**
     * Used by beforeSave() to ensure child classes call parent::beforeSave().
     * 
     * @var bool
     */
    protected $brokenBeforeSave = false;

    /**
     * Used by afterSave() to ensure child classes call parent::afterSave().
     * 
     * @var bool
     */
    protected $brokenAfterSave = false;

    /**
     * Relations to Update during Save and
     * the appropriate method to fire the update with.
     * 
     * @var array
     */
    protected $doSaveRelations = ['BelongsTo' => 'associate'];

    /**
     * Relations to Update after Save and
     * the appropriate method to fire the update with.
     * 
     * @var array
     */
    protected $afterSaveRelations = ['BelongsToMany' => 'sync'];

    /**
     * Method fired before the Save action is undertaken.
     * 
     * @return
     */
    protected function beforeSave()
    {
        $this->brokenBeforeSave = false;

        event(new BeforeSave($this));
    }

    /**
     * Save Action.
     *
     * Fires off beforeSave(), doSave() and afterSave()
     * 
     * @return
     */
    public function save()
    {
        $this->brokenBeforeSave = true;
        $this->beforeSave();
        if ($this->brokenBeforeSave) {
            throw new WriteableException('ModelAdmin has a broken beforeSave method. Make sure you call parent::beforeSave() on all instances of beforeSave()', 1);
        }

        $this->doSave();

        $this->brokenAfterSave = true;
        $this->afterSave();
        if ($this->brokenAfterSave) {
            throw new WriteableException('ModelAdmin has a broken afterSave method. Make sure you call parent::afterSave() on all instances of afterSave()', 1);
        }
    }

    /**
     * The actual Save action, which does all of hte pre-processing
     * required before we are able to perform the save() function.
     * 
     * @return
     */
    private function doSave()
    {
        foreach (\Request::only(array_keys($this->fields)) as $key => $value) {

The property fields does not exist. Did you maybe forget to declare it?

            if (!\Schema::hasColumn($this->model->getTable(), $key)) {
                continue;
            }

            if ($this->hasSetMutator($key)) {

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

                $this->setAttribute($key, $value);

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

                continue;
            }

            // Could swap this out for model -> getAttribute, then check if we have an attribute or a relation... getRelationValue() is helpful
            if (method_exists($this->model, $key) && is_a(call_user_func_array([$this->model, $key], []), 'Illuminate\Database\Eloquent\Relations\Relation')) {

This code seems to be duplicated across your project.

                $this->saveRelation('doSave', $key, $value);
                continue;
            }

            $this->model->setAttribute($key, $value);
        }

        $this->model->save();

        event(new ModelSave($this));
    }

    /**
     * Method fired after the Save action is complete.
     * 
     * @return
     */
    protected function afterSave()
    {
        $this->brokenAfterSave = false;

        foreach (\Request::except('_token') as $key => $value) {

            // Could swap this out for model -> getAttribute, then check if we have an attribute or a relation... getRelationValue() is helpful
            if (method_exists($this->model, $key) && is_a(call_user_func_array([$this->model, $key], []), 'Illuminate\Database\Eloquent\Relations\Relation')) {

This code seems to be duplicated across your project.

                $this->saveRelation('afterSave', $key, $value);
            }
        }

        event(new AfterSave($this));
    }

    /**
     * Method fired to Save Relations.
     *
     * @param string $action The current action (either doSave or afterSave)
     * @param string $key
     * @param string $value
     * 
     * @return
     */
    private function saveRelation($action, $key, $value)
    {
        // Could swap this out for model -> getAttribute, then check if we have an attribute or a relation... getRelationValue() is helpful
        if (method_exists($this->model, $key) && is_a(call_user_func_array([$this->model, $key], []), 'Illuminate\Database\Eloquent\Relations\Relation')) {
            foreach ($this->{$action.'Relations'} as $relationship => $method) {
                if (is_a(call_user_func_array([$this->model, $key], []), 'Illuminate\Database\Eloquent\Relations\\'.$relationship)) {
                    $this->model->$key()->$method($value);

                    return;
                }
            }
        }
    }
}