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)
abstract:
license: New BSD License

Located in /Cache/Backend/ZendServer.php (line 37)

Zend_Cache_Backend
   |
   --Zend_Cache_Backend_ZendServer

Direct descendents

Class	Description
Zend_Cache_Backend_ZendServer_ShMem
Zend_Cache_Backend_ZendServer_Disk

Variable Summary

array $_options

Method Summary

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 test (string $id)

void _clear ()

void _fetch (string $id)

void _store (mixed $data, string $id, int $timeToLive)

void _unset (string $id)

Variables

array $_options = array(
'namespace' => 'zendframework'
) (line 47)

Available options

=====> (string) namespace : Namespace to be used for chaching operations

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

clean (line 186)

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

load (line 88)

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

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

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

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

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
throws: Zend_Cache_Exception
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)

_clear (line 79)

Clear cache

abstract:
access: protected

void _clear ()

Redefined in descendants as:

Zend_Cache_Backend_ZendServer_ShMem::_clear() : Clear cache
Zend_Cache_Backend_ZendServer_Disk::_clear() : Clear cache

_fetch (line 67)

Fetch data

abstract:
throws: Zend_Cache_Exception
access: protected

void _fetch (string $id)

string $id: Cache id

Redefined in descendants as:

Zend_Cache_Backend_ZendServer_ShMem::_fetch() : Fetch data
Zend_Cache_Backend_ZendServer_Disk::_fetch() : Fetch data

_store (line 59)

Store data

abstract:
throws: Zend_Cache_Exception
access: protected

void _store (mixed $data, string $id, int $timeToLive)

mixed $data: Object to store
string $id: Cache id
int $timeToLive: Time to live in seconds

Redefined in descendants as:

Zend_Cache_Backend_ZendServer_ShMem::_store() : Store data
Zend_Cache_Backend_ZendServer_Disk::_store() : Store data

_unset (line 74)

Unset data

abstract:
access: protected

void _unset (string $id)

string $id: Cache id

Redefined in descendants as:

Zend_Cache_Backend_ZendServer_ShMem::_unset() : Unset data
Zend_Cache_Backend_ZendServer_Disk::_unset() : Unset data

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