Apc::apcStore() - Code Metrics - Logi-CE/fmup - Measure and Improve Code Quality continuously with Scrutinizer

Apc::apcStore() A
last analyzed 2017-12-05 10:44 UTC

↳ Parent: Apc

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
cc	1
eloc	2
nc	1
nop	3
dl	0
loc	4
ccs	0
cts	0
cp	0
crap	2
rs	10
c	0
b	0
f	0

<?php
namespace FMUP\Cache\Driver;

use FMUP\Cache\CacheInterface;
use FMUP\Cache\Exception;

/**
 * Class Apc
 * This driver needs APC installed on server to work properly
 * @package FMUP\Cache\Driver
 */
class Apc implements CacheInterface
{
    /**
     * @var array
     */
    private $settings = array();
    private $isAvailable = null;

    const SETTING_CACHE_TYPE = 'SETTING_CACHE_TYPE';
    const SETTING_CACHE_TTL = 'SETTING_CACHE_TTL';
    const SETTING_CACHE_PREFIX = 'SETTING_CACHE_PREFIX';

    const CACHE_TTL_DEFAULT = 0;

    const CACHE_TYPE_USER = 'user';
    const CACHE_TYPE_FILE_HITS = 'filehits';
    const CACHE_TYPE_OP_CODE = 'opcode';

    /**
     * constructor of File
     * @param array $settings
     */
    public function __construct($settings = array())
    {
        $this->setSettings($settings);
    }

    /**
     * Can define settings of the component
     * @param array $settings
     * @return $this
     */
    public function setSettings($settings = array())
    {
        $this->settings = $settings;
        return $this;
    }

