RedisCache::__construct() - Code Metrics - EVE-KILL/zKillboard - Measure and Improve Code Quality continuously with Scrutinizer

RedisCache::__construct() A
last analyzed 2016-02-10 18:51 UTC

↳ Parent: RedisCache

Complexity

Conditions	3
Paths	4

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	14
rs	9.4285
cc	3
eloc	8
nc	4
nop	0

<?php
/* zCache
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * Redis Cache Class
 * 
 * @use Redis (https://github.com/nicolasff/phpredis)
 *
 */
class RedisCache extends AbstractCache
{
	/**
	 * Redis object instance
	 *
	 * @var object Redis object
	 */
	private $_redis;

	/**
	 * Instantiates the `Redis` object and connects it to the configured server.
	 *
	 * @return void

	 */
	function __construct()

	{
		global $redisServer, $redisPort;

		if (!$this->_redis) {
			$this->_redis = new Redis();
		}

		if (substr($redisServer, 0, 7) == "unix://") {
			$this->_redis->pconnect(substr($redisServer, 7), 0.0, null, 0);
		} else {
			$this->_redis->pconnect($redisServer, $redisPort, 0.0, null, 0);
		}
	}

	/**
	 * Sets expiration time for cache key
	 *
	 * @param string $key The key to uniquely identify the cached item
	 * @param mixed $timeout A `strtotime()`-compatible string or a Unix timestamp.
	 * @return boolean
	 */
	protected function _expireAt($key, $timeout)
	{
		return $this->_redis->expireAt($key, is_int($timeout) ? $timeout : strtotime($timeout));
	}

	/**
	 * Read value from the cache
	 *
	 * @param string $key The key to uniquely identify the cached item
	 * @return mixed
	 */
	public function get($key)
	{
		return $this->_redis->get($key);
	}

	/**
	 * Write value to the cache
	 *
	 * @param string $key The key to uniquely identify the cached item
	 * @param mixed $value The value to be cached
	 * @param null|string $timeout A strtotime() compatible cache time.
	 * @return boolean
	 */
	public function set($key, $value, $timeout)
	{
		$result = $this->_redis->set($key, $value);
		return $result ? $this->_expireAt($key, $timeout) : $result;
	}

	/**
	 * Override value in the cache
	 *
	 * @param string $key The key to uniquely identify the cached item
	 * @param mixed $value The value to be cached
	 * @param null|string $timeout A strtotime() compatible cache time.
	 * @return boolean
	 */
	public function replace($key, $value, $timeout)
	{
		return  $this->_redis->set($key, $value, $timeout);
	}

	/**
	 * Delete value from the cache
	 *
	 * @param string $key The key to uniquely identify the cached item
	 */
	public function delete($key)
	{
		return (boolean) $this->_redis->del($key);
	}

	/**
	 * Performs an atomic increment operation on specified numeric cache item.
	 *
	 * Note that if the value of the specified key is *not* an integer, the increment
	 * operation will have no effect whatsoever. Redis chooses to not typecast values
	 * to integers when performing an atomic increment operation.
	 *
	 * @param string $key Key of numeric cache item to increment
	 * @return Closure Function returning item's new value on successful increment, else `false`
	 */
	public function increment($key, $step = 1, $timeout = 0)
	{
		if ($timeout) {
			$this->_expireAt($key, $timeout);
		}
		return $this->_redis->incr($key, $step);
	}

	/**
	 * Performs an atomic decrement operation on specified numeric cache item.
	 *
	 * Note that if the value of the specified key is *not* an integer, the decrement
	 * operation will have no effect whatsoever. Redis chooses to not typecast values
	 * to integers when performing an atomic decrement operation.
	 *
	 * @param string $key Key of numeric cache item to decrement
	 * @param integer $step Offset to decrement - defaults to 1
	 * @param integer $timeout A strtotime() compatible cache time.
	 * @return Closure Function returning item's new value on successful decrement, else `false`
	 */
	public function decrement($key, $step = 1, $timeout = 0)
	{
		if ($timeout) {
			$this->_expireAt($key, $timeout);
		}
		return $this->_redis->decr($key, $step);
	}

	/**
	 * Clears user-space cache
	 *
	 * @return boolean|null
	 */
	public function flush()
	{
		$this->_redis->flushdb();
	}

}


