Cache/Backend/Test.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
version: $Id: Test.php 22504 2010-06-30 17:05:07Z mabe $
Classes: Zend_Cache_Backend_Test

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Cache_Backend_Test
jump to top

Extends from: Zend_Cache_Backend
Implements: Zend_Cache_Backend_ExtendedInterface
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Backend
Properties: $_options; $_directives; $_log; $_index
Methods: __construct; setDirectives; load; test; save; remove; clean; getLastLog; getLogIndex; getAllLogs; isAutomaticCleaningAvailable; getIds; getTags; getIdsMatchingTags; getIdsNotMatchingTags; getIdsMatchingAnyTags; getFillingPercentage; getMetadatas; touch; getCapabilities; _addLog

Description

Properties

$_directives
jump to class

array $_directives = 'array'

Frontend or Core directives

Details

$_directives: array
directives
visibility: protected
default: array
final: false
static: false

$_index
jump to class

int $_index = '0'

Current index for log array

Details

$_index: int
visibility: private
default: 0
final: false
static: false

$_log
jump to class

array $_log = 'array'

Array to log actions

Details

$_log: array
visibility: private
default: array
final: false
static: false

$_options
jump to class

array $_options = 'array'

Available options

Details

$_options: array
available options
visibility: protected
default: array
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor

Arguments

$options: array
associative array of options

Details

visibility: public
final: false
static: false

_addLog
jump to class

_addLog(
          string $methodName, array $args
          )
        
        :
        void

Add an event to the log array

Arguments

$methodName: string
MethodName
$args: array
Arguments

Details

visibility: private
final: false
static: false

clean
jump to class

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

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)

Arguments

$mode: string
Clean mode
$tags: array
Array of tags

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

getAllLogs
jump to class

getAllLogs(
          
          )
        
        :
        array

Get the complete log array

Output

array: Complete log array

Details

visibility: public
final: false
static: false

getCapabilities
jump to class

getCapabilities(
          
          )
        
        :
        array

Return an associative array of capabilities (booleans) of the backend

The array must include these keys : - automatic_cleaning (is automating cleaning necessary) - tags (are tags supported) - expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example)) - priority does the backend deal with priority when saving - infinite_lifetime (is infinite lifetime can work with this backend) - get_list (is it possible to get the list of cache ids and the complete list of tags)

Output

array: associative of with capabilities

Details

visibility: public
final: false
static: false

getFillingPercentage
jump to class

getFillingPercentage(
          
          )
        
        :
        int

Return the filling percentage of the backend storage

Output

int: integer between 0 and 100

Details

visibility: public
final: false
static: false

getIds
jump to class

getIds(
          
          )
        
        :
        array

Return an array of stored cache ids

Output

array: array of stored cache ids (string)

Details

visibility: public
final: false
static: false

getIdsMatchingAnyTags
jump to class

getIdsMatchingAnyTags(
          array $tags
              =
              array
          )
        
        :
        array

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags

Arguments

$tags: array
array of tags

Output

array: array of any matching cache ids (string)

Details

visibility: public
final: false
static: false

getIdsMatchingTags
jump to class

getIdsMatchingTags(
          array $tags
              =
              array
          )
        
        :
        array

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

Arguments

$tags: array
array of tags

Output

array: array of matching cache ids (string)

Details

visibility: public
final: false
static: false

getIdsNotMatchingTags
jump to class

getIdsNotMatchingTags(
          array $tags
              =
              array
          )
        
        :
        array

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

Arguments

$tags: array
array of tags

Output

array: array of not matching cache ids (string)

Details

visibility: public
final: false
static: false

getLastLog
jump to class

getLastLog(
          
          )
        
        :
        string

Get the last log

Output

string: The last log

Details

visibility: public
final: false
static: false

getLogIndex
jump to class

getLogIndex(
          
          )
        
        :
        int

Get the log index

Output

int: Log index

Details

visibility: public
final: false
static: false

