Cache/Backend/ZendServer.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_ZendServer
Package: Zend_Cache\Zend_Cache_Backend
Returns
Throws
Returns
- Implements
- Parent(s)
- \Zend_Cache_Backend
- Children
- \Zend_Cache_Backend_ZendServer_Disk
- \Zend_Cache_Backend_ZendServer_ShMem
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_options = array('namespace' => 'zendframework')Available options
=====> (string) namespace :
Namespace to be used for chaching operations
Default valuearray('namespace' => 'zendframework')Details- Type
- array
Methods
_clear() : voidabstract
Clear cache
_expireTime( $lifetime) : intCompute & return the expire time
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $lifetime |
| Type | Description |
|---|---|
| int | expire time (unix timestamp) |
_fetch(string $id) : voidabstract
Fetch data
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_store(mixed $data, string $id, int $timeToLive) : voidabstract
Store data
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $data | mixed | Object to store |
| $id | string | Cache id |
| $timeToLive | int | Time to live in seconds |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_unset(string $id) : voidabstract
Unset data
Parameters
| Name | Type | Description |
|---|---|---|
| $id | string | Cache id |
clean(string $mode = \Zend_Cache::CLEANING_MODE_ALL, array $tags = array()) : booleanClean some cache records
Available modes are :
'all' (default) => remove all cache entries ($tags is not used)
'old' => unsupported
'matchingTag' => unsupported
'notMatchingTag' => unsupported
'matchingAnyTag' => unsupported
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 datas (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 | 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 |
test(string $id) : mixedTest if a cache is available or not (for the given id)
Parameters
Returns
Throws
| 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 |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |