SleepingOwl\Admin\Form\Related\Elements

Complexity

Total Complexity

86

Size/Duplication

Total Lines	685
Duplicated Lines	0 %

Importance

Changes

0

41 Methods

Rating	Name	Duplication	Size	Complexity
A	setLimit()	0	5	1
A	__construct()	0	9	1
A	forEachElement()	0	4	2
A	getValidationRulesFromElements()	0	7	1
A	checkRelationOfModel()	0	11	5
A	setInstance()	0	3	1
A	getValidationMessagesForElements()	0	7	1
A	setLabel()	0	5	1
A	afterSave()	0	17	2
A	makeValidationAttribute()	0	3	1
A	safeFillModel()	0	15	4
A	buildGroupsCollection()	0	12	3
A	safeCreateModel()	0	3	1
A	initialize()	0	10	2
A	setModel()	0	7	2
A	addOrGetRelated()	0	9	3
A	disableCreation()	0	5	1
A	modifyValidationParameters()	0	8	2
A	initializeElement()	0	13	4
A	emptyElement()	0	21	3
A	getCompositeKey()	0	15	4
A	getRelation()	0	3	1
B	createGroup()	0	35	8
A	getRequestData()	0	7	2
A	toArray()	0	12	1
A	setRelationName()	0	5	1
A	initializeRemoveEntities()	0	13	2
A	exceedsLimit()	0	7	2
A	initializeElements()	0	4	1
A	getNewElements()	0	3	1
A	modifyQuery()	0	5	1
A	getRelatedValuesFromRequestData()	0	27	5
A	setGroupLabel()	0	5	1
A	getElementValue()	0	19	3
A	formatElementName()	0	3	1
A	flatNamedElements()	0	13	3
A	save()	0	7	1
A	cloneElements()	0	8	1
A	loadRelationValues()	0	14	4
A	getEmptyRelation()	0	3	1
A	getModelClassForElements()	0	3	1

<?php

namespace SleepingOwl\Admin\Form\Related;

use Illuminate\Http\Request;
use Admin\Contracts\HasFakeModel;
use Illuminate\Support\Collection;
use Illuminate\Database\Eloquent\Model;
use SleepingOwl\Admin\Form\FormElements;
use KodiComponents\Support\HtmlAttributes;
use SleepingOwl\Admin\Form\Columns\Columns;
use SleepingOwl\Admin\Contracts\Initializable;
use SleepingOwl\Admin\Form\Element\NamedFormElement;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Database\Eloquent\Relations\HasOneOrMany;
use Illuminate\Database\Eloquent\Relations\BelongsToMany;
use Illuminate\Database\Eloquent\RelationNotFoundException;

abstract class Elements extends FormElements
{
    use HtmlAttributes, HasUniqueValidation, ManipulatesRequestRelations;

    protected $view = 'form.element.related.elements';

    const NEW_ITEM = 'new';

    const REMOVE = 'remove';

    /**
     * How many items can be created.
     *
     * @var int
     */
    protected $limit;

    /**
     * Relation name of the model.
     *
     * @var string
     */
    protected $relationName;

    /**
     * New relations counter.
     *
     * @var int
     */
    protected $new = 0;

    /**
     * @var string
     */
    protected $groupLabel;

    /**
     * Main label of dynamic form.
     *
     * @var string
     */
    protected $label;

    /**
     * Loaded related values.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $relatedValues;

    /**
     * @var \Illuminate\Database\Eloquent\Model
     */
    protected $instance;

    protected $stubElements;

    /**
     * Elements that are about to be removed.
     *
     * @var \Illuminate\Support\Collection
     */
    protected $toRemove;

    protected $unique;

    /**
     * @var
     */
    protected $groups;

    protected $queryCallbacks = [];

    public function __construct(string $relationName, array $elements = [])
    {
        $this->toRemove = collect();
        $this->groups = collect();
        $this->relatedValues = collect();
        parent::__construct($elements);

        $this->setRelationName($relationName);
        $this->initializeRemoveEntities();
    }

