Apcu::save() - Code Metrics - Inspection of "Merge pull request #24 from joomla-framework/psr-1..." - joomla-framework/cache - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 2.0-dev ( 574eeb...e9e84c )

by George

created 2017-05-29 09:44 UTC

Apcu::save() A

↳ Parent: Apcu

Complexity

Conditions	2
Paths	2

Size

Total Lines	14
Code Lines	6

Duplication

Lines	14
Ratio	100 %

Code Coverage

Tests	7
CRAP Score	2

Importance

Changes

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

<?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\Item\HasExpirationDateInterface;
use Joomla\Cache\Item\Item;
use Psr\Cache\CacheItemInterface;

/**
 * APCu cache driver for the Joomla Framework.
 *
 * @since  __DEPLOY_VERSION__
 */
class Apcu extends AbstractCacheItemPool

{
	/**
	 * This will wipe out the entire cache's keys
	 *
	 * @return  boolean  True if the pool was successfully cleared. False if there was an error.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function clear()
	{
		return apcu_clear_cache();
	}

	/**
	 * Returns a Cache Item representing the specified key.
	 *
	 * @param   string  $key  The key for which to return the corresponding Cache Item.
	 *
	 * @return  CacheItemInterface  The corresponding Cache Item.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function getItem($key)
	{
		$success = false;
		$value = apcu_fetch($key, $success);
		$item = new Item($key);

		if ($success)
		{
			$item->set($value);
		}

		return $item;
	}

	/**
	 * Returns a traversable set of cache items.
	 *
	 * @param   string[]  $keys  An indexed array of keys of items to retrieve.
	 *
	 * @return  array  A traversable collection of Cache Items keyed by the cache keys of each item.
	 *                 A Cache item will be returned for each key, even if that key is not found.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function getItems(array $keys = [])
	{
		$items   = [];
		$success = false;
		$values  = apcu_fetch($keys, $success);

		if ($success && is_array($values))
		{
			foreach ($keys as $key)
			{
				$items[$key] = new Item($key);

				if (isset($values[$key]))
				{
					$items[$key]->set($values[$key]);
				}
			}
		}

		return $items;
	}

	/**
	 * Removes the item from the pool.
	 *
	 * @param   string  $key  The key to delete.
	 *
	 * @return  boolean  True if the item was successfully removed. False if there was an error.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function deleteItem($key)
	{
		if ($this->hasItem($key))
		{
			return apcu_delete($key);

		}

		// If the item doesn't exist, no error
		return true;
	}

	/**
	 * Persists a cache item immediately.
	 *
	 * @param   CacheItemInterface  $item  The cache item to save.
	 *
	 * @return  boolean  True if the item was successfully persisted. False if there was an error.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function save(CacheItemInterface $item)
	{
		// If we are able to find out when the item expires - find out. Else bail.
		if ($item instanceof HasExpirationDateInterface)
		{
			$ttl = $this->convertItemExpiryToSeconds($item);
		}
		else
		{
			$ttl = 0;
		}

		return apcu_store($item->getKey(), $item->get(), $ttl);

	}

	/**
	 * Confirms if the cache contains specified cache item.
	 *
	 * @param   string  $key  The key for which to check existence.
	 *
	 * @return  boolean  True if item exists in the cache, false otherwise.
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public function hasItem($key)
	{
		return apcu_exists($key);

	}

	/**
	 * Test to see if the CacheItemPoolInterface is available
	 *
	 * @return  boolean  True on success, false otherwise
	 *
	 * @since   __DEPLOY_VERSION__
	 */
	public static function isSupported()
	{
		$supported = extension_loaded('apcu') && ini_get('apc.enabled');

		// If on the CLI interface, the `apc.enable_cli` option must also be enabled
		if ($supported && php_sapi_name() === 'cli')
		{
			$supported = ini_get('apc.enable_cli');
		}

		return (bool) $supported;
	}
}


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\Item\HasExpirationDateInterface;
13			use Joomla\Cache\Item\Item;
14			use Psr\Cache\CacheItemInterface;
15
16			/**
17			* APCu cache driver for the Joomla Framework.
18			*
19			* @since __DEPLOY_VERSION__
20			*/
21		View Code Duplication	class Apcu extends AbstractCacheItemPool
			0 ignored issues – show Duplication introduced 2016-03-31 20:13 UTC by Report Bug Copy Issue Report This class seems to be duplicated in 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...
