Glorand\Model\Settings\Traits\HasSettingsField

Complexity

Total Complexity

12

Size/Duplication

Total Lines	96
Duplicated Lines	0 %

Test Coverage

Coverage

93.94%

Importance

Changes	2
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	isPersistSettings()	0	3	1
A	setPersistSettings()	0	3	1
A	getSettingsFieldName()	0	3	1
A	getSettingsValue()	0	8	2
A	hasSettingsField()	0	12	2
A	fixSettingsValue()	0	7	3
A	bootHasSettingsField()	0	4	1
A	settings()	0	3	1

<?php

namespace Glorand\Model\Settings\Traits;

use Glorand\Model\Settings\Contracts\SettingsManagerContract;
use Glorand\Model\Settings\Exceptions\ModelSettingsException;
use Glorand\Model\Settings\Managers\FieldSettingsManager;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Schema;

/**
 * Trait HasSettingsField
 * @package Glorand\Model\Settings\Traits
 * @property array $settings
 * @property string $settingsFieldName
 * @property boolean $persistSettings
 */
trait HasSettingsField
{
    use HasSettings;

    private $persistSettings = null;

    protected static function bootHasSettingsField()
    {
        static::saving(function (self $model) {
            $model->fixSettingsValue();
        });
    }

    /**
     * @return \Glorand\Model\Settings\Contracts\SettingsManagerContract
     * @throws ModelSettingsException
     */
    public function settings(): SettingsManagerContract
    {
        return new FieldSettingsManager($this);
    }

    public function fixSettingsValue()
    {
        $settingsFieldName = $this->getSettingsFieldName();
        $attributes = $this->getAttributes();
        if (Arr::has($attributes, $settingsFieldName)) {
            if (is_array($this->$settingsFieldName)) {
                $this->$settingsFieldName = json_encode($this->$settingsFieldName);
            }
        }
    }

    /**
     * @return array
     * @throws ModelSettingsException
     */
    public function getSettingsValue(): array
    {
        $settingsFieldName = $this->getSettingsFieldName();
        if (!$this->hasSettingsField()) {
            throw new ModelSettingsException("Unknown field ($settingsFieldName) on table {$this->getTable()}");
        }

        return json_decode($this->getAttributeValue($settingsFieldName) ?? '[]', true);
    }

    /**
     * @return string
     */
    public function getSettingsFieldName(): string
    {
        return $this->settingsFieldName ?? config('model_settings.settings_field_name');
    }

    /**
     * @return bool
     */
    public function isPersistSettings(): bool
    {
        return boolval($this->persistSettings ?? config('model_settings.settings_persistent'));
    }

    /**
     * @param bool $val
     */
    public function setPersistSettings(bool $val = true)
    {
        $this->persistSettings = $val;
    }


    /**
     * @return mixed
     * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
     */
    private function hasSettingsField()
    {
        try {
            return cache()->remember(
                config('model_settings.settings_table_cache_prefix') . '::has_field',
                now()->addDays(1),
                function () {
                    return Schema::hasColumn($this->getTable(), $this->getSettingsFieldName());
                }
            );
        } catch (\Exception $e) {
            throw new ModelSettingsException("Cache: " . $e->getMessage());
        }
    }

    abstract public function getTable();

    abstract public function getAttributes();

    abstract public function getAttributeValue($key);
}