    /**
     * Get defined value for specified cache key
     * @param string $key
     * @return mixed
     * @throws Exception
     */
    public function get($key)
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        $key = $this->getCacheKey($key);
        $success = null;
        $return = $this->apcFetch($key, $success);
        if (false === $success) {
            throw new Exception('Unable to get ' . $key . ' from APC');
        }
        return $return;
    }

    /**
     * @param string $key
     * @param bool &$success
     * @return mixed
     * @codeCoverageIgnore
     */
    protected function apcFetch($key, &$success)
    {
        return apc_fetch($key, $success);
    }

    /**
     * Check whether key exists or not
     * @param string $key
     * @return bool
     * @throws Exception
     */
    public function has($key)
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        $key = $this->getCacheKey($key);
        return (bool)$this->apcExists($key);
    }

    /**
     * @param string $key
     * @return bool|\string[]
     * @codeCoverageIgnore
     */
    protected function apcExists($key)
    {
        return apc_exists($key);
    }

    /**
     * Delete a specified key in cache
     * @param string $key
     * @return $this
     * @throws Exception
     */
    public function remove($key)
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        $key = $this->getCacheKey($key);
        if ($this->getCacheType() == self::CACHE_TYPE_OP_CODE) {
            $success = $this->apcDeleteFile($key);
        } else {
            $success = $this->apcDelete($key);
        }
        if (!$success) {
            throw new Exception('Unable to delete key from cache APC');
        }
        return $this;
    }

    /**
     * @param string $key
     * @return bool|\string[]
     * @codeCoverageIgnore
     */
    protected function apcDelete($key)
    {
        return apc_delete($key);
    }

    /**
     * @param string $key
     * @return bool|\string[]
     * @codeCoverageIgnore
     */
    protected function apcDeleteFile($key)
    {
        return apc_delete_file($key);
    }

    /**
     * Define a value in cache for a specified name
     * @param string $key
     * @param mixed $value
     * @return $this
     * @throws Exception
     */
    public function set($key, $value)
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        $key = $this->getCacheKey($key);
        $ttl = $this->getSetting(self::SETTING_CACHE_TTL)
            ? (int)$this->getSetting(self::SETTING_CACHE_TTL)
            : self::CACHE_TTL_DEFAULT;
        if (!$this->apcStore($key, $value, $ttl) && !$this->apcAdd($key, $value, $ttl)) {
            throw new Exception('Unable to set key into cache APC');
        }
        return $this;
    }

    /**
     * @param string $key
     * @param mixed $value
     * @param int $ttl
     * @return bool
     * @codeCoverageIgnore
     */
    protected function apcAdd($key, $value, $ttl = 0)
    {
        return apc_add($key, $value, $ttl);
    }

    /**
     * @param string|array $key
     * @param mixed $value
     * @param int $ttl
     * @return array|bool
     * @codeCoverageIgnore
     */
    protected function apcStore($key, $value, $ttl = 0)
    {
        return apc_store($key, $value, $ttl);
    }

    /**
     * Clear specified cache type
     * @return bool
     * @throws Exception
     */
    public function clear()
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        return $this->apcClearCache($this->getCacheType());
    }

    /**
     * @param string $cacheType
     * @return bool
     * @codeCoverageIgnore
     */
    protected function apcClearCache($cacheType = '')
    {
        return apc_clear_cache($cacheType);
    }

    /**
     * Get information for specified cache type
     * @param bool $limited (default false) If limited is TRUE, the return value will exclude the individual list
     *                                      of cache entries.
     *                                      This is useful when trying to optimize calls for statistics gathering.
     * @return array|bool
     * @throws Exception
     */
    public function info($limited = false)
    {
        if (!$this->isAvailable()) {
            throw new Exception('APC is not available');
        }
        return $this->apcCacheInfo($this->getCacheType(), (bool)$limited);
    }

    /**
     * @param string $cacheType
     * @param bool|false $limited
     * @return array|bool
     * @codeCoverageIgnore
     */
    protected function apcCacheInfo($cacheType, $limited = false)
    {
        return apc_cache_info($cacheType, (bool)$limited);
    }

    /**
     * Define a setting
     * @param string $name
     * @param mixed $value
     * @return $this
     */
    public function setSetting($name, $value)
    {
        $this->settings[$name] = $value;
        return $this;
    }

    /**
     * Retrieve a defined setting
     * @param string $name
     * @return mixed
     */
    public function getSetting($name)
    {
        return isset($this->settings[$name]) ? $this->settings[$name] : null;
    }

    /**
     * Get defined cache type
     * @return string
     */
    private function getCacheType()
    {
        $type = $this->getSetting(self::SETTING_CACHE_TYPE);
        if (!$type) {
            return self::CACHE_TYPE_OP_CODE;
        }
        return $type;
    }

    /**
     * Check whether apc is available
     * @return bool
     */
    public function isAvailable()
    {
        if (is_null($this->isAvailable)) {
            $iniValue = ini_get('apc.enabled');
            $iniEnabled = ($iniValue == 1 || strtolower($iniValue) == 'on');
            $this->isAvailable = function_exists('apc_clear_cache') && $iniEnabled;
        }
        return $this->isAvailable;
    }

    /**
     * Get cache key with prefix
     * @param string $key
     * @return string
     */
    protected function getCacheKey($key)
    {
        $prefix = (string)$this->getSetting(self::SETTING_CACHE_PREFIX);
        return $prefix . $key;
    }
}


