Cache/Backend/Xcache.php

Show:

inherited

Classes
- \Zend_Cache_Backend_Xcache

Table of Contents

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_Xcache
jump to top

Package: Zend_Cache\Zend_Cache_Backend

Implements
Parent(s): \Zend_Cache_Backend
Copyright: Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Constants

 
                TAGS_UNSUPPORTED_BY_CLEAN_OF_XCACHE_BACKEND
                = 'Zend_Cache_Backend_Xcache::clean() : tags are unsupported by the Xcache backend'

Log message

 
                TAGS_UNSUPPORTED_BY_SAVE_OF_XCACHE_BACKEND
                = 'Zend_Cache_Backend_Xcache::save() : tags are unsupported by the Xcache backend'

Properties

array $_options = array('user' => null, 'password' => null)

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)

Default valuearray('user' => null, 'password' => null)Details

Type: array

Methods

__construct(array $options = array()) : void

Constructor

Parameters

Name	Type	Description
$options	array	associative array of options

Throws

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

Parameters

Name	Type	Description
$mode	string	clean mode
$tags	array	array of tags

Returns

Type	Description
boolean	true if no problem

Throws

Exception	Description
\Zend_Cache_Exception

isAutomaticCleaningAvailable() : boolean

Return true if the automatic cleaning is available for the backend

Returns

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

Parameters

Name	Type	Description
$id	string	cache id
$doNotTestCacheValidity	boolean	if set to true, the cache validity won't be tested

Returns

Type	Description
string	cached datas (or false)

remove(string $id) : boolean

Remove a cache record

Parameters

Name	Type	Description
$id	string	cache id

Returns

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)

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)

Returns

Type	Description
boolean	true if no problem

test(string $id) : mixed

Test if a cache is available or not (for the given id)

Parameters

Name	Type	Description
$id	string	cache id

Returns

Type	Description
mixed	false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Cache/Backend/Xcache.php

\Zend_Cache_Backend_Xcachejump to top

Constants

Properties

Methods

\Zend_Cache_Backend_Xcache
jump to top