class CouchbaseCache in Zircon Profile 8

Couchbase cache provider.

@link www.doctrine-project.org @since 2.4 @author Michael Nitschinger <[e-mail]>

Hierarchy

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

1 file declares its use of CouchbaseCache

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

File

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

Namespace

Doctrine\Common\Cache

class CouchbaseCache extends CacheProvider {

  /**
   * @var Couchbase|null
   */
  private $couchbase;

  /**
   * Sets the Couchbase instance to use.
   *
   * @param Couchbase $couchbase
   *
   * @return void
   */
  public function setCouchbase(Couchbase $couchbase) {
    $this->couchbase = $couchbase;
  }

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

  /**
   * {@inheritdoc}
   */
  protected function doFetch($id) {
    return $this->couchbase
      ->get($id) ?: false;
  }

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return null !== $this->couchbase
      ->get($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    if ($lifeTime > 30 * 24 * 3600) {
      $lifeTime = time() + $lifeTime;
    }
    return $this->couchbase
      ->set($id, $data, (int) $lifeTime);
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $stats = $this->couchbase
      ->getStats();
    $servers = $this->couchbase
      ->getServers();
    $server = explode(":", $servers[0]);
    $key = $server[0] . ":" . "11210";
    $stats = $stats[$key];
    return array(
      Cache::STATS_HITS => $stats['get_hits'],
      Cache::STATS_MISSES => $stats['get_misses'],
      Cache::STATS_UPTIME => $stats['uptime'],
      Cache::STATS_MEMORY_USAGE => $stats['bytes'],
      Cache::STATS_MEMORY_AVAILABLE => $stats['limit_maxbytes'],
    );
  }

}

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::doFetchMultiple	protected	function	Default implementation of doFetchMultiple. Each driver that supports multi-get should owerwrite it.	4
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
CouchbaseCache::$couchbase	private	property
CouchbaseCache::doContains	protected	function	Tests if an entry exists in the cache. Overrides CacheProvider::doContains
CouchbaseCache::doDelete	protected	function	Deletes a cache entry. Overrides CacheProvider::doDelete
CouchbaseCache::doFetch	protected	function	Fetches an entry from the cache. Overrides CacheProvider::doFetch
CouchbaseCache::doFlush	protected	function	Flushes all cache entries. Overrides CacheProvider::doFlush
CouchbaseCache::doGetStats	protected	function	Retrieves cached information from the data store. Overrides CacheProvider::doGetStats
CouchbaseCache::doSave	protected	function	Puts data into the cache. Overrides CacheProvider::doSave
CouchbaseCache::getCouchbase	public	function	Gets the Couchbase instance used by the cache.
CouchbaseCache::setCouchbase	public	function	Sets the Couchbase instance to use.