ClassInterface Zend_Cache_Backend_ExtendedInterface

Description
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Cache/Backend/ExtendedInterface.php (line 34)

Zend_Cache_Backend_Interface
   |
   --Zend_Cache_Backend_ExtendedInterface
Method Summary
 array getCapabilities ()
 array getIds ()
 array getIdsMatchingAnyTags ([array $tags = array()])
 array getIdsMatchingTags ([array $tags = array()])
 array getIdsNotMatchingTags ([array $tags = array()])
 array getMetadatas (string $id)
 array getTags ()
 boolean touch (string $id, int $extraLifetime)
Methods
getCapabilities (line 124)

Return an associative array of capabilities (booleans) of the backend

The array must include these keys :

  • automatic_cleaning (is automating cleaning necessary)
  • tags (are tags supported)
  • expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example))
  • priority does the backend deal with priority when saving
  • infinite_lifetime (is infinite lifetime can work with this backend)
  • get_list (is it possible to get the list of cache ids and the complete list of tags)

  • return: associative of with capabilities
  • access: public
array getCapabilities ()
getFillingPercentage (line 86)

Return the filling percentage of the backend storage

  • return: integer between 0 and 100
  • access: public
int getFillingPercentage ()
getIds (line 42)

Return an array of stored cache ids

  • return: array of stored cache ids (string)
  • access: public
array getIds ()
getIdsMatchingAnyTags (line 79)

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags

  • return: array of any matching cache ids (string)
  • access: public
array getIdsMatchingAnyTags ([array $tags = array()])
  • array $tags: array of tags
getIdsMatchingTags (line 59)

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

  • return: array of matching cache ids (string)
  • access: public
array getIdsMatchingTags ([array $tags = array()])
  • array $tags: array of tags
getIdsNotMatchingTags (line 69)

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

  • return: array of not matching cache ids (string)
  • access: public
array getIdsNotMatchingTags ([array $tags = array()])
  • array $tags: array of tags
getMetadatas (line 99)

Return an array of metadatas for the given cache id

The array must include these keys :

  • expire : the expire timestamp
  • tags : a string array of tags
  • mtime : timestamp of last modification time

  • return: array of metadatas (false if the cache id is not found)
  • access: public
array getMetadatas (string $id)
  • string $id: cache id
getTags (line 49)

Return an array of stored tags

  • return: array of stored tags (string)
  • access: public
array getTags ()
touch (line 108)

Give (if possible) an extra lifetime to the given cache id

  • return: true if ok
  • access: public
boolean touch (string $id, int $extraLifetime)
  • string $id: cache id
  • int $extraLifetime

Inherited Methods

Inherited From Zend_Cache_Backend_Interface

 Zend_Cache_Backend_Interface::clean()
 Zend_Cache_Backend_Interface::load()
 Zend_Cache_Backend_Interface::remove()
 Zend_Cache_Backend_Interface::save()
 Zend_Cache_Backend_Interface::setDirectives()
 Zend_Cache_Backend_Interface::test()

Documentation generated on Mon, 21 Jun 2010 15:21:57 -0400 by phpDocumentor 1.4.3