Redis::get() - Code Metrics - kokororin/Kotori.php - Measure and Improve Code Quality continuously with Scrutinizer

Redis::get() C
last analyzed 2018-05-04 03:56 UTC

↳ Parent: Redis

Complexity

Conditions	12
Paths	15

Size

Total Lines	25
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	156

Importance

Changes

Metric	Value
cc	12
eloc	19
nc	15
nop	1
dl	0
loc	25
ccs	0
cts	18
cp	0
crap	156
rs	5.1612
c	0
b	0
f	0

How to fix Complexity

<?php
/**
 * Kotori.php
 *
 * A Tiny Model-View-Controller PHP Framework
 *
 * This content is released under the Apache 2 License
 *
 * Copyright (c) 2015-2017 Kotori Technology. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * Redis Caching Class
 *
 * @package     Kotori
 * @subpackage  Cache
 * @author      Kokororin
 * @link        https://kotori.love
 */
namespace Kotori\Core\Cache;

use Kotori\Core\Container;
use Kotori\Exception\CacheException;
use RedisException;

class Redis
{
    /**
     * Default config
     *
     * @var array
     */
    protected $redisConf = [
        'host' => '127.0.0.1',
        'password' => null,
        'port' => 6379,
        'timeout' => 0,
        'database' => 0,
    ];

    /**
     * Redis connection
     *
     * @var Redis
     */
    protected $redis;

    /**
     * Class constructor
     *
     * Setup Redis
     *
     * Loads Redis config file if present. Will halt execution
     * if a Redis connection can't be established.
     *
     * @param   array $config
     *
     * @throws \Kotori\Exception\CacheException
     */
    public function __construct($config = [])
    {
        if (!$this->isSupported()) {
            throw new CacheException('Failed to create Redis object; extension not loaded?');
        }

        if (empty($config)) {
            $config = Container::get('config')->get('cache');
            $config = array_merge($this->redisConf, $config);
        }

        $this->redis = new \Redis();


        try {
            if (!$this->redis->connect($config['host'], ($config['host'][0] === '/' ? 0 : $config['port']), $config['timeout'])) {
                throw new CacheException('Redis connection failed. Check your configuration.');
            }

            if (isset($config['password']) && !$this->redis->auth($config['password'])) {

                throw new CacheException('Redis authentication failed.');
            }

            if (isset($config['database']) && $config['database'] > 0 && !$this->redis->select($config['database'])) {

                throw new CacheException('Redis select database failed.');
            }
        } catch (RedisException $e) {
            throw new CacheException('Redis connection refused (' . $e->getMessage() . ')');
        }
    }

    /**
     * Get cache
     *
     * @param   string  $key
     * @return  mixed
     */
    public function get($key)
    {
        $value = $this->redis->hMGet($key, ['type', 'value']);


        if (!isset($value['type'], $value['value']) || $value['value'] === false) {
            return false;
        }

        switch ($value['type']) {
            case 'array':
            case 'object':
                return unserialize($value['value']);
            case 'boolean':
            case 'integer':
            case 'double': // Yes, 'double' is returned and NOT 'float'
            case 'string':
            case 'NULL':
                return settype($value['value'], $value['type'])
                ? $value['value']
                : false;
            case 'resource':
            default:
                return false;
        }
    }

    /**
     * Save cache
     *
     * @param   string    $key
     * @param   mixed     $value
     * @param   int       $ttl
     * @return  boolean
     */
    public function set($key, $value, $ttl = 60)
    {
        $dataType = gettype($value);

        switch ($dataType) {
            case 'array':
            case 'object':
                $value = serialize($value);
                break;
            case 'boolean':
            case 'integer':
            case 'double': // Yes, 'double' is returned and NOT 'float'
            case 'string':
            case 'NULL':
                break;
            case 'resource':
            default:
                return false;
        }

        if (!$this->redis->hMSet($key, ['type' => $dataType, 'value' => $value])) {

            return false;
        } elseif ($ttl) {
            $this->redis->expireAt($key, time() + $ttl);

        }

        return true;
    }

    /**
     * Delete from cache
     *
     * @param   string  $key
     * @return  boolean
     */
    public function delete($key)
    {
        return ($this->redis->delete($key) === 1);
    }

    /**
     * Clean cache
     *
     * @return  boolean
     */
    public function clear()
    {
        return $this->redis->flushDB();

    }

    /**
     * Check if Redis driver is supported
     *
     * @return  boolean
     */
    public function isSupported()
    {
        return extension_loaded('redis');
    }

    /**
     * Class destructor
     *
     * Closes the connection to Redis if present.
     */
    public function __destruct()
    {
        if ($this->redis) {
            $this->redis->close();

        }
    }
}


GitHub Access Token became invalid

Redis::get() C
last analyzed 2018-05-04 03:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

