Base class for memcached clients. More...

Inheritance diagram for MemcachedBagOStuff:

[legend]

Collaboration diagram for MemcachedBagOStuff:

[legend]

Public Member Functions
	__construct (array $params)
	$params include: More...

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

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

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

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

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

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

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

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

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

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

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

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

	get ( $key, $flags=0)
	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...

	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 ( $class, $component=null)
	Make a global cache key. More...

	makeKey ( $class, $component=null)
	Make a cache key, scoped to this instance's keyspace. More...

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

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

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

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

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

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

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

Protected Member Functions inherited from BagOStuff
	convertToExpiry ( $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)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

	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, $flags=0)

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

Protected Attributes
MemcachedClient Memcached	$client

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

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

LoggerInterface	$logger

int	$syncTimeout
	Seconds. More...

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

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

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

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

Detailed Description

Base class for memcached clients.

Definition at line 29 of file MemcachedBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedBagOStuff::__construct ( array $params )

$params include:

logger: Psr\Log\LoggerInterface instance
keyspace: Default keyspace for $this->makeKey()
asyncHandler: Callable to use for scheduling tasks after the web request ends. In CLI mode, it should run the task immediately.
reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
syncTimeout: How long to wait with WRITE_SYNC in seconds.
Parameters

array $params

Reimplemented from BagOStuff.

Definition at line 33 of file MemcachedBagOStuff.php.

References $params, IExpiringStore\ATTR_SYNCWRITES, and IExpiringStore\QOS_SYNCWRITES_BE.

Member Function Documentation

◆ add()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 71 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

Referenced by MemcLockManager\acquireMutexes().

◆ applyDefaultParams()

MemcachedBagOStuff::applyDefaultParams ( $params )

protected

Fill in some defaults for missing keys in $params.

Parameters

array $params

Returns: array

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 45 of file MemcachedBagOStuff.php.

References $params, and false.

Referenced by MemcachedPhpBagOStuff\__construct().

◆ cas()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 62 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

◆ changeTTL()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 88 of file MemcachedBagOStuff.php.

References fixExpiry(), and validateKeyEncoding().

◆ debugLog()

MemcachedBagOStuff::debugLog ( $text )

protected

Send a debug message to the log.

Parameters

string $text

Definition at line 183 of file MemcachedBagOStuff.php.

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

◆ decr()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 82 of file MemcachedBagOStuff.php.

References $value, and validateKeyEncoding().

◆ delete()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 67 of file MemcachedBagOStuff.php.

References validateKeyEncoding().

Referenced by MemcLockManager\releaseMutexes().

◆ doGet()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 53 of file MemcachedBagOStuff.php.

References validateKeyEncoding().

◆ fixExpiry()

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

Clamp expires >30d at 30d, unless they're >=1e9 in which case they are likely to really be absolute (1e9 = 2011-09-09)

Parameters

int $expiry

Returns: int

Definition at line 172 of file MemcachedBagOStuff.php.

Referenced by add(), cas(), changeTTL(), set(), and MemcachedPeclBagOStuff\setMulti().

◆ getClient()

MemcachedBagOStuff::getClient ( )

Get the underlying client object.

This is provided for debugging purposes.

Returns: MemcachedClient|Memcached

Definition at line 98 of file MemcachedBagOStuff.php.

References $client.

◆ incr()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 76 of file MemcachedBagOStuff.php.

References $value, and validateKeyEncoding().

◆ makeKeyInternal()

MemcachedBagOStuff::makeKeyInternal	(	$keyspace,
		$args
	)

Construct a cache key.

Since: 1.27

Parameters

string	$keyspace
array	$args

Returns: string

Reimplemented from BagOStuff.

Definition at line 110 of file MemcachedBagOStuff.php.

References $args, BagOStuff\$keyspace, captcha-old\count, and use.

◆ set()

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

Reimplemented in MemcachedPeclBagOStuff.

Definition at line 57 of file MemcachedBagOStuff.php.

References $value, fixExpiry(), and validateKeyEncoding().

◆ validateKeyEncoding()

MemcachedBagOStuff::validateKeyEncoding ( $key )

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

Parameters

string $key

Returns: string

Exceptions

Exception

Definition at line 156 of file MemcachedBagOStuff.php.

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

Member Data Documentation

◆ $client

MemcachedClient Memcached MemcachedBagOStuff::$client

protected

Definition at line 31 of file MemcachedBagOStuff.php.

Referenced by getClient().

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

includes/libs/objectcache/MemcachedBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ applyDefaultParams()

◆ cas()

◆ changeTTL()

◆ debugLog()

◆ decr()

◆ delete()

◆ doGet()

◆ fixExpiry()

◆ getClient()

◆ incr()

◆ makeKeyInternal()

◆ set()

◆ validateKeyEncoding()

Member Data Documentation

◆ $client