22			{
23			/**
24			* This will wipe out the entire cache's keys
25			*
26			* @return boolean True if the pool was successfully cleared. False if there was an error.
27			*
28			* @since __DEPLOY_VERSION__
29			*/
30	18		public function clear()
31			{
32	18		return apcu_clear_cache();
33			}
34
35			/**
36			* Returns a Cache Item representing the specified key.
37			*
38			* @param string $key The key for which to return the corresponding Cache Item.
39			*
40			* @return CacheItemInterface The corresponding Cache Item.
41			*
42			* @since __DEPLOY_VERSION__
43			*/
44	9		public function getItem($key)
45			{
46	9		$success = false;
47	9		$value = apcu_fetch($key, $success);
48	9		$item = new Item($key);
49
50			if ($success)
51	9		{
52	7		$item->set($value);
53	7		}
54
55	9		return $item;
56			}
57
58			/**
59			* Returns a traversable set of cache items.
60			*
61			* @param string[] $keys An indexed array of keys of items to retrieve.
62			*
63			* @return array A traversable collection of Cache Items keyed by the cache keys of each item.
64			* A Cache item will be returned for each key, even if that key is not found.
65			*
66			* @since __DEPLOY_VERSION__
67			*/
68	4		public function getItems(array $keys = [])
69			{
70	4		$items = [];
71	4		$success = false;
72	4		$values = apcu_fetch($keys, $success);
73
74	4		if ($success && is_array($values))
75	4		{
76	4		foreach ($keys as $key)
77			{
78	4		$items[$key] = new Item($key);
79
80	4		if (isset($values[$key]))
81	4		{
82	2		$items[$key]->set($values[$key]);
83	2		}
84	4		}
85	4		}
86
87	4		return $items;
88			}
89
90			/**
91			* Removes the item from the pool.
92			*
93			* @param string $key The key to delete.
94			*
95			* @return boolean True if the item was successfully removed. False if there was an error.
96			*
97			* @since __DEPLOY_VERSION__
98			*/
99	4		public function deleteItem($key)
100			{
101	4		if ($this->hasItem($key))
102	4		{
103	4		return apcu_delete($key);
			0 ignored issues – show Bug Compatibility introduced 2016-12-18 15:16 UTC by Report Bug Copy Issue Report The expression `apcu_delete($key);` of type `boolean\|string[]` adds the type `string[]` to the return on line 103 which is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::deleteItem` of type `boolean`. Loading history...
104			}
105
106			// If the item doesn't exist, no error
107	4		return true;
108			}
109
110			/**
111			* Persists a cache item immediately.
112			*
113			* @param CacheItemInterface $item The cache item to save.
114			*
115			* @return boolean True if the item was successfully persisted. False if there was an error.
116			*
117			* @since __DEPLOY_VERSION__
118			*/
119	15		public function save(CacheItemInterface $item)
120			{
121			// If we are able to find out when the item expires - find out. Else bail.
122	15		if ($item instanceof HasExpirationDateInterface)
123	15		{
124	7		$ttl = $this->convertItemExpiryToSeconds($item);
125	7		}
126			else
127			{
128	8		$ttl = 0;
129			}
130
131	15		return apcu_store($item->getKey(), $item->get(), $ttl);
			0 ignored issues – show Bug Compatibility introduced 2016-12-18 15:16 UTC by Report Bug Copy Issue Report The expression `apcu_store($item->getKey(), $item->get(), $ttl);` of type `boolean\|array` adds the type `array` to the return on line 131 which is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::save` of type `boolean`. Loading history...
132			}
133
134			/**
135			* Confirms if the cache contains specified cache item.
136			*
137			* @param string $key The key for which to check existence.
138			*
139			* @return boolean True if item exists in the cache, false otherwise.
140			*
141			* @since __DEPLOY_VERSION__
142			*/
143	8		public function hasItem($key)
144			{
145	8		return apcu_exists($key);
			0 ignored issues – show Bug Compatibility introduced 2016-12-18 15:16 UTC by Report Bug Copy Issue Report The expression `apcu_exists($key);` of type `boolean\|string[]` adds the type `string[]` to the return on line 145 which is incompatible with the return type declared by the interface `Psr\Cache\CacheItemPoolInterface::hasItem` of type `boolean`. Loading history...
146			}
147
148			/**
149			* Test to see if the CacheItemPoolInterface is available
150			*
151			* @return boolean True on success, false otherwise
152			*
153			* @since __DEPLOY_VERSION__
154			*/
155	18		public static function isSupported()
156			{
157	18		$supported = extension_loaded('apcu') && ini_get('apc.enabled');
158
159			// If on the CLI interface, the `apc.enable_cli` option must also be enabled
160	18		if ($supported && php_sapi_name() === 'cli')
161	18		{
162	18		$supported = ini_get('apc.enable_cli');
163	18		}
164
165	18		return (bool) $supported;
166			}
167			}
168

joomla-framework / cache

Push — 2.0-dev ( 574eeb...e9e84c )

Apcu::save() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like