glorand / laravel-model-settings

src/Managers/AbstractSettingsManager.php

<?php

namespace Glorand\Model\Settings\Managers;

use Glorand\Model\Settings\Contracts\SettingsManagerContract;
use Glorand\Model\Settings\Exceptions\ModelSettingsException;
use Glorand\Model\Settings\Traits\HasSettings;
use Illuminate\Database\Eloquent\Model;

/**
 * Class AbstractSettingsManager
 * @package Glorand\Model\Settings\Managers
 */
abstract class AbstractSettingsManager implements SettingsManagerContract
{
    /** @var \Illuminate\Database\Eloquent\Model */
    protected $model;

    /**
     * AbstractSettingsManager constructor.
     * @param \Illuminate\Database\Eloquent\Model $model
     * @throws \Glorand\Model\Settings\Exceptions\ModelSettingsException
     */
    public function __construct(Model $model)
    {
        $this->model = $model;
        if (!in_array(HasSettings::class, class_uses_recursive($this->model))) {
            throw new ModelSettingsException('Wrong model, missing HasSettings trait.');
        }
    }

    /**
     * @return array
     */
    public function all(): array
    {
        return $this->model->getSettingsValue();
    }

    /**
     * @param string $path
     * @return bool
     */
    public function has(string $path): bool
    {
        return array_has($this->all(), $path);
    }

    /**
     * @param string|null $path
     * @param null $default

Are you sure the doc-type for parameter $default is correct as it would always require null to be passed?

     * @return array|mixed
     */
    public function get(string $path = null, $default = null)
    {
        return $path ? array_get($this->all(), $path, $default) : $this->all();
    }

    /**
     * @param iterable|null $paths
     * @param null $default
     * @return iterable
     */
    public function getMultiple(iterable $paths = null, $default = null): iterable
    {
        $values = [];
        foreach ($paths as $path) {
            $values[$path] = $this->get($path, $default);
        }

        return $values;
    }

    /**
     * @param string $path
     * @param mixed $value
     * @return \Glorand\Model\Settings\Contracts\SettingsManagerContract
     */
    public function update(string $path, $value): SettingsManagerContract
    {
        return $this->set($path, $value);
    }

    /**
     * @return \Glorand\Model\Settings\Contracts\SettingsManagerContract
     */
    public function clear(): SettingsManagerContract
    {
        return $this->delete();
    }

    /**
     * @param iterable $values
     * @return \Glorand\Model\Settings\Contracts\SettingsManagerContract
     */
    public function setMultiple(iterable $values): SettingsManagerContract
    {
        $settings = $this->all();
        foreach ($values as $path => $value) {
            array_set($settings, $path, $value);
        }

        return $this->apply($settings);
    }
}