Docs For Class Zend_Cache_Backend

Description

Implements interfaces:

Zend_Cache_Backend_Interface

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

Located in /Cache/Backend/Xcache.php (line 41)

Zend_Cache_Backend
   |
   --Zend_Cache_Backend_Xcache

Class Constant Summary

TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend'

TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::save() : tags are unsupported by the Xcache backend'

Variable Summary

array $_options

Method Summary

void __construct ([ $options = array()])

boolean clean ([string $mode = Zend_Cache::CLEANING_MODE_ALL], [array $tags = array()])

boolean isAutomaticCleaningAvailable ()

string load (string $id, [boolean $doNotTestCacheValidity = false])

boolean remove (string $id)

boolean save (string $data, string $id, [array $tags = array()], [int $specificLifetime = false])

mixed test (string $id)

Variables

array $_options = array(
'user' => null,
'password' => null
) (line 61)

Available options

=====> (string) user : xcache.admin.user (necessary for the clean() method)

=====> (string) password : xcache.admin.pass (clear, not MD5) (necessary for the clean() method)

var: available options
access: protected

Redefinition of:

Zend_Cache_Backend::$_options: Available options

Inherited Variables

Inherited from Zend_Cache_Backend

Zend_Cache_Backend::$_directives

Methods

Constructor __construct (line 73)

Constructor

throws: Zend_Cache_Exception
access: public

void __construct ([ $options = array()])

array $options: associative array of options

Redefinition of:

Zend_Cache_Backend::__construct(): Constructor

clean (line 167)

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

return: true if no problem
throws: Zend_Cache_Exception
access: public

boolean clean ([string $mode = Zend_Cache::CLEANING_MODE_ALL], [array $tags = array()])

string $mode: clean mode
array $tags: array of tags

Implementation of:

Zend_Cache_Backend_Interface::clean(): Clean some cache records

isAutomaticCleaningAvailable (line 211)

Return true if the automatic cleaning is available for the backend

access: public

boolean isAutomaticCleaningAvailable ()

Redefinition of:

Zend_Cache_Backend::isAutomaticCleaningAvailable(): Return true if the automatic cleaning is available for the backend

load (line 90)

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

WARNING $doNotTestCacheValidity=true is unsupported by the Xcache backend

return: cached datas (or false)
access: public

string load (string $id, [boolean $doNotTestCacheValidity = false])

string $id: cache id
boolean $doNotTestCacheValidity: if set to true, the cache validity won't be tested

Implementation of:

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

remove (line 147)

Remove a cache record

return: true if no problem
access: public

boolean remove (string $id)

string $id: cache id

Implementation of:

Zend_Cache_Backend_Interface::remove(): Remove a cache record

save (line 131)

Save some string datas into a cache record

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

return: true if no problem
access: public

boolean save (string $data, string $id, [array $tags = array()], [int $specificLifetime = false])

string $data: datas to cache
string $id: cache id
array $tags: array of strings, the cache record will be tagged by each string entry
int $specificLifetime: if != false, set a specific lifetime for this cache record (null => infinite lifetime)

Implementation of:

Zend_Cache_Backend_Interface::save(): Save some string datas into a cache record

test (line 108)

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

return: false (a cache is not available) or "last modified" timestamp (int) of the available cache record
access: public

mixed test (string $id)

string $id: cache id

Implementation of:

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

Inherited Methods

Inherited From Zend_Cache_Backend

Zend_Cache_Backend::__construct()
Zend_Cache_Backend::getLifetime()
Zend_Cache_Backend::getTmpDir()
Zend_Cache_Backend::isAutomaticCleaningAvailable()
Zend_Cache_Backend::setDirectives()
Zend_Cache_Backend::setOption()
Zend_Cache_Backend::_isGoodTmpDir()
Zend_Cache_Backend::_log()
Zend_Cache_Backend::_loggerSanity()

Class Constants

TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend' (line 47)

Log message

TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND = 'Zend_Cache_Backend_Xcache::save() : tags are unsupported by the Xcache backend' (line 48)