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.
TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND
= 'Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend'
Log message

array
$_options= 'array(
'user' => null'
Available options
available options=====> (string) user : xcache.admin.user (necessary for the clean() method)
=====> (string) password : xcache.admin.pass (clear, not MD5) (necessary for the clean() method)
array(
'user' => null
Details
__construct(
array $options
=
array()
)
:
void
Constructor
Name | Type | Description |
---|---|---|
$options | array | associative array of options |
Exception | Description |
---|---|
\Zend_Cache_Exception |

clean(
string $mode
=
Zend_Cache::CLEANING_MODE_ALL, array $tags
=
array()
)
:
boolean
Clean some cache records
Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => unsupported 'matchingTag' => unsupported 'notMatchingTag' => unsupported 'matchingAnyTag' => unsupported
Name | Type | Description |
---|---|---|
$mode | string | clean mode |
$tags | array | array of tags |
Type | Description |
---|---|
boolean | true if no problem |
Exception | Description |
---|---|
\Zend_Cache_Exception |

isAutomaticCleaningAvailable(
)
:
boolean
Return true if the automatic cleaning is available for the backend
Type | Description |
---|---|
boolean |

load(
string $id, boolean $doNotTestCacheValidity
=
false
)
:
string
Test if a cache is available for the given id and (if yes) return it (false else)
WARNING $doNotTestCacheValidity=true is unsupported by the Xcache backend
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
)
:
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
)
:
boolean
Save 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 |