API Documentation

Cache/Backend/Memcached.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Cache
subpackage
Zend_Cache_Backend
version
$Id: Memcached.php 22208 2010-05-20 16:59:02Z mabe $
Classes
Zend_Cache_Backend_Memcached

Description

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.

Zend_Cache_Backend_Memcached
jump to top

Extends from
Zend_Cache_Backend
Implements
Zend_Cache_Backend_ExtendedInterface
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Cache
subpackage
Zend_Cache_Backend
Constants
DEFAULT_HOST
DEFAULT_PORT
DEFAULT_PERSISTENT
DEFAULT_WEIGHT
DEFAULT_TIMEOUT
DEFAULT_RETRY_INTERVAL
DEFAULT_STATUS
DEFAULT_FAILURE_CALLBACK
TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND
TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND
Properties
$_options
$_memcache
Methods
__construct
load
test
save
remove
clean
isAutomaticCleaningAvailable
setDirectives
getIds
getTags
getIdsMatchingTags
getIdsNotMatchingTags
getIdsMatchingAnyTags
getFillingPercentage
getMetadatas
touch
getCapabilities

Description

Constants

DEFAULT_HOST
jump to class

 DEFAULT_HOST = '127.0.0.1'

Default Values

Details

value
127.0.0.1

DEFAULT_PORT
jump to class

 DEFAULT_PORT = '11211'

Details

value
11211

DEFAULT_PERSISTENT
jump to class

 DEFAULT_PERSISTENT = 'true'

Details

value
true

DEFAULT_WEIGHT
jump to class

 DEFAULT_WEIGHT = '1'

Details

value
1

DEFAULT_TIMEOUT
jump to class

 DEFAULT_TIMEOUT = '1'

Details

value
1

DEFAULT_RETRY_INTERVAL
jump to class

 DEFAULT_RETRY_INTERVAL = '15'

Details

value
15

DEFAULT_STATUS
jump to class

 DEFAULT_STATUS = 'true'

Details

value
true

DEFAULT_FAILURE_CALLBACK
jump to class

 DEFAULT_FAILURE_CALLBACK = 'null'

Details

value
null

TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND
jump to class

 TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::clean() : tags are unsupported by the Memcached backend'

Log message

Details

value
Zend_Cache_Backend_Memcached::clean() : tags are unsupported by the Memcached backend

TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND
jump to class

 TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::save() : tags are unsupported by the Memcached backend'

Details

value
Zend_Cache_Backend_Memcached::save() : tags are unsupported by the Memcached backend

Properties

$_memcache
jump to class

mixed $_memcache = 'null'

Memcache object

Details

$_memcache
mixed
memcache object
visibility
protected
default
null
final
false
static
false

$_options
jump to class

array $_options = '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 'persistent' => (bool) : use or not persistent connections to this 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. 'timeout' => (int) : value in seconds which will be used for connecting to the daemon. Think twice before changing the default value of 1 second - you can lose all the advantages of caching if your connection is too slow. 'retry_interval' => (int) : controls how often a failed server will be retried, the default value is 15 seconds. Setting this parameter to -1 disables automatic retry. 'status' => (bool) : controls if the server should be flagged as online. 'failure_callback' => (callback) : Allows the user to specify a callback function to run upon encountering an error. The callback is run before failover is attempted. The function takes two parameters, the hostname and port of the failed server.

=====> (boolean) compression : true if you want to use on-the-fly compression

=====> (boolean) compatibility : true if you use old memcache server or extension

Details

$_options
array
available options
visibility
protected
default
array
final
false
static
false

Methods

__construct
jump to class

__construct( array $options = array ) : void

Constructor

Arguments
$options
array
associative array of options
Details
visibility
public
final
false
static
false
throws

clean
jump to class

clean( string $mode = Zend_Cache, 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

Arguments
$mode
string
Clean mode
$tags
array
Array of tags
Output
boolean
True if no problem
Details
visibility
public
final
false
static
false
throws

getCapabilities
jump to class

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)

Output
array
associative of with capabilities
Details
visibility
public
final
false
static
false

getFillingPercentage
jump to class

getFillingPercentage( ) : int

Return the filling percentage of the backend storage

Output
int
integer between 0 and 100
Details
visibility
public
final
false
static
false
throws

getIds
jump to class

getIds( ) : array

Return an array of stored cache ids

Output
array
array of stored cache ids (string)
Details
visibility
public
final
false
static
false

getIdsMatchingAnyTags
jump to class

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

Arguments
$tags
array
array of tags
Output
array
array of any matching cache ids (string)
Details
visibility
public
final
false
static
false

getIdsMatchingTags
jump to class

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

Arguments
$tags
array
array of tags
Output
array
array of matching cache ids (string)
Details
visibility
public
final
false
static
false

getIdsNotMatchingTags
jump to class

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

Arguments
$tags
array
array of tags
Output
array
array of not matching cache ids (string)
Details
visibility
public
final
false
static
false

getMetadatas
jump to class

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

Arguments
$id
string
cache id
Output
array
array of metadatas (false if the cache id is not found)
Details
visibility
public
final
false
static
false

getTags
jump to class

getTags( ) : array

Return an array of stored tags

Output
array
array of stored tags (string)
Details
visibility
public
final
false
static
false

isAutomaticCleaningAvailable
jump to class

isAutomaticCleaningAvailable( ) : boolean

Return true if the automatic cleaning is available for the backend

Output
boolean
Details
visibility
public
final
false
static
false

load
jump to class

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)

Arguments
$id
string
Cache id
$doNotTestCacheValidity
boolean
If set to true, the cache validity won't be tested
Output
string|false
cached datas
Details
visibility
public
final
false
static
false

remove
jump to class

remove( string $id ) : boolean

Remove a cache record

Arguments
$id
string
Cache id
Output
boolean
True if no problem
Details
visibility
public
final
false
static
false

save
jump to class

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)

Arguments
$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)
Output
boolean
True if no problem
Details
visibility
public
final
false
static
false

setDirectives
jump to class

setDirectives( array $directives ) : void

Set the frontend directives

Arguments
$directives
array
Assoc of directives
Details
visibility
public
final
false
static
false
throws

test
jump to class

test( string $id ) : mixed|false

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

Arguments
$id
string
Cache id
Output
mixed|false
(a cache is not available) or "last modified" timestamp (int) of the available cache record
Details
visibility
public
final
false
static
false

touch
jump to class

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

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

Arguments
$id
string
cache id
$extraLifetime
int
Output
boolean
true if ok
Details
visibility
public
final
false
static
false
Documentation was generated by DocBlox.