1			<?php
2			/* zCache
3			*
4			* This program is free software: you can redistribute it and/or modify
5			* it under the terms of the GNU Affero General Public License as published by
6			* the Free Software Foundation, either version 3 of the License, or
7			* (at your option) any later version.
8			*
9			* This program is distributed in the hope that it will be useful,
10			* but WITHOUT ANY WARRANTY; without even the implied warranty of
11			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12			* GNU Affero General Public License for more details.
13			*
14			* You should have received a copy of the GNU Affero General Public License
15			* along with this program. If not, see <http://www.gnu.org/licenses/>.
16			*/
17
18			/**
19			* Redis Cache Class
20			*
21			* @use Redis (https://github.com/nicolasff/phpredis)
22			*
23			*/
24			class RedisCache extends AbstractCache
25			{
26			/**
27			* Redis object instance
28			*
29			* @var object Redis object
30			*/
31			private $_redis;
32
33			/**
34			* Instantiates the `Redis` object and connects it to the configured server.
35			*
36			* @return void
			0 ignored issues – show Comprehensibility Best Practice introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report Adding a `@return` annotation to constructors is generally not recommended as a constructor does not have a meaningful return value. Adding a `@return` annotation to a constructor is not recommended, since a constructor does not have a meaningful return value. Please refer to the PHP core documentation on constructors. Loading history...
37			*/
38			function __construct()
			0 ignored issues – show Best Practice introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report It is generally recommended to explicitly declare the visibility for methods. Adding explicit visibility (`private`, `protected`, or `public`) is generally recommend to communicate to other developers how, and from where this method is intended to be used. Loading history... Comprehensibility Best Practice introduced 2015-12-13 23:29 UTC by Report Bug Copy Issue Report It is recommend to declare an explicit visibility for `__construct`. Generally, we recommend to declare visibility for all methods in your source code. This has the advantage of clearly communication to other developers, and also yourself, how this method should be consumed. If you are not sure which visibility to choose, it is a good idea to start with the most restrictive visibility, and then raise visibility as needed, i.e. start with `private`, and only raise it to `protected` if a sub-class needs to have access, or `public` if an external class needs access. Loading history...
39			{
40			global $redisServer, $redisPort;
41
42			if (!$this->_redis) {
43			$this->_redis = new Redis();
44			}
45
46			if (substr($redisServer, 0, 7) == "unix://") {
47			$this->_redis->pconnect(substr($redisServer, 7), 0.0, null, 0);
48			} else {
49			$this->_redis->pconnect($redisServer, $redisPort, 0.0, null, 0);
50			}
51			}
52
53			/**
54			* Sets expiration time for cache key
55			*
56			* @param string $key The key to uniquely identify the cached item
57			* @param mixed $timeout A `strtotime()`-compatible string or a Unix timestamp.
58			* @return boolean
59			*/
60			protected function _expireAt($key, $timeout)
61			{
62			return $this->_redis->expireAt($key, is_int($timeout) ? $timeout : strtotime($timeout));
63			}
64
65			/**
66			* Read value from the cache
67			*
68			* @param string $key The key to uniquely identify the cached item
69			* @return mixed
70			*/
71			public function get($key)
72			{
73			return $this->_redis->get($key);
74			}
75
76			/**
77			* Write value to the cache
78			*
79			* @param string $key The key to uniquely identify the cached item
80			* @param mixed $value The value to be cached
81			* @param null\|string $timeout A strtotime() compatible cache time.
82			* @return boolean
83			*/
84			public function set($key, $value, $timeout)
85			{
86			$result = $this->_redis->set($key, $value);
87			return $result ? $this->_expireAt($key, $timeout) : $result;
88			}
89
90			/**
91			* Override value in the cache
92			*
93			* @param string $key The key to uniquely identify the cached item
94			* @param mixed $value The value to be cached
95			* @param null\|string $timeout A strtotime() compatible cache time.
96			* @return boolean
97			*/
98			public function replace($key, $value, $timeout)
99			{
100			return $this->_redis->set($key, $value, $timeout);
101			}
102
103			/**
104			* Delete value from the cache
105			*
106			* @param string $key The key to uniquely identify the cached item
107			*/
108			public function delete($key)
109			{
110			return (boolean) $this->_redis->del($key);
111			}
112
113			/**
114			* Performs an atomic increment operation on specified numeric cache item.
115			*
116			* Note that if the value of the specified key is not an integer, the increment
117			* operation will have no effect whatsoever. Redis chooses to not typecast values
118			* to integers when performing an atomic increment operation.
119			*
120			* @param string $key Key of numeric cache item to increment
121			* @return Closure Function returning item's new value on successful increment, else `false`
122			*/
123			public function increment($key, $step = 1, $timeout = 0)
124			{
125			if ($timeout) {
126			$this->_expireAt($key, $timeout);
127			}
128			return $this->_redis->incr($key, $step);
129			}
130
131			/**
132			* Performs an atomic decrement operation on specified numeric cache item.
133			*
134			* Note that if the value of the specified key is not an integer, the decrement
135			* operation will have no effect whatsoever. Redis chooses to not typecast values
136			* to integers when performing an atomic decrement operation.
137			*
138			* @param string $key Key of numeric cache item to decrement
139			* @param integer $step Offset to decrement - defaults to 1
140			* @param integer $timeout A strtotime() compatible cache time.
141			* @return Closure Function returning item's new value on successful decrement, else `false`
142			*/
143			public function decrement($key, $step = 1, $timeout = 0)
144			{
145			if ($timeout) {
146			$this->_expireAt($key, $timeout);
147			}
148			return $this->_redis->decr($key, $step);
149			}
150
151			/**
152			* Clears user-space cache
153			*
154			* @return boolean\|null
155			*/
156			public function flush()
157			{
158			$this->_redis->flushdb();
159			}
160
161			}
162

EVE-KILL / zKillboard

RedisCache::__construct() A last analyzed 2016-02-10 18:51 UTC

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like

RedisCache::__construct() A
last analyzed 2016-02-10 18:51 UTC