Cache/Frontend/Function.php

Show:

inherited

Classes
- \Zend_Cache_Frontend_Function

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

\Zend_Cache_Frontend_Function
jump to top

Package: Zend\Cache\Zend\Cache\Frontend

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

Constants

 
                BACKEND_NOT_SUPPORTS_TAG
                = 'tags are not supported by the current backend'

inherited

Messages

Inherited from: \Zend_Cache_Core::BACKEND_NOT_SUPPORTS_TAG

Inherited_from: \Zend_Cache_Core::BACKEND_NOT_SUPPORTS_TAG

 
                BACKEND_NOT_IMPLEMENTS_EXTENDED_IF
                = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'

inheritedInherited from: \Zend_Cache_Core::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF

Inherited_from: \Zend_Cache_Core::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF

Properties

\Zend_Cache_Backend_Interface $_backend = null

inherited

Backend Object

Inherited from: \Zend_Cache_Core::$$_backend

Default valuenullDetails

Type: \Zend_Cache_Backend_Interface
Inherited_from: \Zend_Cache_Core::$$_backend

array $_backendCapabilities = array()

inherited

Array of capabilities of the backend (only if it implements Zend_Cache_Backend_ExtendedInterface)

Inherited from: \Zend_Cache_Core::$$_backendCapabilities

Default valuearray()Details

Type: array
Inherited_from: \Zend_Cache_Core::$$_backendCapabilities

array $_directivesList = array('lifetime', 'logging', 'logger')

staticinherited

Array of options which have to be transfered to backend

Inherited from: \Zend_Cache_Core::$$_directivesList

Default valuearray('lifetime', 'logging', 'logger')Details

Type: array
Inherited_from: \Zend_Cache_Core::$$_directivesList

boolean $_extendedBackend = false

inherited

True if the backend implements Zend_Cache_Backend_ExtendedInterface

Inherited from: \Zend_Cache_Core::$$_extendedBackend

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_Cache_Core::$$_extendedBackend

string $_lastId = null

inherited

Last used cache id

Inherited from: \Zend_Cache_Core::$$_lastId

Default valuenullDetails

Type: string
Inherited_from: \Zend_Cache_Core::$$_lastId

array $_options = array('write_control' => true, 'caching' => true, 'cache_id_prefix' => null, 'automatic_serialization' => false, 'automatic_cleaning_factor' => 10, 'lifetime' => 3600, 'logging' => false, 'logger' => null, 'ignore_user_abort' => false)

inherited

Available options

Inherited from: \Zend_Cache_Core::$$_options

====> (boolean) write_control : - Enable / disable write control (the cache is read just after writing to detect corrupt entries) - Enable write control will lightly slow the cache writing but not the cache reading Write control can detect some corrupt cache files but maybe it's not a perfect control

====> (boolean) caching : - Enable / disable caching (can be very useful for the debug of cached scripts)

=====> (string) cache_id_prefix : - prefix for cache ids (namespace)

====> (boolean) automatic_serialization : - Enable / disable automatic serialization - It can be used to save directly datas which aren't strings (but it's slower)

====> (int) automatic_cleaning_factor : - Disable / Tune the automatic cleaning process - The automatic cleaning process destroy too old (for the given life time) cache files when a new cache file is written : 0 => no automatic cache cleaning 1 => systematic cache cleaning x (integer) > 1 => automatic cleaning randomly 1 times on x cache write

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

====> (boolean) logging : - If set to true, logging is activated (but the system is slower)

====> (boolean) ignore_user_abort - If set to true, the core will set the ignore_user_abort PHP flag inside the save() method to avoid cache corruptions in some cases (default false)

Default value

array('write_control' => true, 'caching' => true, 'cache_id_prefix' => null, 'automatic_serialization' => false, 'automatic_cleaning_factor' => 10, 'lifetime' => 3600, 'logging' => false, 'logger' => null, 'ignore_user_abort' => false)

Details

Type: array
Inherited_from: \Zend_Cache_Core::$$_options

