## Zend_Cache_Backend_Test

Description

Implements interfaces:

- Zend_Cache_Backend_Interface

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

Located in /Zend/Cache/Backend/Test.php (line 36)

Method Summary
Zend_Cache_Backend_Test __construct ([array $options = array()])
boolean clean ([string $mode = Zend_Cache::CLEANING_MODE_ALL], [tags $tags = array()])
array getAllLogs ()
string getLastLog ()
int getLogIndex ()
string load (string $id, [boolean $doNotTestCacheValidity = false])
boolean remove (string $id)
boolean save (string $data, string $id, [array $tags = array()], [int $specificLifeTime = false])
void setDirectives (array $directives)
mixed test (string $id)
Methods
Constructor __construct (line 81)

Constructor

- access: public

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

- array $options: associative array of options

clean (line 200)

Clean some cache records

For this test backend only, if $mode == 'false', then the method will return false (true else)

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) 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 => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string)

- return: true if no problem
- access: public

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

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

Implementation of:

Zend_Cache_Backend_Interface::clean()
  Clean some cache records

getAllLogs (line 234)

Get the complete log array

- return: complete log array
- access: public

array getAllLogs ()
getLastLog (line 214)

Get the last log

- return: the last log
- access: public

string getLastLog ()
getLogIndex (line 224)

Get the log index

- return: log index
- access: public

int getLogIndex ()
load (line 107)

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

For this test backend only, if $id == 'false', then the method will return false if $id == 'serialized', the method will return a serialized array ('foo' 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 173)

Remove a cache record

For this test backend only, if $id == 'false', then the method will return false (true else)

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

Save some string datas into a cache record

For this test backend only, if $id == 'false', then the method will return false (true else)

- 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

setDirectives (line 91)

Set the frontend directives

- access: public

void setDirectives (array $directives)

- array $directives: assoc of directives

Implementation of:

Zend_Cache_Backend_Interface::setDirectives()
  Set the frontend directives

test (line 131)

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

For this test backend only, if $id == 'false', then the method will return false (123456 else)

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

Documentation generated on Wed, 21 Feb 2007 12:00:58 -0800 by phpDocumentor 1.3.1