Cache/Backend/TwoLevels.php

Show: PublicProtectedPrivateinherited
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-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Backend  
Version
$Id$  

\Zend_Cache_Backend_TwoLevels

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

Properties

>VPropertyprotected\Zend_Cache_Backend_ExtendedInterface $_fastBackend
Fast Backend
>VPropertyprotectedint $_fastBackendFillingPercentage = null
Cache for the fast backend filling percentage
Default valuenullDetails
Type
int
>VPropertyprotectedarray $_options = array('slow_backend' => 'File', 'fast_backend' => 'Apc', 'slow_backend_options' => array(), 'fast_backend_options' => array(), 'stats_update_factor' => 10, 'slow_backend_custom_naming' => false, 'fast_backend_custom_naming' => false, 'slow_backend_autoload' => false, 'fast_backend_autoload' => false, 'auto_refresh_fast_cache' => true)
Available options
=====> (string) slow_backend : - Slow backend name - Must implement the Zend_Cache_Backend_ExtendedInterface - Should provide a big storage =====> (string) fast_backend : - Flow backend name - Must implement the Zend_Cache_Backend_ExtendedInterface - Must be much faster than slow_backend =====> (array) slow_backend_options : - Slow backend options (see corresponding backend) =====> (array) fast_backend_options : - Fast backend options (see corresponding backend) =====> (int) stats_update_factor : - Disable / Tune the computation of the fast backend filling percentage - When saving a record into cache : 1 => systematic computation of the fast backend filling percentage x (integer) > 1 => computation of the fast backend filling percentage randomly 1 times on x cache write =====> (boolean) slow_backend_custom_naming : =====> (boolean) fast_backend_custom_naming : =====> (boolean) slow_backend_autoload : =====> (boolean) fast_backend_autoload : - See Zend_Cache::factory() method =====> (boolean) auto_refresh_fast_cache - If true, auto refresh the fast cache when a cache record is hit
Default valuearray('slow_backend' => 'File', 'fast_backend' => 'Apc', 'slow_backend_options' => array(), 'fast_backend_options' => array(), 'stats_update_factor' => 10, 'slow_backend_custom_naming' => false, 'fast_backend_custom_naming' => false, 'slow_backend_autoload' => false, 'fast_backend_autoload' => false, 'auto_refresh_fast_cache' => true)Details
Type
array
>VPropertyprotected\Zend_Cache_Backend_ExtendedInterface $_slowBackend
Slow Backend

Methods

methodpublic___expire(string $id) : void

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire
Parameters
NameTypeDescription
$idstring

cache id

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

Constructor

Parameters
NameTypeDescription
$optionsarray

Associative array of options

Throws
ExceptionDescription
\Zend_Cache_Exception
methodprivate_getFastFillingPercentage( $mode) : void

Parameters
NameTypeDescription
$mode
methodprivate_getFastLifetime(int $lifetime, int $priority, int $maxLifetime = null) : int

Compute and return the lifetime for the fast backend

Parameters
NameTypeDescription
$lifetimeint

original lifetime

$priorityint

priority

$maxLifetimeint

maximum lifetime

Returns
TypeDescription
intlifetime for the fast backend
methodprivate_prepareData(string $data, int $lifetime, int $priority) : string

Prepare a serialized array to store datas and metadatas informations

Parameters
NameTypeDescription
$datastring

data to store

$lifetimeint

original lifetime

$priorityint

priority

Returns
TypeDescription
stringserialize array to store into cache
methodpublicclean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : boolean

Clean some cache records

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) Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)
Parameters
NameTypeDescription
$modestring

Clean mode

$tagsarray

Array of tags

Returns
TypeDescription
booleantrue if no problem
Throws
ExceptionDescription
\Zend_Cache_Exception
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
TypeDescription
arrayassociative of with capabilities
methodpublicgetFillingPercentage() : int

Return the filling percentage of the backend storage

Returns
TypeDescription
intinteger between 0 and 100
methodpublicgetIds() : array

Return an array of stored cache ids

Returns
TypeDescription
arrayarray 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
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray 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
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray 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
NameTypeDescription
$tagsarray

array of tags

Returns
TypeDescription
arrayarray of not matching cache ids (string)
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
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
arrayarray of metadatas (false if the cache id is not found)
methodpublicgetTags() : array

Return an array of stored tags

Returns
TypeDescription
arrayarray of stored tags (string)
methodpublicload(string $id, boolean $doNotTestCacheValidity = false) : string | false

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

Note : return value is always "string" (unserialization is done by the core not by the backend)
Parameters
NameTypeDescription
$idstring

Cache id

$doNotTestCacheValidityboolean

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

Returns
TypeDescription
string | falsecached datas
methodpublicremove(string $id) : boolean

Remove a cache record

Parameters
NameTypeDescription
$idstring

Cache id

Returns
TypeDescription
booleanTrue if no problem
methodpublicsave(string $data, string $id, array $tags = array(), int $specificLifetime = false, int $priority = 8) : 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
NameTypeDescription
$datastring

Datas to cache

$idstring

Cache id

$tagsarray

Array of strings, the cache record will be tagged by each string entry

$specificLifetimeint

If != false, set a specific lifetime for this cache record (null => infinite lifetime)

$priorityint

integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns
TypeDescription
booleantrue if no problem
methodpublictest(string $id) : mixed | false

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

Parameters
NameTypeDescription
$idstring

cache id

Returns
TypeDescription
mixed | 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
NameTypeDescription
$idstring

cache id

$extraLifetimeint
Returns
TypeDescription
booleantrue if ok
Documentation was generated by phpDocumentor 2.2.0 .