Docs For Class Zend_Cache_Backend

Description

Implements interfaces:

Zend_Cache_Backend_Interface

Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)

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

Located in /Cache/Backend/ZendPlatform.php (line 42)

Zend_Cache_Backend
   |
   --Zend_Cache_Backend_ZendPlatform

Class Constant Summary

TAGS_PREFIX = "internal_ZPtag:"

Method Summary

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

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

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

boolean remove (string $id)

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

mixed|false test (string $id)

Variables

Inherited Variables

Inherited from Zend_Cache_Backend

Zend_Cache_Backend::$_directives
Zend_Cache_Backend::$_options

Methods

Constructor __construct (line 57)

Constructor Validate that the Zend Platform is loaded and licensed

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 185)

Clean some cache records

Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) This mode is not supported in this backend Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => unsupported Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

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

load (line 86)

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

return: Cached data (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 161)

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 130)

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: Data 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 109)

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|false 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_PREFIX = "internal_ZPtag:" (line 47)

internal ZP prefix