1		<?php
2		/**
3		* Kotori.php
4		*
5		* A Tiny Model-View-Controller PHP Framework
6		*
7		* This content is released under the Apache 2 License
8		*
9		* Copyright (c) 2015-2017 Kotori Technology. All rights reserved.
10		*
11		* Licensed under the Apache License, Version 2.0 (the "License");
12		* you may not use this file except in compliance with the License.
13		* You may obtain a copy of the License at
14		*
15		* http://www.apache.org/licenses/LICENSE-2.0
16		*
17		* Unless required by applicable law or agreed to in writing, software
18		* distributed under the License is distributed on an "AS IS" BASIS,
19		* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
20		* See the License for the specific language governing permissions and
21		* limitations under the License.
22		*/
23
24		/**
25		* Redis Caching Class
26		*
27		* @package Kotori
28		* @subpackage Cache
29		* @author Kokororin
30		* @link https://kotori.love
31		*/
32		namespace Kotori\Core\Cache;
33
34		use Kotori\Core\Container;
35		use Kotori\Exception\CacheException;
36		use RedisException;
37
38		class Redis
39		{
40		/**
41		* Default config
42		*
43		* @var array
44		*/
45		protected $redisConf = [
46		'host' => '127.0.0.1',
47		'password' => null,
48		'port' => 6379,
49		'timeout' => 0,
50		'database' => 0,
51		];
52
53		/**
54		* Redis connection
55		*
56		* @var Redis
57		*/
58		protected $redis;
59
60		/**
61		* Class constructor
62		*
63		* Setup Redis
64		*
65		* Loads Redis config file if present. Will halt execution
66		* if a Redis connection can't be established.
67		*
68		* @param array $config
69		*
70		* @throws \Kotori\Exception\CacheException
71		*/
72		public function __construct($config = [])
73		{
74		if (!$this->isSupported()) {
75		throw new CacheException('Failed to create Redis object; extension not loaded?');
76		}
77
78		if (empty($config)) {
79		$config = Container::get('config')->get('cache');
80		$config = array_merge($this->redisConf, $config);
81		}
82
83		$this->redis = new \Redis();
		0 ignored issues – show Documentation Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report It seems like `new \Redis()` of type `object<Redis>` is incompatible with the declared type `object<Kotori\Core\Cache\Redis>` of property `$redis`. 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...
84
85		try {
86		if (!$this->redis->connect($config['host'], ($config['host'][0] === '/' ? 0 : $config['port']), $config['timeout'])) {
87		throw new CacheException('Redis connection failed. Check your configuration.');
88		}
89
90	View Code Duplication	if (isset($config['password']) && !$this->redis->auth($config['password'])) {
		0 ignored issues – show Duplication introduced 2017-11-30 07:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
91		throw new CacheException('Redis authentication failed.');
92		}
93
94	View Code Duplication	if (isset($config['database']) && $config['database'] > 0 && !$this->redis->select($config['database'])) {
		0 ignored issues – show Duplication introduced 2017-11-30 07:38 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
95		throw new CacheException('Redis select database failed.');
96		}
97		} catch (RedisException $e) {
98		throw new CacheException('Redis connection refused (' . $e->getMessage() . ')');
99		}
100		}
101
102		/**
103		* Get cache
104		*
105		* @param string $key
106		* @return mixed
107		*/
108		public function get($key)
109		{
110		$value = $this->redis->hMGet($key, ['type', 'value']);
		0 ignored issues – show Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report The method `hMGet()` does not seem to exist on `object<Kotori\Core\Cache\Redis>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
111
112		if (!isset($value['type'], $value['value']) \|\| $value['value'] === false) {
113		return false;
114		}
115
116		switch ($value['type']) {
117		case 'array':
118		case 'object':
119		return unserialize($value['value']);
120		case 'boolean':
121		case 'integer':
122		case 'double': // Yes, 'double' is returned and NOT 'float'
123		case 'string':
124		case 'NULL':
125		return settype($value['value'], $value['type'])
126		? $value['value']
127		: false;
128		case 'resource':
129		default:
130		return false;
131		}
132		}
133
134		/**
135		* Save cache
136		*
137		* @param string $key
138		* @param mixed $value
139		* @param int $ttl
140		* @return boolean
141		*/
142		public function set($key, $value, $ttl = 60)
143		{
144		$dataType = gettype($value);
145
146		switch ($dataType) {
147		case 'array':
148		case 'object':
149		$value = serialize($value);
150		break;
151		case 'boolean':
152		case 'integer':
153		case 'double': // Yes, 'double' is returned and NOT 'float'
154		case 'string':
155		case 'NULL':
156		break;
157		case 'resource':
158		default:
159		return false;
160		}
161
162		if (!$this->redis->hMSet($key, ['type' => $dataType, 'value' => $value])) {
		0 ignored issues – show Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report The method `hMSet()` does not seem to exist on `object<Kotori\Core\Cache\Redis>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
163		return false;
164		} elseif ($ttl) {
165		$this->redis->expireAt($key, time() + $ttl);
		0 ignored issues – show Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report The method `expireAt()` does not seem to exist on `object<Kotori\Core\Cache\Redis>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
166		}
167
168		return true;
169		}
170
171		/**
172		* Delete from cache
173		*
174		* @param string $key
175		* @return boolean
176		*/
177		public function delete($key)
178		{
179		return ($this->redis->delete($key) === 1);
180		}
181
182		/**
183		* Clean cache
184		*
185		* @return boolean
186		*/
187		public function clear()
188		{
189		return $this->redis->flushDB();
		0 ignored issues – show Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report The method `flushDB()` does not seem to exist on `object<Kotori\Core\Cache\Redis>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
190		}
191
192		/**
193		* Check if Redis driver is supported
194		*
195		* @return boolean
196		*/
197		public function isSupported()
198		{
199		return extension_loaded('redis');
200		}
201
202		/**
203		* Class destructor
204		*
205		* Closes the connection to Redis if present.
206		*/
207		public function __destruct()
208		{
209		if ($this->redis) {
210		$this->redis->close();
		0 ignored issues – show Bug introduced 2017-08-09 03:23 UTC by Report Bug Copy Issue Report The method `close()` does not seem to exist on `object<Kotori\Core\Cache\Redis>`. This check looks for calls to methods that do not seem to exist on a given type. It looks for the method on the type itself as well as in inherited classes or implemented interfaces. This is most likely a typographical error or the method has been renamed. Loading history...
211		}
212		}
213		}
214

kokororin / Kotori.php

GitHub Access Token became invalid

Redis::get() C last analyzed 2018-05-04 03:56 UTC

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like

Redis::get() C
last analyzed 2018-05-04 03:56 UTC