array $_specificOptions = array('cache_by_default' => true, 'cached_functions' => array(), 'non_cached_functions' => array())

This frontend specific options

====> (boolean) cache_by_default : - if true, function calls will be cached by default

====> (array) cached_functions : - an array of function names which will be cached (even if cache_by_default = false)

====> (array) non_cached_functions : - an array of function names which won't be cached (even if cache_by_default = true)

Default valuearray('cache_by_default' => true, 'cached_functions' => array(), 'non_cached_functions' => array())Details

Type: array

Methods

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

Constructor

Parameters

Name	Type	Description
$options	array	Associative array of options

Throws

Exception	Description
\Zend_Cache_Exception

_id(string $id) : string

inherited

Make and return a cache id

Inherited from: \Zend_Cache_Core::_id()

Checks 'cache_id_prefix' and returns new id with prefix or simply the id if null

Parameters

Name	Type	Description
$id	string	Cache id

Returns

Type	Description
string	Cache id (with or without prefix)

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

inherited

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Core::_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_Core::_loggerSanity()

Create a default log object if none is set.

Throws

Exception	Description
\Zend_Cache_Exception

_makeId( $callback, $args) : void

ZF-9970

Parameters

Name	Type	Description
$callback
$args

Details

Deprecated

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

inherited

Set an option

Inherited from: \Zend_Cache_Core::_setOption()

Parameters

Name	Type	Description
$name	string	Name of the option
$value	mixed	Value of the option

Throws

Exception	Description
\Zend_Cache_Exception

_validateIdOrTag(string $string) : void

staticinherited

Validate a cache id or a tag (security, reliable filenames, reserved prefixes.

Inherited from: \Zend_Cache_Core::_validateIdOrTag()

..)

Throw an exception if a problem is found

Parameters

Name	Type	Description
$string	string	Cache id or tag

Throws

Exception	Description
\Zend_Cache_Exception

_validateTagsArray(array $tags) : void

staticinherited

Validate a tags array (security, reliable filenames, reserved prefixes.

Inherited from: \Zend_Cache_Core::_validateTagsArray()

..)

Throw an exception if a problem is found

Parameters

Name	Type	Description
$tags	array	Array of tags

Throws

Exception	Description
\Zend_Cache_Exception

call(callback $callback, array $parameters = array(), array $tags = array(), int $specificLifetime = false, int $priority = 8) : mixed

Main method : call the specified function or get the result from cache

Parameters

Name	Type	Description
$callback	callback	A valid callback
$parameters	array	Function parameters
$tags	array	Cache tags
$specificLifetime	int	If != false, set a specific lifetime for this cache record (null => infinite lifetime)
$priority	int	integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns

Type	Description
mixed	Result

clean(string $mode = 'all', array | string $tags = array()) : boolean

inherited

Clean cache entries

Inherited from: \Zend_Cache_Core::clean()

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
$tags	array \| string

Returns

Type	Description
boolean	True if ok

Throws

Exception	Description
\Zend_Cache_Exception

getBackend() : \Zend_Cache_Backend

inherited

Returns the backend

Inherited from: \Zend_Cache_Core::getBackend()

Returns

Type	Description
\Zend_Cache_Backend	backend object

getFillingPercentage() : int

inherited

Return the filling percentage of the backend storage

Inherited from: \Zend_Cache_Core::getFillingPercentage()

Returns

Type	Description
int	integer between 0 and 100

getIds() : array

inherited

Return an array of stored cache ids

Inherited from: \Zend_Cache_Core::getIds()

Returns

Type	Description
array	array of stored cache ids (string)

getIdsMatchingAnyTags(array $tags = array()) : array

inherited

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

Inherited from: \Zend_Cache_Core::getIdsMatchingAnyTags()

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 matching any cache ids (string)

getIdsMatchingTags(array $tags = array()) : array

inherited

Return an array of stored cache ids which match given tags

Inherited from: \Zend_Cache_Core::getIdsMatchingTags()

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

