Memcached::isSupported() - Code Metrics - Inspection of "Remove check, too eager for interface requirements" - joomla-framework/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0-dev ( 04c5d6...e14a69 )

by Michael

created 2016-04-22 03:07 UTC

Memcached::isSupported() A

↳ Parent: Memcached

Complexity

Conditions	1
Paths	1

Size

Total Lines	8
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	8
ccs	2
cts	2
cp	1
rs	9.4285
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php
/**
 * Part of the Joomla Framework Cache Package
 *
 * @copyright  Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
 * @license    GNU General Public License version 2 or later; see LICENSE
 */

namespace Joomla\Cache\Adapter;

use Joomla\Cache\AbstractCacheItemPool;
use Joomla\Cache\Exception\RuntimeException;
use Joomla\Cache\Item\HasExpirationDateInterface;
use Joomla\Cache\Item\Item;
use Psr\Cache\CacheItemInterface;

/**
 * Memcached cache driver for the Joomla Framework.
 *
 * @since  1.0
 */
class Memcached extends AbstractCacheItemPool
{
	/**
	 * The Memcached driver
	 *
	 * @var    \Memcached
	 * @since  1.0
	 */
	private $driver;

	/**
	 * Constructor.
	 *
	 * @param   \Memcached          $memcached  The Memcached driver being used for this pool
	 * @param   array|\ArrayAccess  $options    An options array, or an object that implements \ArrayAccess
	 *
	 * @since   1.0
	 */
	public function __construct(\Memcached $memcached, $options = [])
	{
		// Parent sets up the caching options and checks their type
		parent::__construct($options);

		$this->driver = $memcached;
	}

	/**
	 * This will wipe out the entire cache's keys
	 *
	 * @return  boolean  The result of the clear operation.
	 *
	 * @since   1.0
	 */
	public function clear()
	{
		return $this->driver->flush();
	}

	/**
	 * Method to get a storage entry value from a key.
	 *
	 * @param   string  $key  The storage entry identifier.
	 *
	 * @return  CacheItemInterface
	 *
	 * @since   1.0
	 */
	public function getItem($key)
	{
		$value = $this->driver->get($key);
		$code = $this->driver->getResultCode();
		$item = new Item($key);

		if ($code === \Memcached::RES_SUCCESS)
		{
			$item->set($value);
		}

		return $item;
	}

	/**
	 * Returns a traversable set of cache items.
	 *
	 * @param   array  $keys  A list of keys that can obtained in a single operation.
	 *
	 * @return  CacheItemInterface[]  An associative array of CacheItemInterface objects keyed on the cache key.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function getItems(array $keys = [])
	{
		$data = $this->driver->getMulti($keys);

		$result = [];

		foreach ($keys as $key)
		{
			$item = new Item($key);

			if (array_key_exists($key, $data))
			{
				$item->set($data[$key]);
			}

			$result[$key] = $item;
		}

		return $result;
	}

	/**
	 * Method to remove a storage entry for a key.
	 *
	 * @param   string  $key  The storage entry identifier.
	 *
	 * @return  boolean
	 *
	 * @since   1.0
	 * @throws  RuntimeException
	 */
	public function deleteItem($key)
	{
		if ($this->hasItem($key))
		{
			$this->driver->delete($key);

			$rc = $this->driver->getResultCode();

			// If the item was not successfully removed nor did not exist then raise an error
			if (($rc !== \Memcached::RES_SUCCESS))
			{
				throw new RuntimeException(sprintf('Unable to remove cache entry for %s. Error message `%s`.', $key, $this->driver->getResultMessage()));
			}
		}

		return true;
	}

