class PredisCache in Zircon Profile 8

Predis cache provider.

@author othillo <[e-mail]>

Hierarchy

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

1 file declares its use of PredisCache

PredisCacheTest.php in vendor/doctrine/cache/tests/Doctrine/Tests/Common/Cache/PredisCacheTest.php

File

vendor/doctrine/cache/lib/Doctrine/Common/Cache/PredisCache.php, line 12

Namespace

Doctrine\Common\Cache

class PredisCache extends CacheProvider {

  /**
   * @var Client
   */
  private $client;

  /**
   * @param Client $client
   *
   * @return void
   */
  public function __construct(Client $client) {
    $this->client = $client;
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    $result = $this->client
      ->get($id);
    if (null === $result) {
      return false;
    }
    return unserialize($result);
  }

  /**
   * {@inheritdoc}
   */
  protected function doFetchMultiple(array $keys) {
    $fetchedItems = call_user_func_array(array(
      $this->client,
      'mget',
    ), $keys);
    return array_filter(array_combine($keys, array_map('unserialize', $fetchedItems)));
  }

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

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    $data = serialize($data);
    if ($lifeTime > 0) {
      $response = $this->client
        ->setex($id, $lifeTime, $data);
    }
    else {
      $response = $this->client
        ->set($id, $data);
    }
    return $response === true || $response == 'OK';
  }

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

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    $response = $this->client
      ->flushdb();
    return $response === true || $response == 'OK';
  }

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

}

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 in the current cache namespace. 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, globally. 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
PredisCache::$client	private	property
PredisCache::doContains	protected	function	Tests if an entry exists in the cache. Overrides CacheProvider::doContains
PredisCache::doDelete	protected	function	Deletes a cache entry. Overrides CacheProvider::doDelete
PredisCache::doFetch	protected	function	Fetches an entry from the cache. Overrides CacheProvider::doFetch
PredisCache::doFetchMultiple	protected	function	Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it. Overrides CacheProvider::doFetchMultiple
PredisCache::doFlush	protected	function	Flushes all cache entries. Overrides CacheProvider::doFlush
PredisCache::doGetStats	protected	function	Retrieves cached information from the data store. Overrides CacheProvider::doGetStats
PredisCache::doSave	protected	function	Puts data into the cache. Overrides CacheProvider::doSave
PredisCache::__construct	public	function