LaravelRUS / SleepingOwlAdmin

src/Traits/ElementSaveRelation.php

<?php

namespace SleepingOwl\Admin\Traits;

use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\Model;
use SleepingOwl\Admin\Contracts\Form\Element\HasSyncCallback;
use SleepingOwl\Admin\Contracts\Form\Element\MustDeleteRelatedItem;
use SleepingOwl\Admin\Contracts\Form\Element\Taggable;

trait ElementSaveRelation
{
    /**
     * @return array|string
     */
    public function getValueFromModel()
    {
        $value = parent::getValueFromModel();

        if (is_array($value)) {
            foreach ($value as $key => $val) {
                $value[$key] = $val;
            }
        }

        if ($value instanceof Collection && $value->count() > 0) {
            $value = $value->pluck($value->first()->getKeyName())->all();
        }

        if ($value instanceof Collection) {
            $value = $value->toArray();
        }

        return $value;
    }

    /**
     * @param \Illuminate\Http\Request $request
     *
     * @return void
     */
    public function save(\Illuminate\Http\Request $request)
    {
        if (is_null($this->getModelForOptions())) {

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

            parent::save($request);
        }
    }

    /**
     * @param \Illuminate\Http\Request $request
     *
     * @return void
     */
    public function afterSave(\Illuminate\Http\Request $request)
    {
        if (is_null($this->getModelForOptions())) {
            return;
        }

        if ($this->isValueSkipped()) {

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

            return;
        }

        $attribute = $this->getModelAttributeKey();

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

        if (is_null($request->input($this->getPath()))) {

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

            $values = [];
        } else {
            $values = $this->getValueFromModel();
        }

        $relation = $this->getModel()->{$attribute}();

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

        if ($relation instanceof \Illuminate\Database\Eloquent\Relations\BelongsToMany) {
            $this->syncBelongsToManyRelation($relation, $values);

It seems like $values can also be of type string; however, parameter $values of SleepingOwl\Admin\Traits\ElementSaveRelation::syncBelongsToManyRelation() does only seem to accept array, maybe add an additional type check?

        } elseif ($relation instanceof \Illuminate\Database\Eloquent\Relations\HasMany) {
            $this->deleteOldItemsFromHasManyRelation($relation, $values);

It seems like $values can also be of type string; however, parameter $values of SleepingOwl\Admin\Traits\ElementSaveRelation::deleteOldItemsFromHasManyRelation() does only seem to accept array, maybe add an additional type check?

            $this->attachItemsToHasManyRelation($relation, $values);

It seems like $values can also be of type string; however, parameter $values of SleepingOwl\Admin\Traits\ElementSaveRelation::attachItemsToHasManyRelation() does only seem to accept array, maybe add an additional type check?

        }
    }

    /**
     * @param \Illuminate\Database\Eloquent\Relations\BelongsToMany $relation
     * @param array $values
     *
     * @return void
     */
    protected function syncBelongsToManyRelation(
        \Illuminate\Database\Eloquent\Relations\BelongsToMany $relation,
        array $values
    ) {
        if ($this instanceof Taggable) {
            foreach ($values as $i => $value) {
                if (! array_key_exists($value, $this->getOptions()) && $this->isTaggable()) {

The method getOptions() does not exist on SleepingOwl\Admin\Contracts\Form\Element\Taggable. Since it exists in all sub-types, consider adding an abstract or default implementation to SleepingOwl\Admin\Contracts\Form\Element\Taggable.

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

                    $model = clone $this->getModelForOptions();

The method getModelForOptions() does not exist on SleepingOwl\Admin\Contracts\Form\Element\Taggable. Since it exists in all sub-types, consider adding an abstract or default implementation to SleepingOwl\Admin\Contracts\Form\Element\Taggable.

                    $model->{$this->getDisplay()} = $value;

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

The method getDisplay() does not exist on SleepingOwl\Admin\Contracts\Form\Element\Taggable. Since it exists in all sub-types, consider adding an abstract or default implementation to SleepingOwl\Admin\Contracts\Form\Element\Taggable.

                    $model->save();

                    $values[$i] = $model->getKey();
                }
            }
        }

        if (($this instanceof HasSyncCallback) && is_callable($callback = $this->getSyncCallback())) {
            $callbackModel = $this->getModel();

The method getModel() does not exist on SleepingOwl\Admin\Contracts\Form\Element\HasSyncCallback. Since it exists in all sub-types, consider adding an abstract or default implementation to SleepingOwl\Admin\Contracts\Form\Element\HasSyncCallback.

            $callback($values, $callbackModel);

            return;
        }

        $relation->sync($values);
    }

    /**
     * @param \Illuminate\Database\Eloquent\Relations\HasMany $relation
     * @param array $values
     */
    protected function deleteOldItemsFromHasManyRelation(
        \Illuminate\Database\Eloquent\Relations\HasMany $relation,
        array $values
    ) {
        $items = $relation->get();

        foreach ($items as $item) {
            if (! in_array($item->getKey(), $values)) {
                if (($this instanceof MustDeleteRelatedItem) && $this->isDeleteRelatedItem()) {
                    $item->delete();
                } else {
                    $item->{$this->getForeignKeyNameFromRelation($relation)} = null;

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

                    $item->save();
                }
            }
        }
    }

    /**
     * @param \Illuminate\Database\Eloquent\Relations\HasMany $relation
     * @param array $values
     */
    protected function attachItemsToHasManyRelation(
        \Illuminate\Database\Eloquent\Relations\HasMany $relation,
        array $values
    ) {
        foreach ($values as $i => $value) {
            /** @var Model $model */
            $model = clone $this->getModelForOptions();
            $item = $model->find($value);

            if (is_null($item)) {
                if (! ($this instanceof Taggable) && $this->isTaggable()) {

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

                    continue;
                }

                $model->{$this->getDisplay()} = $value;
                $item = $model;
            }

            $relation->save($item);
        }
    }
}