Public Member Functions | Data Fields

Zend_Cache_Backend_Apc Class Reference

Inheritance diagram for Zend_Cache_Backend_Apc:
Zend_Cache_Backend Zend_Cache_Backend_ExtendedInterface Zend_Cache_Backend_Interface

Public Member Functions

 __construct (array $options=array())
 load ($id, $doNotTestCacheValidity=false)
 test ($id)
 save ($data, $id, $tags=array(), $specificLifetime=false)
 remove ($id)
 clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
 isAutomaticCleaningAvailable ()
 getFillingPercentage ()
 getTags ()
 getIdsMatchingTags ($tags=array())
 getIdsNotMatchingTags ($tags=array())
 getIdsMatchingAnyTags ($tags=array())
 getIds ()
 getMetadatas ($id)
 touch ($id, $extraLifetime)
 getCapabilities ()

Data Fields

const TAGS_UNSUPPORTED_BY_CLEAN_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::clean() : tags are unsupported by the Apc backend'
const TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::save() : tags are unsupported by the Apc backend'

Detailed Description

Definition at line 41 of file Apc.php.


Constructor & Destructor Documentation

__construct ( array $  options = array() )

Constructor

Parameters:
array$optionsassociative array of options
Exceptions:
Zend_Cache_Exception
Returns:
void

Reimplemented from Zend_Cache_Backend.

Definition at line 56 of file Apc.php.


Member Function Documentation

clean ( mode = Zend_Cache::CLEANING_MODE_ALL,
tags = array() 
)

Clean some cache records

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => unsupported 'matchingTag' => unsupported 'notMatchingTag' => unsupported 'matchingAnyTag' => unsupported

Parameters:
string$modeclean mode
array$tagsarray of tags
Exceptions:
Zend_Cache_Exception
Returns:
boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 145 of file Apc.php.

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

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 343 of file Apc.php.

getFillingPercentage (  )

Return the filling percentage of the backend storage

Exceptions:
Zend_Cache_Exception
Returns:
int integer between 0 and 100

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 184 of file Apc.php.

getIds (  )

Return an array of stored cache ids

Returns:
array array of stored cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 257 of file Apc.php.

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 246 of file Apc.php.

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 218 of file Apc.php.

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 232 of file Apc.php.

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 279 of file Apc.php.

getTags (  )

Return an array of stored tags

Returns:
array array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 204 of file Apc.php.

isAutomaticCleaningAvailable (  )

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Deprecated:
Returns:
boolean

Reimplemented from Zend_Cache_Backend.

Definition at line 173 of file Apc.php.

load ( id,
doNotTestCacheValidity = false 
)

Test if a cache is available for the given id and (if yes) return it (false else)

WARNING $doNotTestCacheValidity=true is unsupported by the Apc backend

Parameters:
string$idcache id
boolean$doNotTestCacheValidityif set to true, the cache validity won't be tested
Returns:
string cached datas (or false)

Implements Zend_Cache_Backend_Interface.

Definition at line 73 of file Apc.php.

remove ( id )

Remove a cache record

Parameters:
string$idcache id
Returns:
boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 125 of file Apc.php.

save ( data,
id,
tags = array(),
specificLifetime = false 
)

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

Parameters:
string$datadatas to cache
string$idcache id
array$tagsarray of strings, the cache record will be tagged by each string entry
int$specificLifetimeif != false, set a specific lifetime for this cache record (null => infinite lifetime)
Returns:
boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 109 of file Apc.php.

test ( id )

Test if a cache is available or not (for the given id)

Parameters:
string$idcache id
Returns:
mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Implements Zend_Cache_Backend_Interface.

Definition at line 88 of file Apc.php.

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

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 307 of file Apc.php.


Field Documentation

const TAGS_UNSUPPORTED_BY_CLEAN_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::clean() : tags are unsupported by the Apc backend'

Log message

Definition at line 46 of file Apc.php.


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