interface Cache in Plug 7

Interface for cache drivers.

@link www.doctrine-project.org @since 2.0 @author Benjamin Eberlei <[e-mail]> @author Guilherme Blanco <[e-mail]> @author Jonathan Wage <[e-mail]> @author Roman Borschel <[e-mail]> @author Fabio B. Silva <[e-mail]> @author Kévin Dunglas <[e-mail]>

Hierarchy

• interface \Doctrine\Common\Cache\Cache

9 files declare their use of Cache

AbstractClassMetadataFactory.php in lib/doctrine/common/lib/Doctrine/Common/Persistence/Mapping/AbstractClassMetadataFactory.php

CachedReader.php in lib/doctrine/annotations/lib/Doctrine/Common/Annotations/CachedReader.php

CacheTest.php in lib/doctrine/cache/tests/Doctrine/Tests/Common/Cache/CacheTest.php

DoctrineCache.php in lib/Symfony/validator/Symfony/Component/Validator/Mapping/Cache/DoctrineCache.php

FileCacheTest.php in lib/doctrine/cache/tests/Doctrine/Tests/Common/Cache/FileCacheTest.php

... See full list

File

lib/doctrine/cache/lib/Doctrine/Common/Cache/Cache.php, line 34

Namespace

Doctrine\Common\Cache

interface Cache {
  const STATS_HITS = 'hits';
  const STATS_MISSES = 'misses';
  const STATS_UPTIME = 'uptime';
  const STATS_MEMORY_USAGE = 'memory_usage';
  const STATS_MEMORY_AVAILABLE = 'memory_available';

  /**
   * Only for backward compatibility (may be removed in next major release)
   *
   * @deprecated
   */
  const STATS_MEMORY_AVAILIABLE = 'memory_available';

  /**
   * Fetches an entry from the cache.
   *
   * @param string $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.
   */
  public function fetch($id);

  /**
   * Tests if an entry exists in the cache.
   *
   * @param string $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.
   */
  public 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 cache 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.
   */
  public function save($id, $data, $lifeTime = 0);

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

  /**
   * Retrieves cached information from the 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
   *
   * @return array|null An associative array with server's statistics if available, NULL otherwise.
   */
  public function getStats();

}

Members

Name	Modifiers	Type	Description	Overrides
Cache::contains	public	function	Tests if an entry exists in the cache.	1
Cache::delete	public	function	Deletes a cache entry.	1
Cache::fetch	public	function	Fetches an entry from the cache.	1
Cache::getStats	public	function	Retrieves cached information from the data store.	1
Cache::save	public	function	Puts data into the cache.	1
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