interface Cache

Interface for cache drivers.

@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 Fabio B. Silva <fabio.bat.silva@gmail.com>

Hierarchy

  • interface \Doctrine\Common\Cache\Cache

Expanded class hierarchy of Cache

All classes that implement Cache

3 files declare their use of Cache
AbstractClassMetadataFactory.php in drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/AbstractClassMetadataFactory.php
CachedReader.php in drupal/core/vendor/doctrine/common/lib/Doctrine/Common/Annotations/CachedReader.php
CacheTest.php in drupal/core/vendor/doctrine/common/tests/Doctrine/Tests/Common/Cache/CacheTest.php
8 string references to 'Cache'
BackendChainImplementationUnitTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Cache/BackendChainImplementationUnitTest.php
BackendChainUnitTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Cache/BackendChainUnitTest.php
CacheTest::getInfo in drupal/core/modules/views/lib/Drupal/views/Tests/Plugin/CacheTest.php
ClearTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Cache/ClearTest.php
DatabaseBackendUnitTest::getInfo in drupal/core/modules/system/lib/Drupal/system/Tests/Cache/DatabaseBackendUnitTest.php

... See full list

File

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

Namespace

Doctrine\Common\Cache
View source
interface Cache {
  const STATS_HITS = 'hits';
  const STATS_MISSES = 'misses';
  const STATS_UPTIME = 'uptime';
  const STATS_MEMORY_USAGE = 'memory_usage';
  const STATS_MEMORY_AVAILIABLE = 'memory_available';

  /**
   * Fetches an entry from the cache.
   *
   * @param string $id cache id The id of the cache entry to fetch.
   * @return mixed The cached data or FALSE, if no cache entry exists for the given id.
   */
  function fetch($id);

  /**
   * Test if an entry exists in the cache.
   *
   * @param string $id cache id The cache id of the entry to check for.
   * @return boolean TRUE if a cache entry exists for the given cache id, FALSE otherwise.
   */
  function contains($id);

  /**
   * Puts data into the cache.
   *
   * @param string $id The cache id.
   * @param mixed $data The cache entry/data.
   * @param int $lifeTime The lifetime. If != 0, sets a specific lifetime for this cache entry (0 => infinite lifeTime).
   * @return boolean TRUE if the entry was successfully stored in the cache, FALSE otherwise.
   */
  function save($id, $data, $lifeTime = 0);

  /**
   * Deletes a cache entry.
   *
   * @param string $id cache id
   * @return boolean TRUE if the cache entry was successfully deleted, FALSE otherwise.
   */
  function delete($id);

  /**
   * Retrieves cached information from data store
   *
   * The server's statistics array has the following values:
   *
   * - <b>hits</b>
   * Number of keys that have been requested and found present.
   *
   * - <b>misses</b>
   * Number of items that have been requested and not found.
   *
   * - <b>uptime</b>
   * Time that the server is running.
   *
   * - <b>memory_usage</b>
   * Memory used by this server to store items.
   *
   * - <b>memory_available</b>
   * Memory allowed to use for storage.
   *
   * @since   2.2
   * @var     array Associative array with server's statistics if available, NULL otherwise.
   */
  function getStats();

}

Members

Namesort descending Modifiers Type Description Overrides
Cache::contains function Test if an entry exists in the cache. 1
Cache::delete function Deletes a cache entry. 1
Cache::fetch function Fetches an entry from the cache. 1
Cache::getStats function Retrieves cached information from data store 1
Cache::save function Puts data into the cache. 1
Cache::STATS_HITS constant
Cache::STATS_MEMORY_AVAILIABLE constant
Cache::STATS_MEMORY_USAGE constant
Cache::STATS_MISSES constant
Cache::STATS_UPTIME constant