Cache/Backend/Libmemcached.php

Show:

inherited

Classes
- \Zend_Cache_Backend_Libmemcached

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 [email protected] 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_Libmemcached
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

 
                DEFAULT_HOST
                = '127.0.0.1'

Default Server Values

 
                DEFAULT_PORT
                = 11211

 
                DEFAULT_WEIGHT
                = 1

 
                TAGS_UNSUPPORTED_BY_CLEAN_OF_LIBMEMCACHED_BACKEND
                = 'Zend_Cache_Backend_Libmemcached::clean() : tags are unsupported by the Libmemcached backend'

Log message

 
                TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND
                = 'Zend_Cache_Backend_Libmemcached::save() : tags are unsupported by the Libmemcached backend'

Properties

mixed $_memcache = null

Memcached object

Default valuenullDetails

Type: mixed

array $_options = array('servers' => array(array('host' => self::DEFAULT_HOST, 'port' => self::DEFAULT_PORT, 'weight' => self::DEFAULT_WEIGHT)), 'client' => array())

Available options

=====> (array) servers : an array of memcached server ; each memcached server is described by an associative array : 'host' => (string) : the name of the memcached server 'port' => (int) : the port of the memcached server 'weight' => (int) : number of buckets to create for this server which in turn control its probability of it being selected. The probability is relative to the total weight of all servers. =====> (array) client : an array of memcached client options ; the memcached client is described by an associative array :

Default value

array('servers' => array(array('host' => self::DEFAULT_HOST, 'port' => self::DEFAULT_PORT, 'weight' => self::DEFAULT_WEIGHT)), 'client' => array())

Details

Type: array
See: - The option name can be the name of the constant without the prefix 'OPT_' or the integer value of this option constant

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

getCapabilities() : array

Return an associative array of capabilities (booleans) of the backend

The array must include these keys : - automatic_cleaning (is automating cleaning necessary) - tags (are tags supported) - expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example)) - priority does the backend deal with priority when saving - infinite_lifetime (is infinite lifetime can work with this backend) - get_list (is it possible to get the list of cache ids and the complete list of tags)

Returns

Type	Description
array	associative of with capabilities

getFillingPercentage() : int

Return the filling percentage of the backend storage

Returns

Type	Description
int	integer between 0 and 100

Throws

Exception	Description
\Zend_Cache_Exception

getIds() : array

Return an array of stored cache ids

Returns

Type	Description
array	array of stored cache ids (string)

getIdsMatchingAnyTags(array $tags = array()) : array

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical AND is made between tags

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of any matching cache ids (string)

getIdsMatchingTags(array $tags = array()) : array

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of matching cache ids (string)

getIdsNotMatchingTags(array $tags = array()) : array

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

Parameters

Name	Type	Description
$tags	array	array of tags

Returns

Type	Description
array	array of not matching cache ids (string)

getMetadatas(string $id) : array

Return an array of metadatas for the given cache id

The array must include these keys : - expire : the expire timestamp - tags : a string array of tags - mtime : timestamp of last modification time

Parameters

Name	Type	Description
$id	string	cache id

Returns

Type	Description
array	array of metadatas (false if the cache id is not found)

getTags() : array

Return an array of stored tags

Returns

Type	Description
array	array of stored tags (string)

isAutomaticCleaningAvailable() : boolean

Return true if the automatic cleaning is available for the backend

Returns

Type	Description
boolean

load(string $id, boolean $doNotTestCacheValidity = false) : string | false

Test if a cache is available for the given id and (if yes) return it (false else)

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 \| false	cached datas

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

setDirectives(array $directives) : void

Set the frontend directives

Parameters

Name	Type	Description
$directives	array	Assoc of directives

Throws

Exception	Description
\Zend_Cache_Exception

test(string $id) : int | false

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

Parameters

Name	Type	Description
$id	string	Cache id

Returns

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

touch(string $id, int $extraLifetime) : boolean

Give (if possible) an extra lifetime to the given cache id

Parameters

Name	Type	Description
$id	string	cache id
$extraLifetime	int

Returns

Type	Description
boolean	true if ok

Cache/Backend/Libmemcached.php

\Zend_Cache_Backend_Libmemcachedjump to top

Constants

Properties

Methods

\Zend_Cache_Backend_Libmemcached
jump to top