    /**
     * @param int $limit
     *
     * @return $this
     */
    public function setLimit(int $limit): self
    {
        $this->limit = $limit;

        return $this;
    }

    public function modifyQuery(callable $callback): self
    {
        $this->queryCallbacks[] = $callback;

        return $this;
    }

    public function setLabel(string $label): self
    {
        $this->label = $label;

        return $this;
    }

    public function initialize()
    {
        parent::initialize();
        $this->checkRelationOfModel();

        $this->stubElements = $this->getNewElements();
        $this->forEachElement($this->stubElements, function ($element) {
            $element->setDefaultValue(null);
            if (! $element instanceof HasFakeModel) {
                $element->setPath('');
            }
        });
    }

    protected function initializeRemoveEntities()
    {
        $key = $this->relationName.'.'.static::REMOVE;
        $newKey = 'remove_'.$this->relationName;
        $request = request();

        $remove = $request->input($key, $request->old($key, []));
        if ($remove) {
            $request->merge([$newKey => $remove]);
        }

        $this->toRemove = collect($request->input($newKey, $request->old($newKey, [])));
        $request->replace($request->except($key));
    }

    /**
     * @return void
     */
    public function initializeElements()
    {
        $this->getElements()->each(function ($el) {
            $this->initializeElement($el);
        });
    }

    public function initializeElement($element)
    {
        if ($element instanceof Initializable) {
            $element->initialize();
        }

        if ($element instanceof HasFakeModel) {
            $element->setFakeModel($this->getModel());
        }

        if ($element instanceof \SleepingOwl\Admin\Contracts\Form\Columns\ColumnInterface) {
            $element->getElements()->each(function ($el) {
                $this->initializeElement($el);
            });
        }
    }

    /**
     * @param $item
     *
     * @param array $columns
     *
     * @return string
     */
    protected function getCompositeKey($item, array $columns): string
    {
        $primaries = [];
        if ($item instanceof Model) {
            $item = $item->getAttributes();
        }

        foreach ($columns as $name) {
            // Only existing keys must be in primaries array
            if (array_key_exists($name, $item)) {
                $primaries[] = $item[$name];
            }
        }

        return implode('_', $primaries);
    }

    protected function makeValidationAttribute(string $name): string
    {
        return $this->relationName.'.*.'.$name;
    }

    protected function getNewElements(): Collection
    {
        return $this->cloneElements($this);
    }

    protected function cloneElements(FormElements $element)
    {
        $elements = clone $element->getElements()->map(function ($element) {
            return clone $element;
        });

        return $elements->map(function ($element) {
            return $this->emptyElement($element);
        });
    }

    protected function emptyElement($element)
    {
        $el = clone $element;
        if ($el instanceof \SleepingOwl\Admin\Form\Columns\Columns) {
            $col = new Columns();
            $columns = $el->getElements();
            $col->setElements((clone $columns)->map(function ($column) {
                return $this->emptyElement($column);
            })->all());

            return $col;
        }

        if ($el instanceof FormElements) {
            $el->setElements($this->cloneElements($el)->all());
        } else {
            $el->setDefaultValue(null);
            $el->setValueSkipped(true);
        }

        return $el;
    }

    /**
     * @param Model $model
     *
     * @return FormElements|void
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     */
    public function setModel(Model $model)
    {
        parent::setModel($model);

        if ($model->exists) {
            $this->setInstance($model);
            $this->loadRelationValues();
        }
    }

    public function setInstance($instance)
    {
        $this->instance = $instance;
    }

