class RedisCache in Plug 7

Redis cache provider.

@link www.doctrine-project.org @since 2.2 @author Osman Ungur <[e-mail]>

Hierarchy

• class \Doctrine\Common\Cache\CacheProvider implements Cache, ClearableCache, FlushableCache, MultiGetCache
  • class \Doctrine\Common\Cache\RedisCache

1 file declares its use of RedisCache

RedisCacheTest.php in lib/doctrine/cache/tests/Doctrine/Tests/Common/Cache/RedisCacheTest.php

File

lib/doctrine/cache/lib/Doctrine/Common/Cache/RedisCache.php, line 31

Namespace

Doctrine\Common\Cache

class RedisCache extends CacheProvider {

  /**
   * @var Redis|null
   */
  private $redis;

  /**
   * Sets the redis instance to use.
   *
   * @param Redis $redis
   *
   * @return void
   */
  public function setRedis(Redis $redis) {
    $redis
      ->setOption(Redis::OPT_SERIALIZER, $this
      ->getSerializerValue());
    $this->redis = $redis;
  }

  /**
   * Gets the redis instance used by the cache.
   *
   * @return Redis|null
   */
  public function getRedis() {
    return $this->redis;
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    return $this->redis
      ->get($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetchMultiple(array $keys) {
    $returnValues = array();
    $fetchedItems = $this->redis
      ->mget($keys);
    foreach ($keys as $key) {
      if (isset($fetchedItems[$key])) {
        $returnValues[$key] = $fetchedItems[$key];
      }
    }
    return $returnValues;
  }

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return $this->redis
      ->exists($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    if ($lifeTime > 0) {
      return $this->redis
        ->setex($id, $lifeTime, $data);
    }
    return $this->redis
      ->set($id, $data);
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    return $this->redis
      ->delete($id) > 0;
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    return $this->redis
      ->flushDB();
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $info = $this->redis
      ->info();
    return array(
      Cache::STATS_HITS => false,
      Cache::STATS_MISSES => false,
      Cache::STATS_UPTIME => $info['uptime_in_seconds'],
      Cache::STATS_MEMORY_USAGE => $info['used_memory'],
      Cache::STATS_MEMORY_AVAILABLE => false,
    );
  }

  /**
   * Returns the serializer constant to use. If Redis is compiled with
   * igbinary support, that is used. Otherwise the default PHP serializer is
   * used.
   *
   * @return integer One of the Redis::SERIALIZER_* constants
   */
  protected function getSerializerValue() {
    if (defined('HHVM_VERSION')) {
      return Redis::SERIALIZER_PHP;
    }
    return defined('Redis::SERIALIZER_IGBINARY') ? Redis::SERIALIZER_IGBINARY : Redis::SERIALIZER_PHP;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cache::STATS_HITS		constant
Cache::STATS_MEMORY_AVAILABLE		constant
Cache::STATS_MEMORY_AVAILIABLE		constant	Only for backward compatibility (may be removed in next major release)
Cache::STATS_MEMORY_USAGE		constant
Cache::STATS_MISSES		constant
Cache::STATS_UPTIME		constant
CacheProvider::$namespace	private	property	The namespace to prefix all cache ids with.
CacheProvider::$namespaceVersion	private	property	The namespace version.
CacheProvider::contains	public	function	Tests if an entry exists in the cache. Overrides Cache::contains
CacheProvider::delete	public	function	Deletes a cache entry. Overrides Cache::delete
CacheProvider::deleteAll	public	function	Deletes all cache entries. Overrides ClearableCache::deleteAll
CacheProvider::DOCTRINE_NAMESPACE_CACHEKEY		constant
CacheProvider::fetch	public	function	Fetches an entry from the cache. Overrides Cache::fetch
CacheProvider::fetchMultiple	public	function	Returns an associative array of values for keys is found in cache. Overrides MultiGetCache::fetchMultiple
CacheProvider::flushAll	public	function	Flushes all cache entries. Overrides FlushableCache::flushAll
CacheProvider::getNamespace	public	function	Retrieves the namespace that prefixes all cache ids.
CacheProvider::getNamespaceCacheKey	private	function	Returns the namespace cache key.
CacheProvider::getNamespacedId	private	function	Prefixes the passed id with the configured namespace value.
CacheProvider::getNamespaceVersion	private	function	Returns the namespace version.
CacheProvider::getStats	public	function	Retrieves cached information from the data store. Overrides Cache::getStats
CacheProvider::save	public	function	Puts data into the cache. Overrides Cache::save
CacheProvider::setNamespace	public	function	Sets the namespace to prefix all cache ids with.	1
RedisCache::$redis	private	property
RedisCache::doContains	protected	function	Tests if an entry exists in the cache. Overrides CacheProvider::doContains
RedisCache::doDelete	protected	function	Deletes a cache entry. Overrides CacheProvider::doDelete
RedisCache::doFetch	protected	function	Fetches an entry from the cache. Overrides CacheProvider::doFetch
RedisCache::doFetchMultiple	protected	function	Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it. Overrides CacheProvider::doFetchMultiple
RedisCache::doFlush	protected	function	Flushes all cache entries. Overrides CacheProvider::doFlush
RedisCache::doGetStats	protected	function	Retrieves cached information from the data store. Overrides CacheProvider::doGetStats
RedisCache::doSave	protected	function	Puts data into the cache. Overrides CacheProvider::doSave
RedisCache::getRedis	public	function	Gets the redis instance used by the cache.
RedisCache::getSerializerValue	protected	function	Returns the serializer constant to use. If Redis is compiled with igbinary support, that is used. Otherwise the default PHP serializer is used.
RedisCache::setRedis	public	function	Sets the redis instance to use.