class XcacheCache

Xcache cache driver.

@license http://www.opensource.org/licenses/lgpl-license.php LGPL @link www.doctrine-project.org @since 2.0 @author Benjamin Eberlei <kontakt@beberlei.de> @author Guilherme Blanco <guilhermeblanco@hotmail.com> @author Jonathan Wage <jonwage@gmail.com> @author Roman Borschel <roman@code-factory.org> @author David Abdemoulaie <dave@hobodave.com>

Hierarchy

Expanded class hierarchy of XcacheCache

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

File

drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Cache/XcacheCache.php, line 35

Namespace

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

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

  /**
   * {@inheritdoc}
   */
  protected function doContains($id) {
    return xcache_isset($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doSave($id, $data, $lifeTime = 0) {
    return xcache_set($id, serialize($data), (int) $lifeTime);
  }

  /**
   * {@inheritdoc}
   */
  protected function doDelete($id) {
    return xcache_unset($id);
  }

  /**
   * {@inheritdoc}
   */
  protected function doFlush() {
    $this
      ->checkAuthorization();
    xcache_clear_cache(XC_TYPE_VAR, 0);
    return true;
  }

  /**
   * Checks that xcache.admin.enable_auth is Off
   *
   * @throws \BadMethodCallException When xcache.admin.enable_auth is On
   * @return void
   */
  protected function checkAuthorization() {
    if (ini_get('xcache.admin.enable_auth')) {
      throw new \BadMethodCallException('To use all features of \\Doctrine\\Common\\Cache\\XcacheCache, you must set "xcache.admin.enable_auth" to "Off" in your php.ini.');
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function doGetStats() {
    $this
      ->checkAuthorization();
    $info = xcache_info(XC_TYPE_VAR, 0);
    return array(
      Cache::STATS_HITS => $info['hits'],
      Cache::STATS_MISSES => $info['misses'],
      Cache::STATS_UPTIME => null,
      Cache::STATS_MEMORY_USAGE => $info['size'],
      Cache::STATS_MEMORY_AVAILIABLE => $info['avail'],
    );
  }

}

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.
XcacheCache::checkAuthorization protected function Checks that xcache.admin.enable_auth is Off
XcacheCache::doContains protected function Test if an entry exists in the cache. Overrides CacheProvider::doContains
XcacheCache::doDelete protected function Deletes a cache entry. Overrides CacheProvider::doDelete
XcacheCache::doFetch protected function Fetches an entry from the cache. Overrides CacheProvider::doFetch
XcacheCache::doFlush protected function Deletes all cache entries. Overrides CacheProvider::doFlush
XcacheCache::doGetStats protected function Retrieves cached information from data store Overrides CacheProvider::doGetStats
XcacheCache::doSave protected function Puts data into the cache. Overrides CacheProvider::doSave