A wrapper class for the PECL memcached client. More...

Inheritance diagram for MemcachedPeclBagOStuff:

Collaboration diagram for MemcachedPeclBagOStuff:

Public Member Functions
	__construct ($params)
	Constructor. More...

	add ($key, $value, $exptime=0)

	changeTTL ($key, $expiry=0)

	decr ($key, $value=1)

	delete ($key)

	getMulti (array $keys, $flags=0)

	incr ($key, $value=1)

	set ($key, $value, $exptime=0, $flags=0)

	setMulti (array $data, $exptime=0)

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

	add ($key, $value, $exptime=0)

	changeTTL ($key, $exptime=0)

	delete ($key)

	fixExpiry ($expiry)
	TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the cache entry being discarded immediately because the expiry is in the past. More...

	getClient ()
	Get the underlying client object. More...

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

	merge ($key, callable $callback, $exptime=0, $attempts=10, $flags=0)

	modifySimpleRelayEvent (array $event)

	set ($key, $value, $exptime=0, $flags=0)

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

Public Member Functions inherited from BagOStuff
	__construct (array $params=[])
	$params include: More...

	add ($key, $value, $exptime=0)

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

	changeTTL ($key, $expiry=0)
	Reset the TTL on a key if it exists. More...

	clearLastError ()
	Clear the "last error" registry. More...

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

	delete ($key)
	Delete an item. More...

	deleteObjectsExpiringBefore ($date, $progressCallback=false)
	Delete all objects expiring before a certain date. More...

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

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

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

	getQoS ($flag)

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

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

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

	incrWithInit ($key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL. More...

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

	makeGlobalKey ()
	Make a global cache key. More...

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

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

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

	modifySimpleRelayEvent (array $event)
	Modify a cache update operation array for EventRelayer::notify() More...

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

	setDebug ($bool)

	setLogger (LoggerInterface $logger)

	setMulti (array $data, $exptime=0)
	Batch insertion. More...

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

Protected Member Functions
	applyDefaultParams ($params)

	cas ($casToken, $key, $value, $exptime=0)

	checkResult ($key, $result)
	Check the return value from a client method call and take any necessary action. More...

	getWithToken ($key, &$casToken, $flags=0)

Protected Member Functions inherited from MemcachedBagOStuff
	applyDefaultParams ($params)
	Fill in some defaults for missing keys in $params. More...

	cas ($casToken, $key, $value, $exptime=0)

	debugLog ($text)
	Send a debug message to the log. More...

	doGet ($key, $flags=0)

	getWithToken ($key, &$casToken, $flags=0)

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

	convertExpiry ($exptime)
	Convert an optionally relative time to an absolute time. More...

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

	debug ($text)

	doGet ($key, $flags=0)

	getWithToken ($key, &$casToken, $flags=0)

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

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

	mergeViaCas ($key, $callback, $exptime=0, $attempts=10)

	mergeViaLock ($key, $callback, $exptime=0, $attempts=10, $flags=0)

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

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0
	Possible values for getLastError() More...

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti() More...

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

const	WRITE_SYNC = 1
	Bitfield constants for set()/merge() More...

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	QOS_EMULATION_SQL = 1

const	QOS_SYNCWRITES_BE = 2

const	QOS_SYNCWRITES_NONE = 1

const	QOS_SYNCWRITES_QC = 3

const	QOS_SYNCWRITES_SS = 4

const	QOS_UNKNOWN = INF

const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_PROC_LONG = 30

const	TTL_PROC_SHORT = 3

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Attributes inherited from MemcachedBagOStuff
MemcachedClient Memcached	$client

Protected Attributes inherited from BagOStuff
callback null	$asyncHandler

integer[]	$attrMap = []
	Map of (ATTR_* class constant => QOS_* class constant) More...

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

integer	$lastError = self::ERR_NONE
	ERR_* class constant. More...

array[]	$locks = []
	Lock tracking. More...

LoggerInterface	$logger

integer	$syncTimeout
	Seconds. More...

Detailed Description

A wrapper class for the PECL memcached client.

Definition at line 29 of file MemcachedPeclBagOStuff.php.

Constructor & Destructor Documentation

MemcachedPeclBagOStuff::__construct ( $params )

Constructor.

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
retry_timeout: Time in seconds to wait before retrying a failed connect attempt
server_failure_limit: Limit for server connect failures before it is removed
serializer: May be either "php" or "igbinary". Igbinary produces more compact values, but serialization is much slower unless the php.ini option igbinary.compact_strings is off.
use_binary_protocol Whether to enable the binary protocol (default is ASCII) (boolean)
Parameters

array $params

Exceptions

InvalidArgumentException

Definition at line 49 of file MemcachedPeclBagOStuff.php.

References $params, applyDefaultParams(), as, false, and serialize().

Member Function Documentation

MemcachedPeclBagOStuff::add	(	$key,
		$value,
		$exptime = `0`
	)

Definition at line 171 of file MemcachedPeclBagOStuff.php.

References $value, add, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::applyDefaultParams ( $params )

protected

Definition at line 129 of file MemcachedPeclBagOStuff.php.

References $params.

Referenced by __construct().

MemcachedPeclBagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = `0`
	)

protected

Definition at line 155 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::changeTTL	(	$key,
		$expiry = `0`
	)

Definition at line 251 of file MemcachedPeclBagOStuff.php.

References checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::checkResult	(	$key,
		$result
	)

protected

Check the return value from a client method call and take any necessary action.

Returns the value that the wrapper function should return. At present, the return value is always the same as the return value from the client, but some day we might find a case where it should be different.

Parameters

string	$key	The key used by the caller, or false if there wasn't one.
mixed	$result	The return value

Returns: mixed

Definition at line 199 of file MemcachedPeclBagOStuff.php.

References MemcachedBagOStuff\debugLog(), BagOStuff\ERR_UNEXPECTED, and BagOStuff\setLastError().

Referenced by add(), cas(), changeTTL(), decr(), delete(), getMulti(), getWithToken(), incr(), set(), and setMulti().

MemcachedPeclBagOStuff::decr	(	$key,
		$value = `1`
	)

Definition at line 182 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::delete ( $key )

Definition at line 160 of file MemcachedPeclBagOStuff.php.

References checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::getMulti	(	array	$keys,
			$flags = `0`
	)

Definition at line 228 of file MemcachedPeclBagOStuff.php.

References as, checkResult(), MemcachedBagOStuff\debugLog(), and MemcachedBagOStuff\validateKeyEncoding().

MemcachedPeclBagOStuff::getWithToken	(		$key,
		&	$casToken,
			$flags = `0`
	)

protected

Definition at line 143 of file MemcachedPeclBagOStuff.php.

References checkResult(), MemcachedBagOStuff\debugLog(), and MemcachedBagOStuff\validateKeyEncoding().

MemcachedPeclBagOStuff::incr	(	$key,
		$value = `1`
	)

Definition at line 176 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::set	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

Definition at line 150 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), MemcachedBagOStuff\debugLog(), and set.

MemcachedPeclBagOStuff::setMulti	(	array	$data,
			$exptime = `0`
	)

Parameters

array	$data
int	$exptime

Returns: bool

Definition at line 242 of file MemcachedPeclBagOStuff.php.

References as, checkResult(), MemcachedBagOStuff\debugLog(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().

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

includes/libs/objectcache/MemcachedPeclBagOStuff.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation