ThemeSettingsStorage::get() - Code Metrics - Inspection of "Fixed never-reaching cacheKey building condition" - hiqdev/hipanel-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 732fc9...380ff7 )

by Dmitry

created 2016-11-01 16:30 UTC

ThemeSettingsStorage::get() A

↳ Parent: ThemeSettingsStorage

Complexity

Conditions	3
Paths	3

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	3
Bugs	0	Features	0

Metric	Value
cc	3
eloc	8
c	3
b	0
f	0
nc	3
nop	0
dl	0
loc	15
ccs	0
cts	12
cp	0
crap	12
rs	9.4285

<?php

namespace hipanel\components;

use hiqdev\thememanager\storage\SettingsStorageInterface;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php
use Yii;
use yii\base\Component;
use yii\base\Model;
use yii\caching\Cache;
.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

class ThemeSettingsStorage extends Component implements SettingsStorageInterface
{
    /**
     * @return SettingsStorage
     */
    protected function getStorage()
    {
        return Yii::$app->get('settingsStorage');
    }

    /**
     * @var string
     */
    public $cacheKey;

    public function init()
    {
        if ($this->cacheKey === null && !Yii::$app->user->getIsGuest()) {
            $this->cacheKey = ['themeSettingsStorage', Yii::$app->user->id];

        }
    }

    /**
     * @return Cache
     */
    protected function getCache()
    {
        return Yii::$app->get('cache');
    }

    /**
     * @inheritdoc
     */
    public function set(Model $model)
    {
        if (Yii::$app->user->getIsGuest()) {
            return;
        }

        $data = $model->toArray();

        $this->getStorage()->setBounded('theme', $data);
        $this->setToCache($data);
    }

    /**
     * @return mixed
     */
    public function get()
    {
        if (Yii::$app->user->getIsGuest()) {
            return [];
        }

        if (($cached = $this->getFromCache()) !== false) {
            return $cached;
        }

        $storage = $this->getStorage()->getBounded('theme');
        $this->setToCache($storage);

        return $storage;
    }

    private function getFromCache()
    {
        if ($this->cacheKey === null) {
            return false;
        }

        return $this->getCache()->get($this->cacheKey);
    }

    private function setToCache($data)
    {
        if ($this->cacheKey !== null) {
            return false;
        }

        return $this->getCache()->set($this->cacheKey, $data, 86400); // 1 day
    }
}


1			<?php
2
3			namespace hipanel\components;
4
5			use hiqdev\thememanager\storage\SettingsStorageInterface;
			0 ignored issues – show Bug introduced 2016-10-19 12:37 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `hipanel\components\SettingsStorageInterface`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
6			use Yii;
7			use yii\base\Component;
8			use yii\base\Model;
9			use yii\caching\Cache;
			0 ignored issues – show Bug introduced 2016-10-19 12:37 UTC by Report Bug Copy Issue Report This use statement conflicts with another class in this namespace, `hipanel\components\Cache`. Let’s assume that you have a directory layout like this: . \|-- OtherDir \| \|-- Bar.php \| `-- Foo.php `-- SomeDir `-- Foo.php and let’s assume the following content of `Bar.php`: // Bar.php namespace OtherDir; use SomeDir\Foo; // This now conflicts the class OtherDir\Foo If both files `OtherDir/Foo.php` and `SomeDir/Foo.php` are loaded in the same runtime, you will see a PHP error such as the following: PHP Fatal error: Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php However, as `OtherDir/Foo.php` does not necessarily have to be loaded and the error is only triggered if it is loaded before `OtherDir/Bar.php`, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias: // Bar.php namespace OtherDir; use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore. Loading history...
10
11			class ThemeSettingsStorage extends Component implements SettingsStorageInterface
12			{
13			/**
14			* @return SettingsStorage
15			*/
16			protected function getStorage()
17			{
18			return Yii::$app->get('settingsStorage');
19			}
20
21			/**
22			* @var string
23			*/
24			public $cacheKey;
25
26			public function init()
27			{
28			if ($this->cacheKey === null && !Yii::$app->user->getIsGuest()) {
29			$this->cacheKey = ['themeSettingsStorage', Yii::$app->user->id];
			0 ignored issues – show Documentation Bug introduced 2016-10-19 12:37 UTC by Report Bug Copy Issue Report It seems like `array('themeSettingsStor..., \Yii::$app->user->id)` of type `array<integer,?,{"0":"string","1":"?"}>` is incompatible with the declared type `string` of property `$cacheKey`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
30			}
31			}
32
33			/**
34			* @return Cache
35			*/
36			protected function getCache()
37			{
38			return Yii::$app->get('cache');
39			}
40
41			/**
42			* @inheritdoc
43			*/
44			public function set(Model $model)
45			{
46			if (Yii::$app->user->getIsGuest()) {
47			return;
48			}
49
50			$data = $model->toArray();
51
52			$this->getStorage()->setBounded('theme', $data);
53			$this->setToCache($data);
54			}
55
56			/**
57			* @return mixed
58			*/
59			public function get()
60			{
61			if (Yii::$app->user->getIsGuest()) {
62			return [];
63			}
64
65			if (($cached = $this->getFromCache()) !== false) {
66			return $cached;
67			}
68
69			$storage = $this->getStorage()->getBounded('theme');
70			$this->setToCache($storage);
71
72			return $storage;
73			}
74
75			private function getFromCache()
76			{
77			if ($this->cacheKey === null) {
78			return false;
79			}
80
81			return $this->getCache()->get($this->cacheKey);
82			}
83
84			private function setToCache($data)
85			{
86			if ($this->cacheKey !== null) {
87			return false;
88			}
89
90			return $this->getCache()->set($this->cacheKey, $data, 86400); // 1 day
91			}
92			}
93

hiqdev / hipanel-core

Push — master ( 732fc9...380ff7 )

ThemeSettingsStorage::get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like