API Documentation

Zend/Cache/Backend/Test.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Backend  
Version
$Id: Test.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Backend_Test

Package: Zend\Cache\Zend\Cache\Backend

Implements
\Zend_Cache_Backend_ExtendedInterface
Parent(s)
\Zend_Cache_Backend
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_directives= 'array()'

Frontend or Core directives

directives
Default valuearray()Details
Type
array
Propertyprivateint  $_index= '0'

Current index for log array

Default value0Details
Type
int
Propertyprivatearray  $_log= 'array()'

Array to log actions

Default valuearray()Details
Type
array
Propertyprotectedarray  $_options= 'array()'

Available options

available options
Default valuearray()Details
Type
array

Methods

methodpublic__construct( array $options = array() ) : void

Constructor

Parameters
Name Type Description
$options array

associative array of options

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

Add an event to the log array

Parameters
Name Type Description
$methodName string

MethodName

$args array

Arguments

methodpublicclean( string $mode = Zend_Cache::CLEANING_MODE_ALL, 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
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)
methodpublicisAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

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

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
mixed|false 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.15.1.