A wrapper class for the pure-PHP memcached client, exposing a BagOStuff interface. More...

Inheritance diagram for MemcachedPhpBagOStuff:

[legend]

Collaboration diagram for MemcachedPhpBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)
	Available parameters are:

	decr ( $key, $value=1, $flags=0)
	Decrease stored value of $key by $value while preserving its TTL.

	incr ( $key, $value=1, $flags=0)
	Increase stored value of $key by $value while preserving its TTL.

	setDebug ( $enabled)

Public Member Functions inherited from MemcachedBagOStuff
	__construct (array $params)

	makeKeyInternal ( $keyspace, $args)
	Construct a cache key.

	validateKeyEncoding ( $key)
	Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.)

Public Member Functions inherited from MediumSpecificBagOStuff
	add ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	changeTTL ( $key, $exptime=0, $flags=0)
	Change the expiration on a key if it exists.

	changeTTLMulti (array $keys, $exptime, $flags=0)
	Change the expiration of multiple keys that exist.

	clearLastError ()
	Clear the "last error" registry.

	delete ( $key, $flags=0)
	Delete an item.

	deleteMulti (array $keys, $flags=0)
	Batch deletion.

	deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF)
	Delete all objects expiring before a certain date.

	get ( $key, $flags=0)
	Get an item with the given key.

	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually.

	getMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	getQoS ( $flag)

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

	incrWithInit ( $key, $exptime, $value=1, $init=null, $flags=0)
	Increase the value of the given key (no TTL change) if it exists or create it otherwise.

	lock ( $key, $timeout=6, $expiry=6, $rclass='')
	Acquire an advisory lock on a key string.

	makeGlobalKey ( $class,... $components)
	Make a global cache key.

	makeKey ( $class,... $components)
	Make a cache key, scoped to this instance's keyspace.

	merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one)

	set ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	setMulti (array $data, $exptime=0, $flags=0)
	Batch insertion/replace.

	setNewPreparedValues (array $valueByKey)
	Prepare values for storage and get their serialized sizes, or, estimate those sizes.

	unlock ( $key)
	Release an advisory lock on a key string.

Public Member Functions inherited from BagOStuff
	getCurrentTime ()

	getLogger ()

	getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
	Get a lightweight exclusive self-unlocking lock.

	getWithSetCallback ( $key, $exptime, $callback, $flags=0)
	Get an item with the given key, regenerating and setting it if not found.

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

Protected Member Functions
	doAdd ( $key, $value, $exptime=0, $flags=0)
	Insert an item if it does not already exist.

	doCas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.

	doChangeTTL ( $key, $exptime, $flags)

	doDelete ( $key, $flags=0)
	Delete an item.

	doGet ( $key, $flags=0, &$casToken=null)

	doGetMulti (array $keys, $flags=0)
	Get an associative array containing the item for each of the keys that have items.

	doSet ( $key, $value, $exptime=0, $flags=0)
	Set an item.

	serialize ( $value)

	unserialize ( $value)

Protected Member Functions inherited from MemcachedBagOStuff
	fixExpiry ( $exptime)

Protected Member Functions inherited from MediumSpecificBagOStuff
	cas ( $casToken, $key, $value, $exptime=0, $flags=0)
	Check and set an item.

	debug ( $text)

	doDeleteMulti (array $keys, $flags=0)

	doSetMulti (array $data, $exptime=0, $flags=0)

	getExpirationAsTimestamp ( $exptime)
	Convert an optionally relative timestamp to an absolute time.

	getExpirationAsTTL ( $exptime)
	Convert an optionally absolute expiry time to a relative time.

	getSerialized ( $value, $key)
	Get the serialized form a value, using any applicable prepared value.

	guessSerialValueSize ( $value, $depth=0, &$loops=0)
	Estimate the size of a variable once serialized.

	isInteger ( $value)
	Check if a value is an integer.

	isRelativeExpiration ( $exptime)

	makeValueOrSegmentList ( $key, $value, $exptime, $flags)
	Determine the entry (inline or segment list) to store under a key to save the value.

	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)

	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key.

	setLastError ( $err)
	Set the "last error" registry.

Protected Member Functions inherited from BagOStuff
	fieldHasFlags ( $field, $flags)

	mergeFlagMaps (array $bags)
	Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

Protected Attributes
MemcachedClient	$client

Protected Attributes inherited from MediumSpecificBagOStuff
callable[]	$busyCallbacks = []

string	$keyspace = 'local'

int	$lastError = self::ERR_NONE
	ERR_* class constant.

array[]	$locks = []
	Lock tracking.

array[]	$preparedValues = []
	Map of (key => (PHP variable value, serialized value))

int	$segmentationSize
	Bytes; chunk size of segmented cache values.

int	$segmentedValueMaxSize
	Bytes; maximum total size of a segmented cache value.

