Joomla\Cache\Tests\ConcreteCache

Complexity

Total Complexity

11

Size/Duplication

Total Lines	179
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	9
Bugs	3	Features	0

<?php
class ConcreteCache extends Cache
{
	/**
	 * @var    \ArrayObject  Database of cached items,
	 * we use ArrayObject so it can be easily
	 * passed by reference
	 *
	 * @since  1.1
	 */
	protected $db;

	/**
	 * Constructor.
	 *
	 * @param   mixed  $options  An options array, or an object that implements \ArrayAccess
	 *
	 * @since   1.0
	 * @throws  \RuntimeException
	 */
	public function __construct($options = array())
	{
		parent::__construct($options);
		$this->db = new \ArrayObject;
	}

	/**
	 * This will wipe out the entire cache's keys
	 *
	 * @return  boolean  The result of the clear operation.
	 *
	 * @since   1.0
	 */
	public function clear()
	{
		// Replace the db with a new blank array
		$clearData = $this->db->exchangeArray(array());
		unset($clearData);

		return true;
	}

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

		return $item;
	}

	/**
	 * 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)
	{
		$item = new Item($key);

		try
		{
			$value = $this->getValue($key);
			$item->set($value);
		}
		catch ( \Exception $e)
		{
			/**
			 * Backend caching mechanisms may throw exceptions
			 * to indicate missing data.  Catch all exceptions
			 * so program flow is uninterrupted.  For misses
			 * we can safely do nothing and return the
			 * CacheItem we created since it flags itself as
			 * a miss when constructed.  Specific cache classes
			 * should override this method and deal with
			 * exceptions appropriately.
			 */
		}

		return $item;
	}

	/**
	 * Method to get a storage entry value from a key.
	 *
	 * @param   string  $key  The storage entry identifier.
	 *
	 * @return  mixed
	 *
	 * @since   1.0
	 * @throws  \Exception
	 */
	public function getValue($key)
	{
		try
		{
			$value = $this->db[$key];
		}
		catch ( \Exception $e)
		{
			/**
			 * Backend caching mechanisms may throw exceptions
			 * to indicate missing data.  Catch all exceptions
			 * so program flow is uninterrupted.  If the exception
			 * can be recovered from gracefully, do so.  If not
			 * re-throw the exception.  As with getItem() this
			 * logic must be added for specific cache engine
			 * test suites.
			 */
			throw $e;
		}
		return $value;
	}

	/**
	 * Method to remove a storage entry for a key.
	 *
	 * @param   string  $key  The storage entry identifier.
	 *
	 * @return  boolean
	 *
	 * @since   1.0
	 */
	public function deleteItem($key)
	{
		$oldCache = $this->db->getArrayCopy();

		if (array_key_exists($key, $oldCache))
		{
			$keyArray = array($key => $key);
			$newCache = array_diff_key($oldCache, $keyArray);
			$this->db->exchangeArray($newCache);

			return true;
		}

		return true;
	}

	/**
	 * Method to set a value for a storage entry.
	 *
	 * @param   CacheItemInterface  $item  The cache item to save.
	 *
	 * @return  boolean
	 *
	 * @since   1.0
	 */
	public function save(CacheItemInterface $item)
	{
		$this->db[$item->getKey()] = $item->get();

		return true;
	}

	/**
	 * 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)
	{
		return array_key_exists($key, $this->db);
	}
}