1		<?php
2		namespace FMUP\Cache\Driver;
3
4		use FMUP\Cache\CacheInterface;
5		use FMUP\Cache\Exception;
6
7		/**
8		* Class Apc
9		* This driver needs APC installed on server to work properly
10		* @package FMUP\Cache\Driver
11		*/
12		class Apc implements CacheInterface
13		{
14		/**
15		* @var array
16		*/
17		private $settings = array();
18		private $isAvailable = null;
19
20		const SETTING_CACHE_TYPE = 'SETTING_CACHE_TYPE';
21		const SETTING_CACHE_TTL = 'SETTING_CACHE_TTL';
22		const SETTING_CACHE_PREFIX = 'SETTING_CACHE_PREFIX';
23
24		const CACHE_TTL_DEFAULT = 0;
25
26		const CACHE_TYPE_USER = 'user';
27		const CACHE_TYPE_FILE_HITS = 'filehits';
28		const CACHE_TYPE_OP_CODE = 'opcode';
29
30		/**
31		* constructor of File
32		* @param array $settings
33		*/
34	22	public function __construct($settings = array())
35		{
36	22	$this->setSettings($settings);
37	22	}
38
39		/**
40		* Can define settings of the component
41		* @param array $settings
42		* @return $this
43		*/
44	22	public function setSettings($settings = array())
45		{
46	22	$this->settings = $settings;
47	22	return $this;
48		}
49
50		/**
51		* Get defined value for specified cache key
52		* @param string $key
53		* @return mixed
54		* @throws Exception
55		*/
56	3	public function get($key)
57		{
58	3	if (!$this->isAvailable()) {
59	1	throw new Exception('APC is not available');
60		}
61	2	$key = $this->getCacheKey($key);
62	2	$success = null;
63	2	$return = $this->apcFetch($key, $success);
64	2	if (false === $success) {
65	1	throw new Exception('Unable to get ' . $key . ' from APC');
66		}
67	1	return $return;
68		}
69
70		/**
71		* @param string $key
72		* @param bool &$success
73		* @return mixed
74		* @codeCoverageIgnore
75		*/
76		protected function apcFetch($key, &$success)
77		{
78		return apc_fetch($key, $success);
79		}
80
81		/**
82		* Check whether key exists or not
83		* @param string $key
84		* @return bool
85		* @throws Exception
86		*/
87	2	public function has($key)
88		{
89	2	if (!$this->isAvailable()) {
90	1	throw new Exception('APC is not available');
91		}
92	1	$key = $this->getCacheKey($key);
93	1	return (bool)$this->apcExists($key);
94		}
95
96		/**
97		* @param string $key
98		* @return bool\|\string[]
99		* @codeCoverageIgnore
100		*/
101		protected function apcExists($key)
102		{
103		return apc_exists($key);
104		}
105
106		/**
107		* Delete a specified key in cache
108		* @param string $key
109		* @return $this
110		* @throws Exception
111		*/
112	5	public function remove($key)
113		{
114	5	if (!$this->isAvailable()) {
115	1	throw new Exception('APC is not available');
116		}
117	4	$key = $this->getCacheKey($key);
118	4	if ($this->getCacheType() == self::CACHE_TYPE_OP_CODE) {
119	2	$success = $this->apcDeleteFile($key);
120		} else {
121	2	$success = $this->apcDelete($key);
122		}
123	4	if (!$success) {
124	2	throw new Exception('Unable to delete key from cache APC');
125		}
126	2	return $this;
127		}
128
129		/**
130		* @param string $key
131		* @return bool\|\string[]
132		* @codeCoverageIgnore
133		*/
134		protected function apcDelete($key)
135		{
136		return apc_delete($key);
137		}
138
139		/**
140		* @param string $key
141		* @return bool\|\string[]
142		* @codeCoverageIgnore
143		*/
144		protected function apcDeleteFile($key)
145		{
146		return apc_delete_file($key);
147		}
148
149		/**
150		* Define a value in cache for a specified name
151		* @param string $key
152		* @param mixed $value
153		* @return $this
154		* @throws Exception
155		*/
156	3	public function set($key, $value)
157		{
158	3	if (!$this->isAvailable()) {
159	1	throw new Exception('APC is not available');
160		}
161	2	$key = $this->getCacheKey($key);
162	2	$ttl = $this->getSetting(self::SETTING_CACHE_TTL)
163	1	? (int)$this->getSetting(self::SETTING_CACHE_TTL)
164	2	: self::CACHE_TTL_DEFAULT;
165	2	if (!$this->apcStore($key, $value, $ttl) && !$this->apcAdd($key, $value, $ttl)) {
166	1	throw new Exception('Unable to set key into cache APC');
167		}
168	1	return $this;
169		}
170
171		/**
172		* @param string $key
173		* @param mixed $value
174		* @param int $ttl
175		* @return bool
176		* @codeCoverageIgnore
177		*/
178		protected function apcAdd($key, $value, $ttl = 0)
179		{
180		return apc_add($key, $value, $ttl);
181		}
182
183		/**
184		* @param string\|array $key
185		* @param mixed $value
186		* @param int $ttl
187		* @return array\|bool
188		* @codeCoverageIgnore
189		*/
190		protected function apcStore($key, $value, $ttl = 0)
191		{
192		return apc_store($key, $value, $ttl);
193		}
194
195		/**
196		* Clear specified cache type
197		* @return bool
198		* @throws Exception
199		*/
200	3	public function clear()
201		{
202	3	if (!$this->isAvailable()) {
203	1	throw new Exception('APC is not available');
204		}
205	2	return $this->apcClearCache($this->getCacheType());
206		}
207
208		/**
209		* @param string $cacheType
210		* @return bool
211		* @codeCoverageIgnore
212		*/
213		protected function apcClearCache($cacheType = '')
214		{
215		return apc_clear_cache($cacheType);
216		}
217
218		/**
219		* Get information for specified cache type
220		* @param bool $limited (default false) If limited is TRUE, the return value will exclude the individual list
221		* of cache entries.
222		* This is useful when trying to optimize calls for statistics gathering.
223		* @return array\|bool
224		* @throws Exception
225		*/
226	3	public function info($limited = false)
227		{
228	3	if (!$this->isAvailable()) {
229	1	throw new Exception('APC is not available');
230		}
231	2	return $this->apcCacheInfo($this->getCacheType(), (bool)$limited);
232		}
233
234		/**
235		* @param string $cacheType
236		* @param bool\|false $limited
237		* @return array\|bool
238		* @codeCoverageIgnore
239		*/
240		protected function apcCacheInfo($cacheType, $limited = false)
241		{
242		return apc_cache_info($cacheType, (bool)$limited);
243		}
244
245		/**
246		* Define a setting
247		* @param string $name
248		* @param mixed $value
249		* @return $this
250		*/
251	3	public function setSetting($name, $value)
252		{
253	3	$this->settings[$name] = $value;
254	3	return $this;
255		}
256
257		/**
258		* Retrieve a defined setting
259		* @param string $name
260		* @return mixed
261		*/
262	13	public function getSetting($name)
263		{
264	13	return isset($this->settings[$name]) ? $this->settings[$name] : null;
265		}
266
267		/**
268		* Get defined cache type
269		* @return string
270		*/
271	8	private function getCacheType()
272		{
273	8	$type = $this->getSetting(self::SETTING_CACHE_TYPE);
274	8	if (!$type) {
275	5	return self::CACHE_TYPE_OP_CODE;
276		}
277	3	return $type;
278		}
279
280		/**
281		* Check whether apc is available
282		* @return bool
283		*/
284	1	public function isAvailable()
285		{
286	1	if (is_null($this->isAvailable)) {
287	1	$iniValue = ini_get('apc.enabled');
288	1	$iniEnabled = ($iniValue == 1 \|\| strtolower($iniValue) == 'on');
289	1	$this->isAvailable = function_exists('apc_clear_cache') && $iniEnabled;
290		}
291	1	return $this->isAvailable;
292		}
293
294		/**
295		* Get cache key with prefix
296		* @param string $key
297		* @return string
298		*/
299	8	protected function getCacheKey($key)
300		{
301	8	$prefix = (string)$this->getSetting(self::SETTING_CACHE_PREFIX);
302	8	return $prefix . $key;
303		}
304		}
305

Logi-CE / fmup

Apc::apcStore() A last analyzed 2017-12-05 10:44 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Apc::apcStore() A
last analyzed 2017-12-05 10:44 UTC