int	$syncTimeout
	Seconds.

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

int[]	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant)

bool	$debugMode = false

LoggerInterface	$logger

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti(); these are only advisory.

const	READ_VERIFIED = 2

const	WRITE_ALLOW_SEGMENTS = 16

const	WRITE_BACKGROUND = 64

const	WRITE_CACHE_ONLY = 8

const	WRITE_PRUNE_SEGMENTS = 32

const	WRITE_SYNC = 4
	Bitfield constants for set()/merge(); these are only advisory.

Detailed Description

A wrapper class for the pure-PHP memcached client, exposing a BagOStuff interface.

Definition at line 29 of file MemcachedPhpBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedPhpBagOStuff::__construct ( $params )

Available parameters are:

servers: The list of IP:port combinations holding the memcached servers.
persistent: Whether to use a persistent connection
compress_threshold: The minimum size an object must be before it is compressed
timeout: The read timeout in microseconds
connect_timeout: The connect timeout in seconds

Parameters

array $params

Definition at line 43 of file MemcachedPhpBagOStuff.php.

Member Function Documentation

◆ decr()

MemcachedPhpBagOStuff::decr	(	$key,
		$value = `1`,
		$flags = `0`
	)

Decrease stored value of $key by $value while preserving its TTL.

Parameters

string	$key
int	$value	Value to subtract from $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 102 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\validateKeyEncoding().

◆ doAdd()

MemcachedPhpBagOStuff::doAdd	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

protected

Insert an item if it does not already exist.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 79 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doCas()

MemcachedPhpBagOStuff::doCas	(	$casToken,
		$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

protected

Check and set an item.

Parameters

mixed	$casToken
string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 87 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doChangeTTL()

MemcachedPhpBagOStuff::doChangeTTL	(	$key,
		$exptime,
		$flags
	)

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented from MediumSpecificBagOStuff.

Definition at line 108 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ doDelete()

MemcachedPhpBagOStuff::doDelete	(	$key,
		$flags = `0`
	)

protected

Delete an item.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool True if the item was deleted or not found, false on failure

Reimplemented from MediumSpecificBagOStuff.

Definition at line 75 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\validateKeyEncoding().

◆ doGet()

MemcachedPhpBagOStuff::doGet	(		$key,
			$flags = `0`,
		&	$casToken = `null`
	)

protected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	Token to use for check-and-set comparisons

Returns: mixed Returns false on failure or if the item does not exist

Reimplemented from MediumSpecificBagOStuff.

Definition at line 61 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\validateKeyEncoding().

◆ doGetMulti()

MemcachedPhpBagOStuff::doGetMulti	(	array	$keys,
			$flags = `0`
	)

protected

Get an associative array containing the item for each of the keys that have items.

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: array Map of (key => value) for existing keys

Reimplemented from MediumSpecificBagOStuff.

Definition at line 115 of file MemcachedPhpBagOStuff.php.

References $keys, and MemcachedBagOStuff\validateKeyEncoding().

◆ doSet()

MemcachedPhpBagOStuff::doSet	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

protected

Set an item.

Parameters

string	$key
mixed	$value
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Reimplemented from MediumSpecificBagOStuff.

Definition at line 67 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

◆ incr()

MemcachedPhpBagOStuff::incr	(	$key,
		$value = `1`,
		$flags = `0`
	)

Increase stored value of $key by $value while preserving its TTL.

Parameters

string	$key	Key to increase
int	$value	Value to add to $key (default: 1) [optional]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 96 of file MemcachedPhpBagOStuff.php.

References MemcachedBagOStuff\validateKeyEncoding().

◆ serialize()

MemcachedPhpBagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented from MediumSpecificBagOStuff.

Definition at line 123 of file MemcachedPhpBagOStuff.php.

◆ setDebug()

MemcachedPhpBagOStuff::setDebug ( $enabled )

Parameters

bool $enabled

Reimplemented from BagOStuff.

Definition at line 56 of file MemcachedPhpBagOStuff.php.

◆ unserialize()

MemcachedPhpBagOStuff::unserialize ( $value )

protected

Parameters

string | int $value

Returns: mixed Original value or false on error

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented from MediumSpecificBagOStuff.

Definition at line 127 of file MemcachedPhpBagOStuff.php.

References MediumSpecificBagOStuff\isInteger().

Member Data Documentation

◆ $client

MemcachedClient MemcachedPhpBagOStuff::$client

protected

Definition at line 31 of file MemcachedPhpBagOStuff.php.

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

includes/libs/objectcache/MemcachedPhpBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ decr()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doDelete()

◆ doGet()

◆ doGetMulti()

◆ doSet()

◆ incr()

◆ serialize()

◆ setDebug()

◆ unserialize()

Member Data Documentation

◆ $client