getMetadatas
jump to class

getMetadatas(
          string $id
          )
        
        :
        array

Return an array of metadatas for the given cache id

The array must include these keys : - expire : the expire timestamp - tags : a string array of tags - mtime : timestamp of last modification time

Arguments

$id: string
cache id

Output

array: array of metadatas (false if the cache id is not found)

Details

visibility: public
final: false
static: false

getTags
jump to class

getTags(
          
          )
        
        :
        array

Return an array of stored tags

Output

array: array of stored tags (string)

Details

visibility: public
final: false
static: false

isAutomaticCleaningAvailable
jump to class

isAutomaticCleaningAvailable(
          
          )
        
        :
        boolean

Return true if the automatic cleaning is available for the backend

Output

boolean

Details

visibility: public
final: false
static: false

load
jump to class

load(
          string $id, boolean $doNotTestCacheValidity
              =
              false
          )
        
        :
        string

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)

Arguments

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

Output

string: Cached datas (or false)

Details

visibility: public
final: false
static: false

remove
jump to class

remove(
          string $id
          )
        
        :
        boolean

Remove a cache record

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

Arguments

$id: string
Cache id

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

save
jump to class

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

Save some string datas into a cache record

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

Arguments

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

Output

boolean: True if no problem

Details

visibility: public
final: false
static: false

setDirectives
jump to class

setDirectives(
          array $directives
          )
        
        :
        void

Set the frontend directives

Arguments

$directives: array
assoc of directives

Details

visibility: public
final: false
static: false

test
jump to class

test(
          string $id
          )
        
        :
        mixed|false

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)

Arguments

$id: string
Cache id

Output

mixed|false: false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Details

visibility: public
final: false
static: false

touch
jump to class

touch(
          string $id, int $extraLifetime
          )
        
        :
        boolean

Give (if possible) an extra lifetime to the given cache id

Arguments

$id: string
cache id
$extraLifetime: int

Output

boolean: true if ok

Details

visibility: public
final: false
static: false

API Documentation

Cache/Backend/Test.php

Description

Zend_Cache_Backend_Testjump to top

Description

Properties

$_directivesjump to class

Details

$_indexjump to class

Details

$_logjump to class

Details

$_optionsjump to class

Details

Methods

__constructjump to class

Arguments

Details

_addLogjump to class

Arguments

Details

cleanjump to class

Arguments

Output

Details

getAllLogsjump to class

Output

Details

getCapabilitiesjump to class

Output

Details

getFillingPercentagejump to class

Output

Details

getIdsjump to class

Output

Details

getIdsMatchingAnyTagsjump to class

Arguments

Output

Details

getIdsMatchingTagsjump to class

Arguments

Output

Details

getIdsNotMatchingTagsjump to class

Arguments

Output

Details

getLastLogjump to class

Output

Details

getLogIndexjump to class

Output

Details

getMetadatasjump to class

Arguments

Output

Details

getTagsjump to class

Output

Details

isAutomaticCleaningAvailablejump to class

Output

Details

loadjump to class

Arguments

Output

Details

removejump to class

Arguments

Output

Details

savejump to class

Arguments

Output

Details

setDirectivesjump to class

Arguments

Details

Zend_Cache_Backend_Test
jump to top

$_directives
jump to class

$_index
jump to class

$_log
jump to class

$_options
jump to class

__construct
jump to class

_addLog
jump to class

clean
jump to class

getAllLogs
jump to class

getCapabilities
jump to class

getFillingPercentage
jump to class

getIds
jump to class

getIdsMatchingAnyTags
jump to class

getIdsMatchingTags
jump to class

getIdsNotMatchingTags
jump to class

getLastLog
jump to class

getLogIndex
jump to class

getMetadatas
jump to class

getTags
jump to class

isAutomaticCleaningAvailable
jump to class

load
jump to class

remove
jump to class

save
jump to class

setDirectives
jump to class

test
jump to class

touch
jump to class