Zend_Cache_Backend_Libmemcached Class Reference

Inheritance diagram for Zend_Cache_Backend_Libmemcached:

Public Member Functions
	__construct (array $options=array())
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	remove ($id)
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
	isAutomaticCleaningAvailable ()
	setDirectives ($directives)
	getIds ()
	getTags ()
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	getFillingPercentage ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)
	getCapabilities ()
Public Member Functions inherited from Zend_Cache_Backend
	__construct (array $options=array())
	setDirectives ($directives)
	setOption ($name, $value)
	getOption ($name)
	getLifetime ($specificLifetime)
	isAutomaticCleaningAvailable ()
	getTmpDir ()

Data Fields
const	DEFAULT_HOST = '127.0.0.1'
const	DEFAULT_PORT = 11211
const	DEFAULT_WEIGHT = 1
const	TAGS_UNSUPPORTED_BY_CLEAN_OF_LIBMEMCACHED_BACKEND = 'Zend_Cache_Backend_Libmemcached::clean() : tags are unsupported by the Libmemcached backend'
const	TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND = 'Zend_Cache_Backend_Libmemcached::save() : tags are unsupported by the Libmemcached backend'

Protected Attributes
	$_options
	$_memcache = null
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Additional Inherited Members
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)

Detailed Description

Definition at line 41 of file Libmemcached.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

associative array of options

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 97 of file Libmemcached.php.

    {
        if (!extension_loaded('memcached')) {
            Zend_Cache::throwException('The memcached extension must be loaded for using this backend !');
        }

        // override default client options
        $this->_options['client'] = array(
            Memcached::OPT_DISTRIBUTION         => Memcached::DISTRIBUTION_CONSISTENT,
            Memcached::OPT_HASH                 => Memcached::HASH_MD5,
            Memcached::OPT_LIBKETAMA_COMPATIBLE => true,
        );

        parent::__construct($options);

        if (isset($this->_options['servers'])) {
            $value = $this->_options['servers'];
            if (isset($value['host'])) {
                // in this case, $value seems to be a simple associative array (one server only)
                $value = array(0 => $value); // let's transform it into a classical array of associative arrays
            }
            $this->setOption('servers', $value);
        }
        $this->_memcache = new Memcached;

        // setup memcached client options
        foreach ($this->_options['client'] as $name => $value) {
            $optId = null;
            if (is_int($name)) {
                $optId = $name;
            } else {
                $optConst = 'Memcached::OPT_' . strtoupper($name);
                if (defined($optConst)) {
                    $optId = constant($optConst);
                } else {
                    $this->_log("Unknown memcached client option '{$name}' ({$optConst})");
                }
            }
            if (null !== $optId) {
                if (!$this->_memcache->setOption($optId, $value)) {
                    $this->_log("Setting memcached client option '{$optId}' failed");
                }
            }
        }

        // setup memcached servers
        $servers = array();
        foreach ($this->_options['servers'] as $server) {
            if (!array_key_exists('port', $server)) {
                $server['port'] = self::DEFAULT_PORT;
            }
            if (!array_key_exists('weight', $server)) {
                $server['weight'] = self::DEFAULT_WEIGHT;
            }

            $servers[] = array($server['host'], $server['port'], $server['weight']);
        }
        $this->_memcache->addServers($servers);
    }

Member Function Documentation

clean()

clean	(		$mode = Zend_Cache::CLEANING_MODE_ALL,
			$tags = array()
	)

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

string	$mode	Clean mode
array	$tags	Array of tags

Exceptions

Zend_Cache_Exception

Returns

boolean True if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 245 of file Libmemcached.php.

    {
        switch ($mode) {
            case Zend_Cache::CLEANING_MODE_ALL:
                return $this->_memcache->flush();
                break;
            case Zend_Cache::CLEANING_MODE_OLD:
                $this->_log("Zend_Cache_Backend_Libmemcached::clean() : CLEANING_MODE_OLD is unsupported by the Libmemcached backend");
                break;
            case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
            case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
            case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
                $this->_log(self::TAGS_UNSUPPORTED_BY_CLEAN_OF_LIBMEMCACHED_BACKEND);
                break;
               default:
                Zend_Cache::throwException('Invalid mode for clean() method');
                   break;
        }
    }

