Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Cache_Backend_ZendServer Class Reference

Inheritance diagram for Zend_Cache_Backend_ZendServer:
Zend_Cache_Backend Zend_Cache_Backend_Interface Zend_Cache_Backend_ZendServer_Disk Zend_Cache_Backend_ZendServer_ShMem

Public Member Functions

 load ($id, $doNotTestCacheValidity=false)
 test ($id)
 save ($data, $id, $tags=array(), $specificLifetime=false)
 remove ($id)
 clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())

Protected Member Functions

 _store ($data, $id, $timeToLive)
 _fetch ($id)
 _unset ($id)
 _clear ()

Protected Attributes

 $_options

Detailed Description

Definition at line 37 of file ZendServer.php.


Member Function Documentation

_clear (  ) [abstract, protected]
_fetch ( id ) [abstract, protected]

Fetch data

Parameters:
string$idCache id
Exceptions:
Zend_Cache_Exception

Reimplemented in Zend_Cache_Backend_ZendServer_Disk, and Zend_Cache_Backend_ZendServer_ShMem.

_store ( data,
id,
timeToLive 
) [abstract, protected]

Store data

Parameters:
mixed$dataObject to store
string$idCache id
int$timeToLiveTime to live in seconds
Exceptions:
Zend_Cache_Exception

Reimplemented in Zend_Cache_Backend_ZendServer_Disk, and Zend_Cache_Backend_ZendServer_ShMem.

_unset ( id ) [abstract, protected]

Unset data

Parameters:
string$idCache id

Reimplemented in Zend_Cache_Backend_ZendServer_Disk, and Zend_Cache_Backend_ZendServer_ShMem.

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 186 of file ZendServer.php.

load ( id,
doNotTestCacheValidity = false 
)

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

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 88 of file ZendServer.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 163 of file ZendServer.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 141 of file ZendServer.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
Exceptions:
Zend_Cache_Exception

Implements Zend_Cache_Backend_Interface.

Definition at line 104 of file ZendServer.php.


Field Documentation

$_options [protected]
Initial value:
 array(
        'namespace' => 'zendframework'
    )

Reimplemented from Zend_Cache_Backend.

Definition at line 47 of file ZendServer.php.


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