API Documentation

Cache/Backend/Test.php

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.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Backend  
version
$Id: Test.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Cache_Backend_Test

Extends from
\Zend_Cache_Backend
Implements
\Zend_Cache_Backend_ExtendedInterface
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Backend  

Properties

Propertyprotectedarray  $_directives= 'array'

Frontend or Core directives

directives

=====> (int) lifetime : - Cache lifetime (in seconds) - If null, the cache is valid forever

=====> (int) logging : - if set to true, a logging is activated throw Zend_Log

Default valuearrayDetails
Type
array
Propertyprivateint  $_index= '0'

Current index for log array

Default value0Details
Type
int
Propertyprivatearray  $_log= 'array'

Array to log actions

Default valuearrayDetails
Type
array
Propertyprotectedarray  $_options= 'array'

Available options

available options
Default valuearrayDetails
Type
array

Methods

methodpublic__construct( array $options = array ) : void

Constructor

Parameters
Name Type Description
$options array associative array of options
Throws
Exception Description
\Zend_Cache_Exception
methodprivate_addLog( string $methodName, array $args ) : void

Add an event to the log array

Parameters
Name Type Description
$methodName string MethodName
$args array Arguments
methodprotected_isGoodTmpDir( string $dir ) : boolean

Verify if the given temporary directory is readable and writable

Inherited from: \Zend_Cache_Backend::_isGoodTmpDir()
Parameters
Name Type Description
$dir string temporary directory
Returns
Type Description
boolean true if the directory is ok
methodprotected_log( string $message,  $priority = 4 ) : void

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Backend::_log()
Parameters
Name Type Description
$message string
$priority
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_loggerSanity( ) : void

Make sure if we enable logging that the Zend_Log class is available.

Inherited from: \Zend_Cache_Backend::_loggerSanity()

Create a default log object if none is set.

Throws
Exception Description
\Zend_Cache_Exception
methodpublicclean( 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)

Parameters
Name Type Description
$mode string Clean mode
$tags array Array of tags
Returns
Type Description
boolean True if no problem
methodpublicgetAllLogs( ) : array

Get the complete log array

Returns
Type Description
array Complete log array
methodpublicgetCapabilities( ) : 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)

Returns
Type Description
array associative of with capabilities
methodpublicgetFillingPercentage( ) : int

Return the filling percentage of the backend storage

Returns
Type Description
int integer between 0 and 100
methodpublicgetIds( ) : array

Return an array of stored cache ids

Returns
Type Description
array array of stored cache ids (string)
methodpublicgetIdsMatchingAnyTags( 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

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of any matching cache ids (string)
methodpublicgetIdsMatchingTags( 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

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of matching cache ids (string)
methodpublicgetIdsNotMatchingTags( 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

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of not matching cache ids (string)
methodpublicgetLastLog( ) : string

Get the last log

Returns
Type Description
string The last log
methodpublicgetLifetime( int $specificLifetime ) : int

Get the life time

Inherited from: \Zend_Cache_Backend::getLifetime()

if $specificLifetime is not false, the given specific life time is used else, the global lifetime is used

Parameters
Name Type Description
$specificLifetime int
Returns
Type Description
int Cache life time
methodpublicgetLogIndex( ) : int

Get the log index

Returns
Type Description
int Log index
methodpublicgetMetadatas( 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

Parameters
Name Type Description
$id string cache id
Returns
Type Description
array array of metadatas (false if the cache id is not found)
methodpublicgetTags( ) : array

Return an array of stored tags

Returns
Type Description
array array of stored tags (string)
methodpublicgetTmpDir( ) : string

Determine system TMP directory and detect if we have read access

Inherited from: \Zend_Cache_Backend::getTmpDir()

inspired from Zend_File_Transfer_Adapter_Abstract

Returns
Type Description
string
Throws
Exception Description
\Zend_Cache_Exception if unable to determine directory
methodpublicisAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Returns
Type Description
boolean
methodpublicload( 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)

Parameters
Name Type Description
$id string Cache id
$doNotTestCacheValidity boolean

If set to true, the cache validity won't be tested

Returns
Type Description
string Cached datas (or false)
methodpublicremove( string $id ) : boolean

Remove a cache record

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

Parameters
Name Type Description
$id string Cache id
Returns
Type Description
boolean True if no problem
methodpublicsave( 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)

Parameters
Name Type Description
$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)

Returns
Type Description
boolean True if no problem
methodpublicsetDirectives( array $directives ) : void

Set the frontend directives

Parameters
Name Type Description
$directives array assoc of directives
Throws
Exception Description
\Zend_Cache_Exception
methodpublicsetOption( string $name, mixed $value ) : void

Set an option

Inherited from: \Zend_Cache_Backend::setOption()
Parameters
Name Type Description
$name string
$value mixed
Throws
Exception Description
\Zend_Cache_Exception
methodpublictest( 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)

Parameters
Name Type Description
$id string Cache id
Returns
Type Description
mixedfalse false (a cache is not available) or "last modified" timestamp (int) of the available cache record
methodpublictouch( string $id, int $extraLifetime ) : boolean

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

Parameters
Name Type Description
$id string cache id
$extraLifetime int
Returns
Type Description
boolean true if ok
Documentation was generated by DocBlox 0.13.3.