getCapabilities()

getCapabilities

(

)

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

array associative of with capabilities

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 472 of file Libmemcached.php.

    {
        return array(
            'automatic_cleaning' => false,
            'tags' => false,
            'expired_read' => false,
            'priority' => false,
            'infinite_lifetime' => false,
            'get_list' => false
        );
    }

getFillingPercentage()

getFillingPercentage

(

)

Return the filling percentage of the backend storage

Exceptions

Zend_Cache_Exception

Returns

int integer between 0 and 100

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 366 of file Libmemcached.php.

    {
        $mems = $this->_memcache->getStats();
        if ($mems === false) {
            return 0;
        }

        $memSize = null;
        $memUsed = null;
        foreach ($mems as $key => $mem) {
            if ($mem === false) {
                $this->_log('can\'t get stat from ' . $key);
                continue;
            }

            $eachSize = $mem['limit_maxbytes'];
            $eachUsed = $mem['bytes'];
            if ($eachUsed > $eachSize) {
                $eachUsed = $eachSize;
            }

            $memSize += $eachSize;
            $memUsed += $eachUsed;
        }

        if ($memSize === null || $memUsed === null) {
            Zend_Cache::throwException('Can\'t get filling percentage');
        }

        return ((int) (100. * ($memUsed / $memSize)));
    }

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

array array of stored cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 301 of file Libmemcached.php.

    {
        $this->_log("Zend_Cache_Backend_Libmemcached::save() : getting the list of cache ids is unsupported by the Libmemcached backend");
        return array();
    }

getIdsMatchingAnyTags()

getIdsMatchingAnyTags

(

$tags = 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

array

$tags

array of tags

Returns

array array of any matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 354 of file Libmemcached.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND);
        return array();
    }

getIdsMatchingTags()

getIdsMatchingTags

(

$tags = 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

array

$tags

array of tags

Returns

array array of matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 326 of file Libmemcached.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND);
        return array();
    }

getIdsNotMatchingTags()

getIdsNotMatchingTags

(

$tags = 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

array

$tags

array of tags

Returns

array array of not matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 340 of file Libmemcached.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND);
        return array();
    }

getMetadatas()

getMetadatas

(

$id

)

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

string

$id

cache id

Returns

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

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 409 of file Libmemcached.php.

    {
        $tmp = $this->_memcache->get($id);
        if (isset($tmp[0], $tmp[1], $tmp[2])) {
            $data     = $tmp[0];
            $mtime    = $tmp[1];
            $lifetime = $tmp[2];
            return array(
                'expire' => $mtime + $lifetime,
                'tags' => array(),
                'mtime' => $mtime
            );
        }

        return false;
    }

getTags()

getTags

(

)

Return an array of stored tags

Returns

array array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 312 of file Libmemcached.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND);
        return array();
    }

isAutomaticCleaningAvailable()

isAutomaticCleaningAvailable

(

)

Return true if the automatic cleaning is available for the backend

Returns

boolean

Definition at line 270 of file Libmemcached.php.

    {
        return false;
    }

load()

load	(		$id,
			$doNotTestCacheValidity = false
	)

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

Parameters

string	$id	Cache id
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested

Returns

string|false cached datas

Implements Zend_Cache_Backend_Interface.

Definition at line 164 of file Libmemcached.php.

    {
        $tmp = $this->_memcache->get($id);
        if (isset($tmp[0])) {
            return $tmp[0];
        }
        return false;
    }

remove()

remove

(

$id

)

Remove a cache record

Parameters

string

$id

Cache id

Returns

boolean True if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 225 of file Libmemcached.php.

    {
        return $this->_memcache->delete($id);
    }

save()

save	(		$data,
			$id,
			$tags = array(),
			$specificLifetime = false
	)

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

Parameters

