hipanel\components\OrientationStorage

Complexity

Total Complexity

12

Size/Duplication

Total Lines	111
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

8 Methods

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

<?php

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

namespace hipanel\components;

use Yii;
use yii\base\Component;

/**
 * Class OrientationStorage
 *
 * @package hipanel\components
 */
class OrientationStorage extends Component
{
    const ORIENTATION_HORIZONTAL = 'horizontal';
    const ORIENTATION_VERTICAL = 'vertical';

    public $defaultOrientation = self::ORIENTATION_HORIZONTAL;

    /**
     * @var string the cache key that will be used to cache storage values
     */
    public $cacheKey;

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

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

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

It seems like array('orientationStorage', \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()
    {
        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);
                $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
     */
    public function set($route, $orientation)
    {
        $this->ensureStorage();

        $this->storage[$route] = $orientation;
        $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] : $this->defaultOrientation;
    }
}