hipanel\components\UiOptionsStorage

Complexity

Total Complexity

17

Size/Duplication

Total Lines	130
Duplicated Lines	17.69 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	2
A	getCache()	0	4	1
A	getSettingsStorage()	0	4	1
A	ensureStorage()	13	13	3
A	saveStorage()	0	5	1
A	cache()	0	4	1
A	set()	0	7	1
A	get()	0	6	2
A	getDefaultOption()	10	10	3
A	getOption()	0	4	1
A	getAllUiOptions()	0	4	1

<?php
/**
 * HiPanel core package
 *
 * @link      https://hipanel.com/
 * @package   hipanel-core
 * @license   BSD-3-Clause
 * @copyright Copyright (c) 2014-2019, HiQDev (http://hiqdev.com/)
 */

namespace hipanel\components;

use hiqdev\thememanager\models\OrientationInterface;
use Yii;
use yii\base\Component;

/**
 * Class UiOptionsStorage.
 */
class UiOptionsStorage extends Component implements OrientationInterface
{
    /**
     * @var string the cache key that will be used to cache storage values
     */
    public $cacheKey;

    /**
     * @var string
     */
    public $settingsStorageKey = 'uiOptions';

    /**
     * @var array
     */
    protected $storage;

    /**
     * {@inheritdoc}
     */
    public function init()
    {
        if (!isset($this->cacheKey)) {
            $this->cacheKey = ['uiOptionsStorage', Yii::$app->user->id];

It seems like array('uiOptionsStorage', \Yii::$app->user->id) of type array<integer,?,{"0":"string","1":"?"}> is incompatible with the declared type string of property $cacheKey.

        }
    }

    /**
     * @return \yii\caching\Cache
     */
    protected function getCache()
    {
        return Yii::$app->getCache();
    }

    /**
     * @return SettingsStorageInterface
     */
    protected function getSettingsStorage()
    {
        return Yii::$app->get('settingsStorage');
    }

    /**
     * Ensures that [[storage]] contains actual orientations storage.
     *
     * @return array
     */
    private function ensureStorage()

This method seems to be duplicated in your project.

    {
        if (!isset($this->storage)) {
            $this->storage = $this->getCache()->get($this->cacheKey);

It seems like $this->getCache()->get($this->cacheKey) of type * is incompatible with the declared type array of property $storage.

            if ($this->storage === false) {
                $this->storage = $this->getSettingsStorage()->getBounded($this->settingsStorageKey);

It seems like $this->getSettingsStorage()->getBounded($this->settingsStorageKey) of type * is incompatible with the declared type array of property $storage.

                $this->cache();
            }
        }

        return $this->storage;
    }

    /**
     * Saves current [[storage]].
     */
    protected function saveStorage()
    {
        $this->getSettingsStorage()->setBounded($this->settingsStorageKey, $this->storage);
        $this->cache();
    }

    /**
     * Caches current [[storage]].
     */
    protected function cache()
    {
        $this->getCache()->set($this->cacheKey, $this->storage, 86400); // 1 day
    }

    /**
     * Sets orientation for the $route.
     *
     * @param string $route
     * @param string $orientation

There is no parameter named $orientation. Was it maybe removed?

     */
    public function set($route, $options = [])
    {
        $this->ensureStorage();

        $this->storage[$route] = $options;
        $this->saveStorage();
    }

    /**
     * Gets orientation for the $route.
     *
     * @param $route
     * @return string
     */
    public function get($route)
    {
        $this->ensureStorage();

        return isset($this->storage[$route]) ? $this->storage[$route] : null;
    }

    /**
     * @return string
     */
    public function getDefaultOption()

This method seems to be duplicated in your project.

    {
        $settings = Yii::$app->themeManager->getSettings();

        if (property_exists($settings, 'filterOrientation') && in_array($settings->filterOrientation, [self::ORIENTATION_HORIZONTAL, self::ORIENTATION_VERTICAL], true)) {
            return $settings->filterOrientation;
        } else {
            return self::ORIENTATION_HORIZONTAL;
        }
    }

    public function getOption($option)
    {
        return $this->get(Yii::$app->request->pathInfo)[$option];
    }

    public function getAllUiOptions()
    {
        return $this->getSettingsStorage()->getBounded($this->settingsStorageKey);
    }
}