class RedisCache

Redis cache provider.

@license http://www.opensource.org/licenses/lgpl-license.php LGPL @link www.doctrine-project.org @since 2.2 @author Osman Ungur <osmanungur@gmail.com>

Hierarchy

Expanded class hierarchy of RedisCache

1 file declares its use of RedisCache
RedisCacheTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Cache/RedisCacheTest.php

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Cache/RedisCache.php, line 33

Namespace

Doctrine\Common\Cache
View source
class RedisCache extends CacheProvider {

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

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

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

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

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

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

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

  /**
   * {@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_AVAILIABLE => false,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Cache::STATS_HITS constant
Cache::STATS_MEMORY_AVAILIABLE constant
Cache::STATS_MEMORY_USAGE constant
Cache::STATS_MISSES constant
Cache::STATS_UPTIME constant
CacheProvider::$namespace private property
CacheProvider::$namespaceVersion private property
CacheProvider::contains public function Test 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 Delete all cache entries.
CacheProvider::DOCTRINE_NAMESPACE_CACHEKEY constant
CacheProvider::fetch public function Fetches an entry from the cache. Overrides Cache::fetch
CacheProvider::flushAll public function Deletes all cache entries.
CacheProvider::getNamespace public function Retrieve the namespace that prefixes all cache ids.
CacheProvider::getNamespaceCacheKey private function Namespace cache key
CacheProvider::getNamespacedId private function Prefix the passed id with the configured namespace value
CacheProvider::getNamespaceVersion private function Namespace version
CacheProvider::getStats public function Retrieves cached information from data store Overrides Cache::getStats
CacheProvider::save public function Puts data into the cache. Overrides Cache::save
CacheProvider::setNamespace public function Set the namespace to prefix all cache ids with.
RedisCache::$redis private property
RedisCache::doContains protected function Test 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::doFlush protected function Deletes all cache entries. Overrides CacheProvider::doFlush
RedisCache::doGetStats protected function Retrieves cached information from 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::setRedis public function Sets the redis instance to use.