inherited

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

Inherited from: \Zend_Cache_Core::getIdsNotMatchingTags()

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)

getMetadatas(string $id) : array

inherited

Return an array of metadatas for the given cache id

Inherited from: \Zend_Cache_Core::getMetadatas()

The array will 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

Public frontend to get an option value

Inherited from: \Zend_Cache_Core::getOption()

Parameters

Name	Type	Description
$name	string	Name of the option

Returns

Type	Description
mixed	option value

Throws

Exception	Description
\Zend_Cache_Exception

getTags() : array

inherited

Return an array of stored tags

Inherited from: \Zend_Cache_Core::getTags()

Returns

Type	Description
array	array of stored tags (string)

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

inherited

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

Inherited from: \Zend_Cache_Core::load()

Parameters

Name	Type	Description
$id	string	Cache id
$doNotTestCacheValidity	boolean	If set to true, the cache validity won't be tested
$doNotUnserialize	boolean	Do not serialize (even if automatic_serialization is true) => for internal use

Returns

Type	Description
mixed \| false	Cached datas

makeId(callback $callback, array $args = array()) : string

Make a cache id from the function name and parameters

Parameters

Name	Type	Description
$callback	callback	A valid callback
$args	array	Function parameters

Returns

Type	Description
string	Cache id

Throws

Exception	Description
\Zend_Cache_Exception

remove(string $id) : boolean

inherited

Remove a cache

Inherited from: \Zend_Cache_Core::remove()

Parameters

Name	Type	Description
$id	string	Cache id to remove

Returns

Type	Description
boolean	True if ok

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

inherited

Save some data in a cache

Inherited from: \Zend_Cache_Core::save()

Parameters

Name	Type	Description
$data	mixed	Data to put in cache (can be another type than string if automatic_serialization is on)
$id	string	Cache id (if not set, the last cache id will be used)
$tags	array	Cache tags
$specificLifetime	int	If != false, set a specific lifetime for this cache record (null => infinite lifetime)
$priority	int	integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns

Type	Description
boolean	True if no problem

Throws

Exception	Description
\Zend_Cache_Exception

setBackend(\Zend_Cache_Backend $backendObject) : void

inherited

Set the backend

Inherited from: \Zend_Cache_Core::setBackend()

Parameters

Name	Type	Description
$backendObject	\Zend_Cache_Backend

Throws

Exception	Description
\Zend_Cache_Exception

setConfig(\Zend_Config $config) : \Zend_Cache_Core

inherited

Set options using an instance of type Zend_Config

Inherited from: \Zend_Cache_Core::setConfig()

Parameters

Name	Type	Description
$config	\Zend_Config

Returns

Type	Description
\Zend_Cache_Core

setLifetime(int $newLifetime) : void

inherited

Force a new lifetime

Inherited from: \Zend_Cache_Core::setLifetime()

The new value is set for the core/frontend but for the backend too (directive)

Parameters

Name	Type	Description
$newLifetime	int	New lifetime (in seconds)

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

inherited

Public frontend to set an option

Inherited from: \Zend_Cache_Core::setOption()

There is an additional validation (relatively to the protected _setOption method)

Parameters

Name	Type	Description
$name	string	Name of the option
$value	mixed	Value of the option

Throws

Exception	Description
\Zend_Cache_Exception

test(string $id) : int | false

inherited

Test if a cache is available for the given id

Inherited from: \Zend_Cache_Core::test()

Parameters

Name	Type	Description
$id	string	Cache id

Returns

Type	Description
int \| false	Last modified time of cache entry if it is available, false otherwise

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

inherited

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

Inherited from: \Zend_Cache_Core::touch()

Parameters

Name	Type	Description
$id	string	cache id
$extraLifetime	int

Returns

Type	Description
boolean	true if ok

Cache/Frontend/Function.php

\Zend_Cache_Frontend_Functionjump to top

Constants

Properties

Methods

\Zend_Cache_Frontend_Function
jump to top