Cache/Backend/TwoLevels.php
- 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
- Implements
- Parent(s)
- \Zend_Cache_Backend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
int $_fastBackendFillingPercentage = null
null
Details- Type
- int
array $_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)
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)
Details- Type
- array
Methods
___expire(string $id) : void
PUBLIC METHOD FOR UNIT TESTING ONLY !
Name | Type | Description |
---|---|---|
$id | string | cache id |
__construct(array $options = array()) : void
Constructor
Name | Type | Description |
---|---|---|
$options | array | Associative array of options |
Exception | Description |
---|---|
\Zend_Cache_Exception |
_getFastLifetime(int $lifetime, int $priority, int $maxLifetime = null) : int
Compute and return the lifetime for the fast backend
Name | Type | Description |
---|---|---|
$lifetime | int | original lifetime |
$priority | int | priority |
$maxLifetime | int | maximum lifetime |
Type | Description |
---|---|
int | lifetime for the fast backend |
_prepareData(string $data, int $lifetime, int $priority) : string
Prepare a serialized array to store datas and metadatas informations
Name | Type | Description |
---|---|---|
$data | string | data to store |
$lifetime | int | original lifetime |
$priority | int | priority |
Type | Description |
---|---|
string | serialize array to store into cache |
clean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : boolean
Clean some cache records
Name | Type | Description |
---|---|---|
$mode | string | Clean mode |
$tags | array | Array of tags |
Type | Description |
---|---|
boolean | true if no problem |
Exception | Description |
---|---|
\Zend_Cache_Exception |
getCapabilities() : array
Return an associative array of capabilities (booleans) of the backend
Type | Description |
---|---|
array | associative of with capabilities |
getFillingPercentage() : int
Return the filling percentage of the backend storage
Type | Description |
---|---|
int | integer between 0 and 100 |
getIds() : array
Return an array of stored cache ids
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
Name | Type | Description |
---|---|---|
$tags | array | array of tags |
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
Name | Type | Description |
---|---|---|
$tags | array | array of tags |
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
Name | Type | Description |
---|---|---|
$tags | array | array of tags |
Type | Description |
---|---|
array | array of not matching cache ids (string) |
getMetadatas(string $id) : array
Return an array of metadatas for the given cache id
Name | Type | Description |
---|---|---|
$id | string | cache id |
Type | Description |
---|---|
array | array of metadatas (false if the cache id is not found) |
getTags() : array
Return an array of stored tags
Type | Description |
---|---|
array | array of stored tags (string) |
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)
Name | Type | Description |
---|---|---|
$id | string | Cache id |
$doNotTestCacheValidity | boolean | If set to true, the cache validity won't be tested |
Type | Description |
---|---|
string | false | cached datas |
remove(string $id) : boolean
Remove a cache record
Name | Type | Description |
---|---|---|
$id | string | Cache id |
Type | Description |
---|---|
boolean | True if no problem |
save(string $data, string $id, array $tags = array(), int $specificLifetime = false, int $priority = 8) : boolean
Save some string datas into a cache record
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) |
$priority | int | integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends |
Type | Description |
---|---|
boolean | true if no problem |
test(string $id) : mixed | false
Test if a cache is available or not (for the given id)
Name | Type | Description |
---|---|---|
$id | string | cache id |
Type | Description |
---|---|
mixed | false | (a cache is not available) or "last modified" timestamp (int) of the available cache record |