Memcached Class Reference

Inheritance diagram for Memcached:

Public Member Functions
	__construct (array $options=[])
	save ($data, $id, $tags=[], $specificLifetime=false)
	load ($id, $doNotTestCacheValidity=false)
Public Member Functions inherited from Zend_Cache_Backend_Memcached
	__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_SLAB_SIZE = 1048576
const	CODE_WORD = '{splitted}'
Data Fields inherited from Zend_Cache_Backend_Memcached
const	DEFAULT_HOST = '127.0.0.1'
const	DEFAULT_PORT = 11211
const	DEFAULT_PERSISTENT = true
const	DEFAULT_WEIGHT = 1
const	DEFAULT_TIMEOUT = 1
const	DEFAULT_RETRY_INTERVAL = 15
const	DEFAULT_STATUS = true
const	DEFAULT_FAILURE_CALLBACK = null
const	TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::clean() : tags are unsupported by the Memcached backend'
const	TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::save() : tags are unsupported by the Memcached backend'

Protected Member Functions
	_getChunkId ($id, $index)
	_cleanTheMess ($id, $chunks)
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)

Additional Inherited Members
Protected Attributes inherited from Zend_Cache_Backend_Memcached
	$_options
	$_memcache = null
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Detailed Description

Definition at line 8 of file Memcached.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = []

)

Constructor

Parameters

array

$options

See also

\Zend_Cache_Backend_Memcached::__construct()

Exceptions

Definition at line 26 of file Memcached.php.

    {
        parent::__construct($options);

        if (!isset($options['slab_size']) || !is_numeric($options['slab_size'])) {
            if (isset($options['slab_size'])) {
                throw new \Magento\Framework\Exception\LocalizedException(
                    new \Magento\Framework\Phrase(
                        "Invalid value for the node <slab_size>. Expected to be positive integer."
                    )
                );
            }

            $this->_options['slab_size'] = self::DEFAULT_SLAB_SIZE;
        } else {
            $this->_options['slab_size'] = $options['slab_size'];
        }
    }

Member Function Documentation

_cleanTheMess()

_cleanTheMess (   $id,   $chunks  )

protected

Remove saved chunks in case something gone wrong (e.g. some chunk from the chain can not be found)

Parameters

string	$id	ID of data's info cell
int	$chunks	Number of chunks to remove (basically, the number after '{splitted}|')

Returns

null

Definition at line 64 of file Memcached.php.

    {
        for ($i = 0; $i < $chunks; $i++) {
            $this->remove($this->_getChunkId($id, $i));
        }

        $this->remove($id);
    }

_getChunkId()

_getChunkId (   $id,   $index  )

protected

Returns ID of a specific chunk on the basis of data's ID

Parameters

string	$id	Main data's ID
int	$index	Particular chunk number to return ID for

Returns

string

Definition at line 52 of file Memcached.php.

    {
        return "{$id}[{$index}]";
    }

load()

load	(		$id,
			$doNotTestCacheValidity = false
	)

Load data from memcached, glue from several chunks if it was splitted upon save.

Parameters

string

$id

See also

\Zend_Cache_Backend_Memcached::load()

Parameters

bool

$doNotTestCacheValidity

See also

\Zend_Cache_Backend_Memcached::load()

Returns

bool|false|string

Implements Zend_Cache_Backend_Interface.

Definition at line 109 of file Memcached.php.

    {
        $data = parent::load($id, $doNotTestCacheValidity);

        if (is_string($data) && substr($data, 0, strlen(self::CODE_WORD)) == self::CODE_WORD) {
            // Seems we've got chunked data

            $arr = explode('|', $data);
            $chunks = isset($arr[1]) ? $arr[1] : false;
            $chunkData = [];

            if ($chunks && is_numeric($chunks)) {
                for ($i = 0; $i < $chunks; $i++) {
                    $chunk = parent::load($this->_getChunkId($id, $i), $doNotTestCacheValidity);

                    if (false === $chunk) {
                        // Some chunk in chain was not found, we can not glue-up the data:
                        // clean the mess and return nothing

                        $this->_cleanTheMess($id, $chunks);
                        return false;
                    }

                    $chunkData[] = $chunk;
                }

                return implode('', $chunkData);
            }
        }

        // Data has not been splitted to chunks on save
        return $data;
    }

save()

save	(		$data,
			$id,
			$tags = [],
			$specificLifetime = false
	)

Save data to memcached, split it into chunks if data size is bigger than memcached slab size.

Parameters

string

$data

See also

\Zend_Cache_Backend_Memcached::save()

Parameters

string

$id

See also

\Zend_Cache_Backend_Memcached::save()

Parameters

string[]

$tags

See also

\Zend_Cache_Backend_Memcached::save()

Parameters

bool

$specificLifetime

See also

\Zend_Cache_Backend_Memcached::save()

Returns

bool

Implements Zend_Cache_Backend_Interface.

Definition at line 82 of file Memcached.php.

    {
        if (is_string($data) && strlen($data) > $this->_options['slab_size']) {
            $dataChunks = str_split($data, $this->_options['slab_size']);

            for ($i = 0, $cnt = count($dataChunks); $i < $cnt; $i++) {
                $chunkId = $this->_getChunkId($id, $i);

                if (!parent::save($dataChunks[$i], $chunkId, $tags, $specificLifetime)) {
                    $this->_cleanTheMess($id, $i + 1);
                    return false;
                }
            }

            $data = self::CODE_WORD . '|' . $i;
        }

        return parent::save($data, $id, $tags, $specificLifetime);
    }

Field Documentation

CODE_WORD

const CODE_WORD = '{splitted}'

Used to tell chunked data from ordinary

Definition at line 18 of file Memcached.php.

DEFAULT_SLAB_SIZE

const DEFAULT_SLAB_SIZE = 1048576

Maximum chunk of data that could be saved in one memcache cell (1 MiB)

Definition at line 13 of file Memcached.php.

---

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

• vendor/magento/framework/Cache/Backend/Memcached.php