    /**
     * @throws \InvalidArgumentException
     * @throws \Illuminate\Database\Eloquent\RelationNotFoundException
     */
    protected function checkRelationOfModel()
    {
        $model = $this->getModel();
        $class = get_class($model);
        if (! method_exists($model, $this->relationName)) {
            throw new RelationNotFoundException("Relation {$this->relationName} doesn't exist on {$class}");
        }

        $relation = $model->{$this->relationName}();
        if (! ($relation instanceof BelongsToMany) && ! ($relation instanceof HasOneOrMany) && ! ($relation instanceof \Illuminate\Database\Eloquent\Relations\BelongsTo)) {
            throw new \InvalidArgumentException("Relation {$this->relationName} of model {$class} must be instance of HasMany, BelongsTo or BelongsToMany");
        }
    }

    /**
     * Sets relation name property.
     *
     * @param string
     *
     * @return Elements
     */
    public function setRelationName(string $name): self
    {
        $this->relationName = $name;

        return $this;
    }

    /**
     * @throws \Illuminate\Database\Eloquent\ModelNotFoundException
     */
    protected function loadRelationValues()
    {
        if (! $this->instance) {
            throw new ModelNotFoundException("Model {$this->getModel()} wasn't found for loading relation");
        }

        $query = $this->getRelation();
        if (count($this->queryCallbacks) > 0) {
            foreach ($this->queryCallbacks as $callback) {
                $callback($query);
            }
        }

        $this->relatedValues = $this->retrieveRelationValuesFromQuery($query);
    }

    /**
     * @return array
     */
    protected function getRequestData(): array
    {
        $request = request();

        $old = $request->old($this->relationName, false);

false of type false is incompatible with the type array|null|string expected by parameter $default of Illuminate\Http\Request::old().

        return $old ?: $request->get($this->relationName, []);
    }

    protected function buildGroupsCollection()
    {
        $old = false;
        $relatedValues = $this->relatedValues;

        if (count($data = $this->getRequestData()) !== 0) {
            $old = true;
            $relatedValues = $this->getRelatedValuesFromRequestData($data);
        }

        foreach ($relatedValues as $key => $item) {
            $this->groups->push($this->createGroup($item, $old, $key));
        }
    }

    protected function getRelatedValuesFromRequestData(array $values): Collection
    {
        $collection = collect();
        foreach ($values as $key => $attributes) {
            if ($key === static::REMOVE) {
                // If key is about to be removed we need to save it and show later in rendered form. But we don't
                // need to put value with this relation in collection of elements, that's why we need to continue the
                // loop
                $this->toRemove = collect($attributes);
                continue;
            }

            if (strpos($key, static::NEW_ITEM) !== false) {
                // If item is new, wee need to implement counter of new items to prevent duplicates,
                // check limits and etc.
                $this->new++;
            }

            if ($this->relatedValues->has($key)) {
                $attributes = $this->safeFillModel($this->relatedValues->get($key), $attributes);
            }

            // Finally, we put filled model values into collection of future groups
            $collection->put($key, $attributes);
        }

        return $collection;
    }

    protected function createGroup($attributes, $old = false, $key = null): Group
    {
        $model = $attributes instanceof Model ? $attributes
            : $this->safeCreateModel($this->getModelClassForElements(), $attributes);
        $group = new Group($model);

        if ($this->groupLabel) {
            $group->setLabel($this->groupLabel);
        }

        if ($key) {
            $group->setPrimary($key);
        }

        $this->forEachElement($elements = $this->getNewElements(), function (NamedFormElement $el) use ($model, $key, $old) {
            // Setting default value, name and model for element with name attribute
            $el->setDefaultValue($el->prepareValue($this->getElementValue($model, $el)));
            $el->setName(sprintf('%s[%s][%s]', $this->relationName, $key ?? $model->getKey(), $this->formatElementName($el->getName())));
            $el->setModel($model);

            if ($old && strpos($el->getPath(), '->') === false && ! ($el instanceof HasFakeModel)) {
                // If there were old values (validation fail, etc.) each element must have different path to get the old
                // value. If we don't do it, there will be collision if two elements with same name present in main form
                // and related form. For example: we have "Company" and "Shop" models with field "name" and include HasMany
                // form with company's shops inside "Companies" section. There will be collisions of "name" if validation
                // fails, and each "shop"-form will have "company->name" value inside "name" field.
                $el->setPath($el->getName());
            }
        });

        foreach ($elements as $el) {
            $group->push($el);
        }

        return $group;
    }

