Cache/Backend/ZendPlatform.php
Show:
inherited
inherited
Classes
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_ZendPlatform
Package: Zend_Cache\Zend_Cache_Backend
Returns
Returns
Returns
Throws
Returns
Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)
- Implements
- Parent(s)
- \Zend_Cache_Backend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
Methods
__construct(array $options = array()) : voidConstructor Validate that the Zend Platform is loaded and licensed
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | Associative array of options |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_clean(string $dir, string $mode) : booleanClean a directory and recursivly go over it's subdirectories
Remove all the cached files that need to be cleaned (according to mode and files mtime)
Parameters| Name | Type | Description |
|---|---|---|
| $dir | string | Path of directory ot clean |
| $mode | string | The same parameter as in Zend_Cache_Backend_ZendPlatform::clean() |
| Type | Description |
|---|---|
| boolean | True if ok |
_remove(string $file) : booleanRemove a file
If we can't remove the file (because of locks or any problem), we will touch
the file to invalidate it
Parameters| Name | Type | Description |
|---|---|---|
| $file | string | Complete file path |
| Type | Description |
|---|---|
| boolean | True if ok |
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)
This mode is not supported in this backend
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 => unsupported
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| Name | Type | Description |
|---|---|---|
| $mode | string | Clean mode |
| $tags | array | Array of tags |
| Type | Description |
|---|---|
| boolean | True if no problem |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
load(string $id, boolean $doNotTestCacheValidity = false) : stringTest if a cache is available for the given id and (if yes) return it (false else)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
| $doNotTestCacheValidity | boolean | If set to true, the cache validity won't be tested |
| Type | Description |
|---|---|
| string | Cached data (or false) |
remove(string $id) : booleanRemove a cache record
Parameters
Returns
| 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)
Parameters| Name | Type | Description |
|---|---|---|
| $data | string | Data 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 |
test(string $id) : mixed | falseTest if a cache is available or not (for the given id)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
| Type | Description |
|---|---|
| mixed | false | false (a cache is not available) or "last modified" timestamp (int) of the available cache record |