Cache/Backend/Interface.php
inheritedLICENSE
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: Interface.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Cache_Backend_Interface
- Children
- \Zend_Cache_Backend_ExtendedInterface
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Methods
clean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : booleanClean 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)
| Name | Type | Description |
|---|---|---|
| $mode | string | Clean mode |
| $tags | array | Array of tags |
| Type | Description |
|---|---|
| boolean | true if no problem |
load(string $id, boolean $doNotTestCacheValidity = false) : string | falseTest 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)
| 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) : booleanRemove 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) : booleanSave some string datas into a cache record
Note : $data is always "string" (serialization is done by the core not by the backend)
| 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) |
| Type | Description |
|---|---|
| boolean | true if no problem |
setDirectives(array $directives) : voidSet the frontend directives
| Name | Type | Description |
|---|---|---|
| $directives | array | assoc of directives |
test(string $id) : mixed | falseTest 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 |