Cache/Backend/BlackHole.php

Show:

inherited

Classes
- \Zend_Cache_Backend_BlackHole

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: BlackHole.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Cache_Backend_BlackHole
jump to top

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

array $_directives = array('lifetime' => 3600, 'logging' => false, 'logger' => null)

inherited

Frontend or Core directives

Inherited from: \Zend_Cache_Backend::$$_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 valuearray('lifetime' => 3600, 'logging' => false, 'logger' => null)Details

Type: array
Inherited_from: \Zend_Cache_Backend::$$_directives

array $_options = array()

inherited

Available options

Inherited from: \Zend_Cache_Backend::$$_options

Default valuearray()Details

Type: array
Inherited_from: \Zend_Cache_Backend::$$_options

Methods

___expire(string $id) : void

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

Parameters

Name	Type	Description
$id	string	cache id

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

inherited

Constructor

Inherited from: \Zend_Cache_Backend::__construct()

Parameters

Name	Type	Description
$options	array	Associative array of options

Throws

Exception	Description
\Zend_Cache_Exception

_isGoodTmpDir(string $dir) : boolean

inherited

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

_log(string $message, $priority = 4) : void

inherited

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

_loggerSanity() : void

inherited

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

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

Clean some cache records

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

Name	Type	Description
$mode	string	clean mode
$tags	\tags	array $tags array of tags

Returns

Type	Description
boolean	true if no problem

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)

Returns

Type	Description
array	associative of with capabilities

getFillingPercentage() : int

Return the filling percentage of the backend storage

Returns

Type	Description
int	integer between 0 and 100

Throws

Exception	Description
\Zend_Cache_Exception

getIds() : array

Return an array of stored cache ids

Returns

Type	Description
array	array of stored cache ids (string)

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

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of any matching cache ids (string)

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

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of matching cache ids (string)

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

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of not matching cache ids (string)

getLifetime(int $specificLifetime) : int

inherited

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

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

Parameters

Name	Type	Description
$id	string	cache id

Returns

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

getOption(string $name) : mixed

inherited

Returns an option

Inherited from: \Zend_Cache_Backend::getOption()

Parameters

Name	Type	Description
$name	string	Optional, the options name to return

Returns

Type	Description
mixed

Throws

Exception	Description
\Zend_Cache_Exceptions

getTags() : array

Return an array of stored tags

Returns

Type	Description
array	array of stored tags (string)

getTmpDir() : string

inherited

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

isAutomaticCleaningAvailable() : boolean

inherited

Return true if the automatic cleaning is available for the backend

Inherited from: \Zend_Cache_Backend::isAutomaticCleaningAvailable()

DEPRECATED : use getCapabilities() instead

Returns

Type	Description
boolean

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

Test if a cache is available for the given id and (if yes) return it (false 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 \| false	cached datas

remove(string $id) : boolean

Remove a cache record

Parameters

Name	Type	Description
$id	string	cache id

Returns

Type	Description
boolean	true if no problem

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

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

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

setDirectives(array $directives) : void

inherited

Set the frontend directives

Inherited from: \Zend_Cache_Backend::setDirectives()

Parameters

Name	Type	Description
$directives	array	Assoc of directives

Throws

Exception	Description
\Zend_Cache_Exception

setOption(string $name, mixed $value) : void

inherited

Set an option

Inherited from: \Zend_Cache_Backend::setOption()

Parameters

Name	Type	Description
$name	string
$value	mixed

Throws

Exception	Description
\Zend_Cache_Exception

test(string $id) : mixed

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

Parameters

Name	Type	Description
$id	string	cache id

Returns

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

touch(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

Cache/Backend/BlackHole.php

\Zend_Cache_Backend_BlackHolejump to top

Properties

Methods

\Zend_Cache_Backend_BlackHole
jump to top