| Package | Zend_Cache |
| Subpackage | Zend_Cache_Backend |
| Copyright | Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com) |
| License | http://framework.zend.com/license/new-bsd New BSD License |
Class Zend_Cache_Backend_ZendPlatform
class Zend_Cache_Backend_ZendPlatform extends Zend_Cache_Backend implements Zend_Cache_Backend_Interface
Defined in line 42 of file Cache/Backend/ZendPlatform.php.
Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)
Summary
Class constants
| TAGS_PREFIX | internal ZP prefix |
Instance methods
| + __construct() | Constructor |
| - _clean() | Clean a directory and recursivly go over it's subdirectories |
| - _remove() | Remove a file |
| + clean() | Clean some cache records |
| + load() | Test if a cache is available for the given id and (if yes) return it (false else) |
| + remove() | Remove a cache record |
| + save() | Save some string datas into a cache record |
| + test() | Test if a cache is available or not (for the given id) |
Details
Class constants
Instance methods
public function __construct( |
array $options = array())
|
Constructor
Validate that the Zend Platform is loaded and licensed
Parameters
Validate that the Zend Platform is loaded and licensed
array $options |
Returns
void
Throws
Zend_Cache_ExceptionOverrides Zend_Cache_Backend->__construct()
Defined in Cache/Backend/ZendPlatform.php, line 57
private function _clean( |
$dir)
|
Clean 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
Remove all the cached files that need to be cleaned (according to mode and files mtime)
string $dir |
Path of directory ot clean |
string $mode |
The same parameter as in Zend_Cache_Backend_ZendPlatform::clean() |
Returns
boolean True if ok
Defined in Cache/Backend/ZendPlatform.php, line 260
private function _remove( |
$file)
|
Remove a file
If we can't remove the file (because of locks or any problem), we will touch
the file to invalidate it
Parameters
If we can't remove the file (because of locks or any problem), we will touch
the file to invalidate it
string $file |
Complete file path |
Returns
boolean True if ok
Defined in Cache/Backend/ZendPlatform.php, line 300
public function clean( |
$mode = Zend_Cache::CLEANING_MODE_ALL)
|
Clean some cache records
Available modes are :
This mode is not supported in this backend
($tags can be an array of strings or a single string)
($tags can be an array of strings or a single string)
Parameters
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 => unsupportedZend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags($tags can be an array of strings or a single string)
string $mode |
Clean mode |
array $tags |
Array of tags |
Returns
boolean True if no problem
Throws
Zend_Cache_ExceptionDefined in Cache/Backend/ZendPlatform.php, line 185
public function load( |
$id)
|
Test if a cache is available for the given id and (if yes) return it (false else)
Parameters
string $id |
Cache id |
boolean $doNotTestCacheValidity |
If set to true, the cache validity won't be tested |
Returns
string Cached data (or false)
Defined in Cache/Backend/ZendPlatform.php, line 86
public function remove( |
$id)
|
Remove a cache record
Parameters
string $id |
Cache id |
Returns
boolean True if no problem
Defined in Cache/Backend/ZendPlatform.php, line 161
public function save( |
$data)
|
Save some string datas into a cache record
Note : $data is always "string" (serialization is done by the
core not by the backend)
Parameters
Note : $data is always "string" (serialization is done by the
core not by the backend)
string $data |
Data to cache |
string $id |
Cache id |
array $tags |
Array of strings, the cache record will be tagged by each string entry |
int $specificLifetime |
If != false, set a specific lifetime for this cache record (null => infinite lifetime) |
Returns
boolean true if no problem
Defined in Cache/Backend/ZendPlatform.php, line 130
public function test( |
$id)
|
Test if a cache is available or not (for the given id)
Parameters
string $id |
Cache id |
Returns
mixed|false false (a cache is not available) or "last modified" timestamp (int) of the available cache record
Defined in Cache/Backend/ZendPlatform.php, line 109