    /**
     * Returns value from model for given element.
     *
     * @param \Illuminate\Database\Eloquent\Model $model
     * @param NamedFormElement $el
     *
     * @return mixed|null
     */
    protected function getElementValue(Model $model, NamedFormElement $el)
    {
        $attribute = $el->getModelAttributeKey();
        if (strpos($attribute, '->') === false) {
            return $model->getAttribute($attribute);
        }

        // Parse json attributes
        $casts = collect($model->getCasts());
        $jsonParts = collect(explode('->', $attribute));
        $cast = $casts->get($jsonParts->first(), false);

        if (! in_array($cast, ['json', 'array'])) {
            return;
        }

        $jsonAttr = $model->{$jsonParts->first()};

        return array_get($jsonAttr, $jsonParts->slice(1)->implode('.'));

The function array_get() has been deprecated: Arr::get() should be used directly instead. Will be removed in Laravel 5.9.

    }

    protected function formatElementName(string $name)
    {
        return preg_replace("/{$this->relationName}\[[\w]+\]\[(.+?)\]/", '$1', $name);
    }

    /**
     * Applies given callback to every element of form.
     *
     * @param \Illuminate\Support\Collection $elements
     * @param $callback
     */
    protected function forEachElement(Collection $elements, $callback)
    {
        foreach ($this->flatNamedElements($elements) as $element) {
            $callback($element);
        }
    }

    /**
     * Returns flat collection of elements in form ignoring everything but NamedFormElement. Works recursive.
     *
     * @param \Illuminate\Support\Collection $elements
     *
     * @return mixed
     */
    protected function flatNamedElements(Collection $elements)
    {
        return $elements->reduce(function (Collection $initial, $element) {
            if ($element instanceof NamedFormElement) {
                // Is it what we're looking for? if so we'll push it to final collection
                $initial->push($element);
            } elseif ($element instanceof FormElements) {
                // Go deeper and repeat everything again
                return $initial->merge($this->flatNamedElements($element->getElements()));
            }

            return $initial;
        }, collect());
    }

    protected function safeCreateModel(string $modelClass, array $attributes = []): Model
    {
        return $this->safeFillModel(new $modelClass, $attributes);
    }

    protected function safeFillModel(Model $model, array $attributes = []): Model
    {
        foreach ($attributes as $attribute => $value) {
            // Prevent numeric attribute name. If it is, so it's an error
            if (is_numeric($attribute)) {
                continue;
            }

            try {
                $model->setAttribute($attribute, $value);
            } catch (\Throwable $exception) {

Consider adding a comment why this CATCH block is empty.

            }
        }

        return $model;
    }

    /**
     * Returns empty relation of model.
     *
     * @return \Illuminate\Database\Eloquent\Relations\Relation
     */
    protected function getEmptyRelation()
    {
        return $this->emptyRelation ?? $this->emptyRelation = $this->getModel()->{$this->relationName}();

The property emptyRelation does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

    }

    protected function getRelation(): \Illuminate\Database\Eloquent\Relations\Relation
    {
        return $this->instance->{$this->relationName}();
    }

    /**
     * Saves request.
     *
     * @param \Illuminate\Http\Request $request
     */
    public function save(Request $request)
    {
        $connection = app(\Illuminate\Database\ConnectionInterface::class);
        $this->prepareRelatedValues($this->getRequestData());

        $this->transactionLevel = $connection->transactionLevel();

The property transactionLevel does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly.

        $connection->beginTransaction();
        // Nothing to do here...
    }

    public function getValidationRulesFromElements(array $rules = []): array
    {
        $this->flatNamedElements($this->getElements())->each(function ($element) use (&$rules) {
            $rules += $this->modifyValidationParameters($element->getValidationRules());
        });

        return $rules;
    }