	/**
	 * Removes multiple items from the pool.
	 *
	 * @param   array  $keys  An array of keys that should be removed from the pool.
	 *
	 * @return  boolean
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function deleteItems(array $keys)
	{
		// HHVM doesn't support deleteMulti
		if (!method_exists($this->driver, 'deleteMulti'))
		{
			return parent::deleteItems($keys);
		}

		$deleted = $this->driver->deleteMulti($keys);


		foreach ($deleted as $key => $value)
		{
			/*
			 * The return of deleteMulti is not consistent with the documentation for error cases,
			 * so check for an explicit boolean true for successful deletion
			 */
			if ($value !== true && $value !== \Memcached::RES_NOTFOUND)
			{
				return false;
			}
		}

		return true;
	}

	/**
	 * Persists a cache item immediately.
	 *
	 * @param   CacheItemInterface  $item  The cache item to save.
	 *
	 * @return  boolean
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function save(CacheItemInterface $item)
	{
		if ($item instanceof HasExpirationDateInterface)
		{
			$ttl = $this->convertItemExpiryToSeconds($item);
		}
		else
		{
			$ttl = 0;
		}

		$this->driver->set($item->getKey(), $item->get(), $ttl);

		return (bool) ($this->driver->getResultCode() == \Memcached::RES_SUCCESS);
	}

	/**
	 * Method to determine whether a storage entry has been set for a key.
	 *
	 * @param   string  $key  The storage entry identifier.
	 *
	 * @return  boolean
	 *
	 * @since   1.0
	 */
	public function hasItem($key)
	{
		$this->driver->get($key);

		return ($this->driver->getResultCode() !== \Memcached::RES_NOTFOUND);
	}

	/**
	 * Test to see if the CacheItemPoolInterface is available
	 *
	 * @return  boolean  True on success, false otherwise
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public static function isSupported()
	{
		/*
		 * GAE and HHVM have both had instances where Memcached the class was defined but no extension was loaded.
		 * If the class is there, we can assume it works.
		 */
		return (class_exists('Memcached'));
	}
}


