Public Member Functions

Zend_Cache_Backend_ExtendedInterface Interface Reference

Inheritance diagram for Zend_Cache_Backend_ExtendedInterface:
Zend_Cache_Backend_Interface Zend_Cache_Backend_Apc Zend_Cache_Backend_File Zend_Cache_Backend_Memcached Zend_Cache_Backend_Sqlite Zend_Cache_Backend_TwoLevels

Public Member Functions

 getIds ()
 getTags ()
 getIdsMatchingTags ($tags=array())
 getIdsNotMatchingTags ($tags=array())
 getIdsMatchingAnyTags ($tags=array())
 getFillingPercentage ()
 getMetadatas ($id)
 touch ($id, $extraLifetime)
 getCapabilities ()

Detailed Description

Definition at line 34 of file ExtendedInterface.php.


Member Function Documentation

getCapabilities (  )

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)
Returns:
array associative of with capabilities

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getFillingPercentage (  )

Return the filling percentage of the backend storage

Returns:
int integer between 0 and 100

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getIds (  )

Return an array of stored cache ids

Returns:
array array of stored cache ids (string)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getIdsMatchingAnyTags ( tags = array() )

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

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

Parameters:
array$tagsarray of tags
Returns:
array array of any matching cache ids (string)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getIdsMatchingTags ( tags = array() )

Return an array of stored cache ids which match given tags

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

Parameters:
array$tagsarray of tags
Returns:
array array of matching cache ids (string)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getIdsNotMatchingTags ( tags = array() )

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

Parameters:
array$tagsarray of tags
Returns:
array array of not matching cache ids (string)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getMetadatas ( id )

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
Parameters:
string$idcache id
Returns:
array array of metadatas (false if the cache id is not found)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

getTags (  )

Return an array of stored tags

Returns:
array array of stored tags (string)

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.

touch ( id,
extraLifetime 
)

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

Parameters:
string$idcache id
int$extraLifetime
Returns:
boolean true if ok

Implemented in Zend_Cache_Backend_Apc, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Sqlite, and Zend_Cache_Backend_TwoLevels.


The documentation for this interface was generated from the following file: