You are here

class XcacheCache in Plug 7

Xcache cache driver.

@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 lib/doctrine/cache/tests/Doctrine/Tests/Common/Cache/XcacheCacheTest.php

File

lib/doctrine/cache/lib/Doctrine/Common/Cache/XcacheCache.php, line 33

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);
    return true;
  }

  /**
   * Checks that xcache.admin.enable_auth is Off.
   *
   * @return void
   *
   * @throws \BadMethodCallException When xcache.admin.enable_auth is On.
   */
  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_AVAILABLE => $info['avail'],
    );
  }

}

Members

Namesort descending 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::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. 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
XcacheCache::checkAuthorization protected function Checks that xcache.admin.enable_auth is Off.
XcacheCache::doContains protected function Tests 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 Flushes all cache entries. Overrides CacheProvider::doFlush
XcacheCache::doGetStats protected function Retrieves cached information from the data store. Overrides CacheProvider::doGetStats
XcacheCache::doSave protected function Puts data into the cache. Overrides CacheProvider::doSave