1		<?php
2		/**
3		* Part of the Joomla Framework Cache Package
4		*
5		* @copyright Copyright (C) 2005 - 2015 Open Source Matters, Inc. All rights reserved.
6		* @license GNU General Public License version 2 or later; see LICENSE
7		*/
8
9		namespace Joomla\Cache\Adapter;
10
11		use Joomla\Cache\AbstractCacheItemPool;
12		use Joomla\Cache\Exception\RuntimeException;
13		use Joomla\Cache\Item\HasExpirationDateInterface;
14		use Joomla\Cache\Item\Item;
15		use Psr\Cache\CacheItemInterface;
16
17		/**
18		* Memcached cache driver for the Joomla Framework.
19		*
20		* @since 1.0
21		*/
22		class Memcached extends AbstractCacheItemPool
23		{
24		/**
25		* The Memcached driver
26		*
27		* @var \Memcached
28		* @since 1.0
29		*/
30		private $driver;
31
32		/**
33		* Constructor.
34		*
35		* @param \Memcached $memcached The Memcached driver being used for this pool
36		* @param array\|\ArrayAccess $options An options array, or an object that implements \ArrayAccess
37		*
38		* @since 1.0
39		*/
40	12	public function __construct(\Memcached $memcached, $options = [])
41		{
42		// Parent sets up the caching options and checks their type
43	12	parent::__construct($options);
44
45	12	$this->driver = $memcached;
46	12	}
47
48		/**
49		* This will wipe out the entire cache's keys
50		*
51		* @return boolean The result of the clear operation.
52		*
53		* @since 1.0
54		*/
55	12	public function clear()
56		{
57	12	return $this->driver->flush();
58		}
59
60		/**
61		* Method to get a storage entry value from a key.
62		*
63		* @param string $key The storage entry identifier.
64		*
65		* @return CacheItemInterface
66		*
67		* @since 1.0
68		*/
69	4	public function getItem($key)
70		{
71	4	$value = $this->driver->get($key);
72	4	$code = $this->driver->getResultCode();
73	4	$item = new Item($key);
74
75	4	if ($code === \Memcached::RES_SUCCESS)
76	4	{
77	3	$item->set($value);
78	3	}
79
80	4	return $item;
81		}
82
83		/**
84		* Returns a traversable set of cache items.
85		*
86		* @param array $keys A list of keys that can obtained in a single operation.
87		*
88		* @return CacheItemInterface[] An associative array of CacheItemInterface objects keyed on the cache key.
89		*
90		* @since __DEPLOY_VERSION__
91		*/
92	1	public function getItems(array $keys = [])
93		{
94	1	$data = $this->driver->getMulti($keys);
95
96	1	$result = [];
97
98	1	foreach ($keys as $key)
99		{
100	1	$item = new Item($key);
101
102	1	if (array_key_exists($key, $data))
103	1	{
104	1	$item->set($data[$key]);
105	1	}
106
107	1	$result[$key] = $item;
108	1	}
109
110	1	return $result;
111		}
112
113		/**
114		* Method to remove a storage entry for a key.
115		*
116		* @param string $key The storage entry identifier.
117		*
118		* @return boolean
119		*
120		* @since 1.0
121		* @throws RuntimeException
122		*/
123	1	public function deleteItem($key)
124		{
125	1	if ($this->hasItem($key))
126	1	{
127	1	$this->driver->delete($key);
128
129	1	$rc = $this->driver->getResultCode();
130
131		// If the item was not successfully removed nor did not exist then raise an error
132	1	if (($rc !== \Memcached::RES_SUCCESS))
133	1	{
134		throw new RuntimeException(sprintf('Unable to remove cache entry for %s. Error message `%s`.', $key, $this->driver->getResultMessage()));
135		}
136	1	}
137
138	1	return true;
139		}
140
141		/**
142		* Removes multiple items from the pool.
143		*
144		* @param array $keys An array of keys that should be removed from the pool.
145		*
146		* @return boolean
147		*
148		* @since __DEPLOY_VERSION__
149		*/
150	1	public function deleteItems(array $keys)
151		{
152		// HHVM doesn't support deleteMulti
153	1	if (!method_exists($this->driver, 'deleteMulti'))
154	1	{
155		return parent::deleteItems($keys);
156		}
157
158	1	$deleted = $this->driver->deleteMulti($keys);
		0 ignored issues – show Bug introduced 2016-04-22 03:05 UTC by Report Bug Copy Issue Report The method `deleteMulti()` does not exist on `Memcached`. Did you maybe mean `delete()`? This check marks calls to methods that do not seem to exist on an object. This is most likely the result of a method being renamed without all references to it being renamed likewise. Loading history...
159
160	1	foreach ($deleted as $key => $value)
161		{
162		/*
163		* The return of deleteMulti is not consistent with the documentation for error cases,
164		* so check for an explicit boolean true for successful deletion
165		*/
166	1	if ($value !== true && $value !== \Memcached::RES_NOTFOUND)
167	1	{
168		return false;
169		}
170	1	}
171
172	1	return true;
173		}
174
175		/**
176		* Persists a cache item immediately.
177		*
178		* @param CacheItemInterface $item The cache item to save.
179		*
180		* @return boolean
181		*
182		* @since __DEPLOY_VERSION__
183		*/
184	9	public function save(CacheItemInterface $item)
185		{
186	9	if ($item instanceof HasExpirationDateInterface)
187	9	{
188	1	$ttl = $this->convertItemExpiryToSeconds($item);
189	1	}
190		else
191		{
192	8	$ttl = 0;
193		}
194
195	9	$this->driver->set($item->getKey(), $item->get(), $ttl);
196
197	9	return (bool) ($this->driver->getResultCode() == \Memcached::RES_SUCCESS);
198		}
199
200		/**
201		* Method to determine whether a storage entry has been set for a key.
202		*
203		* @param string $key The storage entry identifier.
204		*
205		* @return boolean
206		*
207		* @since 1.0
208		*/
209	4	public function hasItem($key)
210		{
211	4	$this->driver->get($key);
212
213	4	return ($this->driver->getResultCode() !== \Memcached::RES_NOTFOUND);
214		}
215
216		/**
217		* Test to see if the CacheItemPoolInterface is available
218		*
219		* @return boolean True on success, false otherwise
220		*
221		* @since __DEPLOY_VERSION__
222		*/
223	12	public static function isSupported()
224		{
225		/*
226		* GAE and HHVM have both had instances where Memcached the class was defined but no extension was loaded.
227		* If the class is there, we can assume it works.
228		*/
229	12	return (class_exists('Memcached'));
230		}
231		}
232

joomla-framework / cache

Push — 2.0-dev ( 04c5d6...e14a69 )

Memcached::isSupported() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like