string	$data	Datas to cache
string	$id	Cache id
array	$tags	Array of strings, the cache record will be tagged by each string entry
int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)

Returns

boolean True if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 200 of file Libmemcached.php.

    {
        $lifetime = $this->getLifetime($specificLifetime);

        // ZF-8856: using set because add needs a second request if item already exists
        $result = @$this->_memcache->set($id, array($data, time(), $lifetime), $lifetime);
        if ($result === false) {
            $rsCode = $this->_memcache->getResultCode();
            $rsMsg  = $this->_memcache->getResultMessage();
            $this->_log("Memcached::set() failed: [{$rsCode}] {$rsMsg}");
        }

        if (count($tags) > 0) {
            $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND);
        }

        return $result;
    }

setDirectives()

setDirectives

(

$directives

)

Set the frontend directives

Parameters

array

$directives

Assoc of directives

Exceptions

Zend_Cache_Exception

Returns

void

Implements Zend_Cache_Backend_Interface.

Definition at line 282 of file Libmemcached.php.

    {
        parent::setDirectives($directives);
        $lifetime = $this->getLifetime(false);
        if ($lifetime > 2592000) {
            // #ZF-3490 : For the memcached backend, there is a lifetime limit of 30 days (2592000 seconds)
            $this->_log('memcached backend has a limit of 30 days (2592000 seconds) for the lifetime');
        }
        if ($lifetime === null) {
            // #ZF-4614 : we tranform null to zero to get the maximal lifetime
            parent::setDirectives(array('lifetime' => 0));
        }
    }

test()

test

(

$id

)

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

Parameters

string

$id

Cache id

Returns

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

Implements Zend_Cache_Backend_Interface.

Definition at line 179 of file Libmemcached.php.

    {
        $tmp = $this->_memcache->get($id);
        if (isset($tmp[0], $tmp[1])) {
            return (int)$tmp[1];
        }
        return false;
    }

touch()

touch	(		$id,
			$extraLifetime
	)

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

Parameters

string	$id	cache id
int	$extraLifetime

Returns

boolean true if ok

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 433 of file Libmemcached.php.

    {
        $tmp = $this->_memcache->get($id);
        if (isset($tmp[0], $tmp[1], $tmp[2])) {
            $data     = $tmp[0];
            $mtime    = $tmp[1];
            $lifetime = $tmp[2];
            $newLifetime = $lifetime - (time() - $mtime) + $extraLifetime;
            if ($newLifetime <=0) {
                return false;
            }
            // #ZF-5702 : we try replace() first becase set() seems to be slower
            if (!($result = $this->_memcache->replace($id, array($data, time(), $newLifetime), $newLifetime))) {
                $result = $this->_memcache->set($id, array($data, time(), $newLifetime), $newLifetime);
                if ($result === false) {
                    $rsCode = $this->_memcache->getResultCode();
                    $rsMsg  = $this->_memcache->getResultMessage();
                    $this->_log("Memcached::set() failed: [{$rsCode}] {$rsMsg}");
                }
            }
            return $result;
        }
        return false;
    }

Field Documentation

$_memcache

$_memcache = null

protected

Definition at line 88 of file Libmemcached.php.

$_options

$_options

protected

Initial value:

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

Definition at line 74 of file Libmemcached.php.

DEFAULT_HOST

const DEFAULT_HOST = '127.0.0.1'

Default Server Values

Definition at line 46 of file Libmemcached.php.

DEFAULT_PORT

const DEFAULT_PORT = 11211

Definition at line 47 of file Libmemcached.php.

DEFAULT_WEIGHT

const DEFAULT_WEIGHT = 1

Definition at line 48 of file Libmemcached.php.

TAGS_UNSUPPORTED_BY_CLEAN_OF_LIBMEMCACHED_BACKEND

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

Log message

Definition at line 53 of file Libmemcached.php.

TAGS_UNSUPPORTED_BY_SAVE_OF_LIBMEMCACHED_BACKEND

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

Definition at line 54 of file Libmemcached.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/zendframework1/library/Zend/Cache/Backend/Libmemcached.php