    public function getValidationMessagesForElements(array $messages = []): array
    {
        $this->flatNamedElements($this->getElements())->each(function ($element) use (&$messages) {
            $messages += $this->modifyValidationParameters($element->getValidationMessages());
        });

        return $messages;
    }

    public function afterSave(Request $request)
    {
        $connection = app(\Illuminate\Database\ConnectionInterface::class);

        try {
            // By this time getModel method will always return existed model object, not empty
            // so wee need to fresh it, because if it's new model creating relation will throw
            // exception 'call relation method on null'
            $this->setInstance($this->getModel());
            $this->proceedSave($request);
            $connection->commit();

            $this->prepareRequestToBeCopied($request);
        } catch (\Throwable $exception) {
            $connection->rollBack($this->transactionLevel);

The call to Illuminate\Database\ConnectionInterface::rollBack() has too many arguments starting with $this->transactionLevel.

            throw $exception;
        }
    }

    /**
     * Returns model class for each element in form.
     *
     * @return string
     */
    protected function getModelClassForElements(): string
    {
        return get_class($this->getModelForElements());
    }

    protected function modifyValidationParameters(array $parameters): array
    {
        $result = [];
        foreach ($parameters as $name => $parameter) {
            $result["{$this->relationName}.*.{$name}"] = $parameter;
        }

        return $result;
    }

    /**
     * Get the instance as an array.
     *
     * @return array
     */
    public function toArray()
    {
        $this->buildGroupsCollection();

        return parent::toArray() + [
                'stub'             => $this->stubElements,
                'name'             => $this->relationName,
                'label'            => $this->label,
                'groups'           => $this->groups,
                'remove'           => $this->toRemove,
                'newEntitiesCount' => $this->new,
                'limit'            => $this->limit,
            ];
    }

    /**
     * @param string $groupLabel
     *
     * @return Elements
     */
    public function setGroupLabel(string $groupLabel): self
    {
        $this->groupLabel = $groupLabel;

        return $this;
    }

    /**
     * Checks if count of relations to be created exceeds limit.
     *
     * @return int
     */
    public function exceedsLimit()
    {
        if ($this->limit === null) {
            return false;

The expression return false returns the type false which is incompatible with the documented return type integer.

        }

        return $this->relatedValues->count() >= $this->limit;

The expression return $this->relatedValues->count() >= $this->limit returns the type boolean which is incompatible with the documented return type integer.

    }

    /**
     * Appends fresh related model if total count is not exceeding limit.
     *
     * @param $key
     *
     * @return $this
     */
    protected function addOrGetRelated($key)
    {
        $related = $this->relatedValues->get($key) ?? $this->getFreshModelForElements();

        if (! $related->exists && ! $this->exceedsLimit()) {
            $this->relatedValues->put($key, $related);
        }

        return $related;

The expression return $related also could return the type Illuminate\Database\Eloquent\Model which is incompatible with the documented return type SleepingOwl\Admin\Form\Related\Elements.

    }

    /**
     * @return Elements
     */
    public function disableCreation(): self
    {
        $this->setLimit(0);

        return $this;
    }

    abstract protected function retrieveRelationValuesFromQuery($query): Collection;

    /**
     * Returns model for each element in form.
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    abstract protected function getModelForElements(): Model;

    /**
     * Returns fresh instance of model for each element in form.
     *
     * @return \Illuminate\Database\Eloquent\Model
     */
    abstract protected function getFreshModelForElements(): Model;

    /**
     * Proceeds saving related values after all validations passes.
     *
     * @param \Illuminate\Http\Request $request
     *
     * @return mixed
     */
    abstract protected function proceedSave(Request $request);

    /**
     * Here you must add all new relations to main collection and etc.
     *
     * @param array $data
     *
     * @return mixed
     */
    abstract protected function prepareRelatedValues(array $data);
}