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

Inheritance diagram for MemcachedPeclBagOStuff:

[legend]

Collaboration diagram for MemcachedPeclBagOStuff:

[legend]

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

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

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

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

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

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

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

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

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

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

	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.

	getClient ()
	Get the underlying client object.

	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 BagOStuff
	addBusyCallback (callable $workCallback)
	Let a callback be run to avoid wasting time on special blocking calls.

	clearLastError ()
	Clear the "last error" registry.

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

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	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.

	getQoS ( $flag)

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

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

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

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

	makeGlobalKey ( $class, $component=null)
	Make a global cache key.

	makeKey ( $class, $component=null)
	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)

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

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

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

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

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

Protected Member Functions inherited from MemcachedBagOStuff
	debugLog ( $text)
	Send a debug message to the log.

Protected Member Functions inherited from BagOStuff
	convertToExpiry ( $exptime)
	Convert an optionally relative time to an absolute time.

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

	debug ( $text)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

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

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

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

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

Additional Inherited Members
Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

const	WRITE_SYNC = 4
	Bitfield constants for set()/merge()

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 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_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Attributes inherited from MemcachedBagOStuff
MemcachedClient Memcached	$client

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

int	$syncTimeout
	Seconds.

Detailed Description

A wrapper class for the PECL memcached client.

Definition at line 29 of file MemcachedPeclBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedPeclBagOStuff::__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
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 47 of file MemcachedPeclBagOStuff.php.

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

Member Function Documentation

◆ add()

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

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 MemcachedBagOStuff.

Definition at line 188 of file MemcachedPeclBagOStuff.php.

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

◆ applyDefaultParams()

MemcachedPeclBagOStuff::applyDefaultParams ( $params )

protected

Fill in some defaults for missing keys in $params.

Parameters

array $params

Returns: array

Reimplemented from MemcachedBagOStuff.

Definition at line 127 of file MemcachedPeclBagOStuff.php.

References $params, and and().

Referenced by __construct().

◆ cas()

MemcachedPeclBagOStuff::cas	(	$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

Exceptions

Exception

Reimplemented from MemcachedBagOStuff.

Definition at line 173 of file MemcachedPeclBagOStuff.php.

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

◆ changeTTL()

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

Change the expiration on a key if it exists.

If an expiry in the past is given then the key will immediately be expired

Parameters

string	$key
int	$expiry	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

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

Since: 1.28

Reimplemented from MemcachedBagOStuff.

Definition at line 263 of file MemcachedPeclBagOStuff.php.

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

◆ checkResult()

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 216 of file MemcachedPeclBagOStuff.php.

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

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

◆ decr()

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

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

Parameters

string	$key
int	$value	Value to subtract from $key (default: 1) [optional]

Returns: int|bool New value or false on failure

Reimplemented from MemcachedBagOStuff.

Definition at line 199 of file MemcachedPeclBagOStuff.php.

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

◆ delete()

MemcachedPeclBagOStuff::delete	(		$key,
			$flags = 0 )

Delete an item.

Parameters

string $key

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

Parameters

int $flags Bitfield of BagOStuff::WRITE_* constants

Reimplemented from MemcachedBagOStuff.

Definition at line 178 of file MemcachedPeclBagOStuff.php.

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

◆ doGet()

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

protected

@suppress PhanTypeNonVarPassByRef

Reimplemented from MemcachedBagOStuff.

Definition at line 144 of file MemcachedPeclBagOStuff.php.

References $res, $result, and(), checkResult(), MemcachedBagOStuff\debugLog(), and MemcachedBagOStuff\validateKeyEncoding().

◆ getMulti()

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

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

Reimplemented from BagOStuff.

Definition at line 245 of file MemcachedPeclBagOStuff.php.

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

◆ incr()

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

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]

Returns: int|bool New value or false on failure

Reimplemented from MemcachedBagOStuff.

Definition at line 193 of file MemcachedPeclBagOStuff.php.

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

◆ set()

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

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 MemcachedBagOStuff.

Definition at line 163 of file MemcachedPeclBagOStuff.php.

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

◆ setMulti()

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

Batch insertion/replace.

Parameters

mixed[]	$data	Map of (key => value)
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Since: 1.24

Reimplemented from BagOStuff.

Definition at line 254 of file MemcachedPeclBagOStuff.php.

References $data, and(), 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

◆ __construct()

Member Function Documentation

◆ add()

◆ applyDefaultParams()

◆ cas()

◆ changeTTL()

◆ checkResult()

◆ decr()

◆ delete()

◆ doGet()

◆ getMulti()

◆ incr()

◆ set()

◆ setMulti()