Class representing a cache/ephemeral data store. More...

Inheritance diagram for BagOStuff:

[legend]

Collaboration diagram for BagOStuff:

[legend]

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

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

	setMockTime (&$time)

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

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

Public Attributes
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_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Member Functions
	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)

	getCurrentTime ()

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

Protected Attributes
callback 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...

Private Member Functions
	trackDuplicateKeys ( $key)
	Track the number of times that a given key has been used. More...

Private Attributes
bool	$debugMode = false

bool	$dupeTrackScheduled = false

array	$duplicateKeyLookups = []

bool	$reportDupes = false

float null	$wallClockOverride

Detailed Description

Class representing a cache/ephemeral data store.

This interface is intended to be more or less compatible with the PHP memcached client.

Instances of this class should be created with an intended access scope, such as:

a) A single PHP thread on a server (e.g. stored in a PHP variable)
b) A single application server (e.g. stored in APC or sqlite)
c) All application servers in datacenter (e.g. stored in memcached or mysql)
d) All application servers in all datacenters (e.g. stored via mcrouter or dynomite)

Callers should use the proper factory methods that yield BagOStuff instances. Site admins should make sure the configuration for those factory methods matches their access scope. BagOStuff subclasses have widely varying levels of support for replication features.

For any given instance, methods like lock(), unlock(), merge(), and set() with WRITE_SYNC should semantically operate over its entire access scope; any nodes/threads in that scope should serialize appropriately when using them. Likewise, a call to get() with READ_LATEST from one node in its access scope should reflect the prior changes of any other node its access scope. Any get() should reflect the changes of any prior set() with WRITE_SYNC.

Definition at line 58 of file BagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

BagOStuff::__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 in APCBagOStuff, APCUBagOStuff, and MemcachedBagOStuff.

Definition at line 114 of file BagOStuff.php.

References $params, and setLogger().

Member Function Documentation

◆ add()

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

Parameters

string	$key
mixed	$value
int	$exptime

Returns: bool Success

Reimplemented in MemcachedPeclBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, MemcachedBagOStuff, RedisBagOStuff, and EmptyBagOStuff.

Definition at line 618 of file BagOStuff.php.

References $value.

Referenced by incrWithInit(), lock(), and mergeViaCas().

◆ addBusyCallback()

BagOStuff::addBusyCallback ( callable $workCallback )

Let a callback be run to avoid wasting time on special blocking calls.

The callbacks may or may not be called ever, in any particular order. They are likely to be invoked when something WRITE_SYNC is used used. They should follow a caching pattern as shown below, so that any code using the word will get it's result no matter what happens.

$result = null;
$workCallback = function () use ( &$result ) {
    if ( !$result ) {
        $result = ....
    }
    return $result;
}

Parameters

callable $workCallback

Since: 1.28

Definition at line 731 of file BagOStuff.php.

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ cas()

BagOStuff::cas	(	$casToken,
		$key,
		$value,
		$exptime = `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

Returns: bool Success

Exceptions

Exception

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, and MemcachedBagOStuff.

Definition at line 355 of file BagOStuff.php.

References $success, $value, getWithToken(), lock(), and unlock().

Referenced by mergeViaCas().

◆ changeTTL()

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

Reset the TTL on a key if it exists.

Parameters

string	$key
int	$expiry

Returns: bool Success Returns false if there is no key

Since: 1.28

Reimplemented in MemcachedBagOStuff, SqlBagOStuff, RedisBagOStuff, and MemcachedPeclBagOStuff.

Definition at line 438 of file BagOStuff.php.

References $value, and false.

◆ clearLastError()

BagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 698 of file BagOStuff.php.

References ERR_NONE.

Referenced by incrWithInit(), lock(), mergeViaCas(), and mergeViaLock().

◆ convertExpiry()

BagOStuff::convertExpiry ( $exptime )

protected

Convert an optionally relative time to an absolute time.

Parameters

int $exptime

Returns: int

Definition at line 769 of file BagOStuff.php.

References getCurrentTime().

Referenced by SqlBagOStuff\cas(), HashBagOStuff\set(), and SqlBagOStuff\setMulti().

◆ convertToRelative()

BagOStuff::convertToRelative ( $exptime )

protected

Convert an optionally absolute expiry time to a relative time.

If an absolute time is specified which is in the past, use a short expiry time.

Parameters

int $exptime

Returns: int

Definition at line 784 of file BagOStuff.php.

References getCurrentTime().

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

◆ debug()

BagOStuff::debug ( $text )

protected

Parameters

string $text

Definition at line 756 of file BagOStuff.php.

References class.

Referenced by RedisBagOStuff\getMulti(), SqlBagOStuff\getMulti(), RedisBagOStuff\logRequest(), and RedisBagOStuff\setMulti().

◆ decr()

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

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

Parameters

string	$key
int	$value

Returns: int|bool New value or false on failure

Reimplemented in MemcachedPeclBagOStuff, MultiWriteBagOStuff, APCBagOStuff, ReplicatedBagOStuff, APCUBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 654 of file BagOStuff.php.

References $value, and incr().

◆ delete()

BagOStuff::delete ( $key )

abstract

Delete an item.

Parameters

string $key

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

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, RESTBagOStuff, MultiWriteBagOStuff, RedisBagOStuff, HashBagOStuff, APCBagOStuff, ReplicatedBagOStuff, MemcachedBagOStuff, APCUBagOStuff, WinCacheBagOStuff, and EmptyBagOStuff.

◆ deleteObjectsExpiringBefore()

BagOStuff::deleteObjectsExpiringBefore	(	$date,
		$progressCallback = `false`
	)

Delete all objects expiring before a certain date.

Parameters

string	$date	The reference date in MW format
callable \| bool	$progressCallback	Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter.

Returns: bool Success, false if unimplemented

Reimplemented in SqlBagOStuff, MultiWriteBagOStuff, and CachedBagOStuff.

Definition at line 573 of file BagOStuff.php.

◆ doGet()

BagOStuff::doGet	(	$key,
		$flags = `0`
	)

abstractprotected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

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

Reimplemented in SqlBagOStuff, MultiWriteBagOStuff, RedisBagOStuff, RESTBagOStuff, ReplicatedBagOStuff, APCBagOStuff, HashBagOStuff, CachedBagOStuff, MemcachedBagOStuff, APCUBagOStuff, WinCacheBagOStuff, and EmptyBagOStuff.

Referenced by get().

◆ get()

BagOStuff::get	(	$key,
		$flags = `0`,
		$oldFlags = `null`
	)

Get an item with the given key.

If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
int \| null	$oldFlags	[unused]

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

Definition at line 191 of file BagOStuff.php.

References doGet(), and trackDuplicateKeys().

Referenced by MediaWiki\Session\SessionBackend\__construct(), Wikimedia\Rdbms\ChronologyProtector\shutdown(), and BagOStuffTest\testReportDupes().

◆ getCurrentTime()

BagOStuff::getCurrentTime ( )

protected

Returns: float UNIX timestamp

Definition at line 881 of file BagOStuff.php.

Referenced by convertExpiry(), convertToRelative(), HashBagOStuff\expire(), and getScopedLock().

◆ getLastError()

BagOStuff::getLastError ( )

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

Returns: int ERR_* constant for the "last error" registry

Since: 1.23

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 690 of file BagOStuff.php.

References $lastError.

Referenced by incrWithInit(), lock(), mergeViaCas(), and mergeViaLock().

◆ getMulti()

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

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

Parameters

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

Returns: array

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, RedisBagOStuff, ReplicatedBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 584 of file BagOStuff.php.

References $keys, $res, and as.

◆ getQoS()

BagOStuff::getQoS ( $flag )

Parameters

int $flag ATTR_* class constant

Returns: int QOS_* class constant

Since: 1.28

Definition at line 852 of file BagOStuff.php.

References IExpiringStore\QOS_UNKNOWN.

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ getScopedLock()

BagOStuff::getScopedLock	(	$key,
		$timeout = `6`,
		$expiry = `30`,
		$rclass = `''`
	)

final

Get a lightweight exclusive self-unlocking lock.

Note that the same lock cannot be acquired twice.

This is useful for task de-duplication or to avoid obtrusive (though non-corrupting) DB errors like INSERT key conflicts or deadlocks when using LOCK IN SHARE MODE.

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$expiry	Lock expiry [optional]; 1 day maximum
string	$rclass	Allow reentry if set and the current lock used this value

Returns: ScopedCallback|null Returns null on failure

Since: 1.26

Definition at line 541 of file BagOStuff.php.

References getCurrentTime(), lock(), unlock(), and use.

◆ getWithSetCallback()

BagOStuff::getWithSetCallback	(	$key,
		$ttl,
		$callback,
		$flags = `0`
	)

final

Get an item with the given key, regenerating and setting it if not found.

If the callback returns false, then nothing is stored.

Parameters

string	$key
int	$ttl	Time-to-live (seconds)
callable	$callback	Callback that derives the new value
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

Returns: mixed The cached value if found or the result of $callback otherwise

Since: 1.27

Definition at line 161 of file BagOStuff.php.

References $value.

◆ getWithToken()

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

protected

Note: This method is only needed if merge() uses mergeViaCas()

Parameters

string	$key
mixed	&$casToken
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]

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

Exceptions

Exception

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, RedisBagOStuff, and MemcachedBagOStuff.

Definition at line 249 of file BagOStuff.php.

Referenced by cas(), and mergeViaCas().

◆ incr()

BagOStuff::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)

Returns: int|bool New value or false on failure

Reimplemented in RedisBagOStuff, MemcachedPeclBagOStuff, MultiWriteBagOStuff, APCBagOStuff, ReplicatedBagOStuff, APCUBagOStuff, MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 632 of file BagOStuff.php.

References $value, isInteger(), lock(), and unlock().

Referenced by decr(), and incrWithInit().

◆ incrWithInit()

BagOStuff::incrWithInit	(	$key,
		$ttl,
		$value = `1`,
		$init = `1`
	)

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

This will create the key with value $init and TTL $ttl instead if not present

Parameters

string	$key
int	$ttl
int	$value
int	$init

Returns: int|bool New value or false on failure

Since: 1.24

Definition at line 670 of file BagOStuff.php.

References $value, add(), clearLastError(), getLastError(), and incr().

◆ isInteger()

BagOStuff::isInteger ( $value )

protected

Check if a value is an integer.

Parameters

mixed $value

Returns: bool

Definition at line 802 of file BagOStuff.php.

References $value.

Referenced by APCBagOStuff\getUnserialize(), incr(), and APCBagOStuff\setSerialize().

◆ lock()

BagOStuff::lock	(	$key,
		$timeout = `6`,
		$expiry = `6`,
		$rclass = `''`
	)

Acquire an advisory lock on a key string.

Note that if reentry is enabled, duplicate calls ignore $expiry

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$expiry	Lock expiry [optional]; 1 day maximum
string	$rclass	Allow reentry if set and the current lock used this value

Returns: bool Success

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 455 of file BagOStuff.php.

References $code, $fname, add(), clearLastError(), getLastError(), and use.

Referenced by cas(), getScopedLock(), incr(), mergeViaLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ makeGlobalKey()

BagOStuff::makeGlobalKey	(	$class,
		$component = `null`
	)

Make a global cache key.

Since: 1.27

Parameters

string	$class	Key class
string \| null	$component	[optional] Key component (starting with a key collection name)

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 831 of file BagOStuff.php.

References makeKeyInternal().

Referenced by Wikimedia\Rdbms\ChronologyProtector\__construct(), Wikimedia\Rdbms\ChronologyProtector\getTouchedKey(), and BagOStuffTest\testMakeKey().

◆ makeKey()

BagOStuff::makeKey	(	$class,
		$component = `null`
	)

Make a cache key, scoped to this instance's keyspace.

Since: 1.27

Parameters

string	$class	Key class
string \| null	$component	[optional] Key component (starting with a key collection name)

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 843 of file BagOStuff.php.

References makeKeyInternal().

Referenced by CryptHKDF\__construct(), SiteStatsUpdate\getTypeCacheKey(), and BagOStuffTest\testMakeKey().

◆ makeKeyInternal()

BagOStuff::makeKeyInternal	(	$keyspace,
		$args
	)

Construct a cache key.

Since: 1.27

Parameters

string	$keyspace
array	$args

Returns: string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, MemcachedBagOStuff, and CachedBagOStuff.

Definition at line 814 of file BagOStuff.php.

References $args, $keyspace, and as.

Referenced by makeGlobalKey(), makeKey(), and BagOStuffTest\testMakeKey().

◆ merge()

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

Merge changes into the existing cache value (possibly creating a new one)

The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overriden in the callback.

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Exceptions

InvalidArgumentException

Reimplemented in SqlBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, MemcachedBagOStuff, WinCacheBagOStuff, and EmptyBagOStuff.

Definition at line 288 of file BagOStuff.php.

References mergeViaLock().

◆ mergeFlagMaps()

BagOStuff::mergeFlagMaps ( array $bags )

protected

Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

Parameters

BagOStuff[] $bags

Returns: int[] Resulting flag map (class ATTR_* constant => class QOS_* constant)

Definition at line 862 of file BagOStuff.php.

References as.

Referenced by ReplicatedBagOStuff\__construct(), and MultiWriteBagOStuff\__construct().

◆ mergeViaCas()

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

protected

See also: BagOStuff::merge()

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure

Returns: bool Success

Definition at line 301 of file BagOStuff.php.

References $reportDupes, $success, $value, add(), cas(), clearLastError(), getLastError(), and getWithToken().

Referenced by MemcachedBagOStuff\merge(), RedisBagOStuff\merge(), and SqlBagOStuff\merge().

◆ mergeViaLock()

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

protected

See also: BagOStuff::merge()

Parameters

string	$key
callable	$callback	Callback method to be executed
int	$exptime	Either an interval in seconds or a unix timestamp for expiry
int	$attempts	The amount of times to attempt a merge in case of failure
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Definition at line 388 of file BagOStuff.php.

References $reportDupes, $success, $value, clearLastError(), getLastError(), lock(), READ_LATEST, and unlock().

Referenced by WinCacheBagOStuff\merge(), and merge().

◆ modifySimpleRelayEvent()

BagOStuff::modifySimpleRelayEvent ( array $event )

Modify a cache update operation array for EventRelayer::notify()

This is used for relayed writes, e.g. for broadcasting a change to multiple data-centers. If the array contains a 'val' field then the command involves setting a key to that value. Note that for simplicity, 'val' is always a simple scalar value. This method is used to possibly serialize the value and add any cache-specific key/values needed for the relayer daemon (e.g. memcached flags).

Parameters

array $event

Returns: array

Since: 1.26

Reimplemented in RedisBagOStuff, MemcachedBagOStuff, and CachedBagOStuff.

Definition at line 749 of file BagOStuff.php.

◆ set()

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

abstract

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 in SqlBagOStuff, MemcachedPeclBagOStuff, RESTBagOStuff, MultiWriteBagOStuff, HashBagOStuff, APCBagOStuff, ReplicatedBagOStuff, MemcachedBagOStuff, CachedBagOStuff, APCUBagOStuff, RedisBagOStuff, WinCacheBagOStuff, and EmptyBagOStuff.

Referenced by Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ setDebug()

BagOStuff::setDebug ( $bool )

Parameters

bool $bool

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, MemcachedPhpBagOStuff, and CachedBagOStuff.

Definition at line 145 of file BagOStuff.php.

◆ setLastError()

BagOStuff::setLastError ( $err )

protected

Set the "last error" registry.

Parameters

int $err ERR_* constant

Since: 1.23

Definition at line 707 of file BagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\getConnection(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), SqlBagOStuff\handleReadError(), and SqlBagOStuff\handleWriteError().

◆ setLogger()

BagOStuff::setLogger ( LoggerInterface $logger )

Parameters

LoggerInterface $logger

Returns: void

Reimplemented in RESTBagOStuff.

Definition at line 138 of file BagOStuff.php.

References $logger.

Referenced by __construct().

◆ setMockTime()

BagOStuff::setMockTime ( & $time )

Parameters

float | null &$time Mock UNIX timestamp for testing

Definition at line 889 of file BagOStuff.php.

References $time.

◆ setMulti()

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

Batch insertion.

Parameters

array	$data	$key => $value assoc array
int	$exptime	Either an interval in seconds or a unix timestamp for expiry

Returns: bool Success

Since: 1.24

Reimplemented in MemcachedPeclBagOStuff, SqlBagOStuff, and RedisBagOStuff.

Definition at line 602 of file BagOStuff.php.

References $res, $value, and as.

◆ trackDuplicateKeys()

BagOStuff::trackDuplicateKeys ( $key )

private

Track the number of times that a given key has been used.

Parameters

string $key

Definition at line 204 of file BagOStuff.php.

References as.

Referenced by get().

◆ unlock()

BagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Definition at line 507 of file BagOStuff.php.

Referenced by cas(), getScopedLock(), incr(), mergeViaLock(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

Member Data Documentation

◆ $asyncHandler

callback null BagOStuff::$asyncHandler

protected

Definition at line 68 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\doWrite().

◆ $attrMap

int [] BagOStuff::$attrMap = []

protected

Map of (ATTR_* class constant => QOS_* class constant)

Definition at line 88 of file BagOStuff.php.

◆ $busyCallbacks

callable [] BagOStuff::$busyCallbacks = []

protected

Definition at line 82 of file BagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

◆ $debugMode

bool BagOStuff::$debugMode = false

private

Definition at line 73 of file BagOStuff.php.

◆ $dupeTrackScheduled

bool BagOStuff::$dupeTrackScheduled = false

private

Definition at line 79 of file BagOStuff.php.

◆ $duplicateKeyLookups

array BagOStuff::$duplicateKeyLookups = []

private

Definition at line 75 of file BagOStuff.php.

◆ $keyspace

string BagOStuff::$keyspace = 'local'

protected

Definition at line 64 of file BagOStuff.php.

Referenced by MemcachedBagOStuff\makeKeyInternal(), and makeKeyInternal().

◆ $lastError

int BagOStuff::$lastError = self::ERR_NONE

protected

ERR_* class constant.

Definition at line 62 of file BagOStuff.php.

Referenced by getLastError().

◆ $locks

array [] BagOStuff::$locks = []

protected

Lock tracking.

Definition at line 60 of file BagOStuff.php.

◆ $logger

LoggerInterface BagOStuff::$logger

protected

Definition at line 66 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\doWrite(), RESTBagOStuff\setLogger(), and setLogger().

◆ $reportDupes

bool BagOStuff::$reportDupes = false

private

Definition at line 77 of file BagOStuff.php.

Referenced by mergeViaCas(), and mergeViaLock().

◆ $syncTimeout

int BagOStuff::$syncTimeout

protected

Seconds.

Definition at line 70 of file BagOStuff.php.

◆ $wallClockOverride

float null BagOStuff::$wallClockOverride

private

Definition at line 85 of file BagOStuff.php.

◆ ERR_NO_RESPONSE

const BagOStuff::ERR_NO_RESPONSE = 1

Definition at line 92 of file BagOStuff.php.

Referenced by WANObjectCache\getLastError().

◆ ERR_NONE

const BagOStuff::ERR_NONE = 0

Possible values for getLastError()

Definition at line 91 of file BagOStuff.php.

Referenced by clearLastError(), ReplicatedBagOStuff\getLastError(), and WANObjectCache\getLastError().

◆ ERR_UNEXPECTED

const BagOStuff::ERR_UNEXPECTED = 3

Definition at line 94 of file BagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\handleException(), SqlBagOStuff\handleReadError(), SqlBagOStuff\handleWriteError(), and RESTBagOStuffTest\testGetBadServer().

◆ ERR_UNREACHABLE

const BagOStuff::ERR_UNREACHABLE = 2

Definition at line 93 of file BagOStuff.php.

Referenced by RedisBagOStuff\getConnection(), WANObjectCache\getLastError(), SqlBagOStuff\handleReadError(), SqlBagOStuff\handleWriteError(), and RESTBagOStuffTest\testGetBadClient().

◆ READ_LATEST

const BagOStuff::READ_LATEST = 1

Bitfield constants for get()/getMulti()

Definition at line 97 of file BagOStuff.php.

Referenced by SiteStatsUpdate\getPendingDeltas(), and mergeViaLock().

◆ READ_VERIFIED

const BagOStuff::READ_VERIFIED = 2

Definition at line 98 of file BagOStuff.php.

Referenced by ParserCache\get(), and ParserCache\getKey().

◆ WRITE_CACHE_ONLY

const BagOStuff::WRITE_CACHE_ONLY = 2

Definition at line 101 of file BagOStuff.php.

Referenced by CachedBagOStuff\doGet(), MediaWiki\Session\SessionBackend\save(), and CachedBagOStuffTest\testWriteCacheOnly().

◆ WRITE_SYNC

const BagOStuff::WRITE_SYNC = 1

Bitfield constants for set()/merge()

Definition at line 100 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\merge(), MediaWiki\Session\SessionBackend\save(), MultiWriteBagOStuff\set(), and MultiWriteBagOStuffTest\testSyncMerge().

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

includes/libs/objectcache/BagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addBusyCallback()

◆ cas()

◆ changeTTL()

◆ clearLastError()

◆ convertExpiry()

◆ convertToRelative()

◆ debug()

◆ decr()

◆ delete()

◆ deleteObjectsExpiringBefore()

◆ doGet()

◆ get()

◆ getCurrentTime()

◆ getLastError()

◆ getMulti()

◆ getQoS()

◆ getScopedLock()

◆ getWithSetCallback()

◆ getWithToken()

◆ incr()

◆ incrWithInit()

◆ isInteger()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ merge()

◆ mergeFlagMaps()

◆ mergeViaCas()

◆ mergeViaLock()

◆ modifySimpleRelayEvent()

◆ set()

◆ setDebug()

◆ setLastError()

◆ setLogger()

◆ setMockTime()

◆ setMulti()

◆ trackDuplicateKeys()

◆ unlock()

Member Data Documentation

◆ $asyncHandler

◆ $attrMap

◆ $busyCallbacks

◆ $debugMode

◆ $dupeTrackScheduled

◆ $duplicateKeyLookups

◆ $keyspace

◆ $lastError

◆ $locks

◆ $logger

◆ $reportDupes

◆ $syncTimeout

◆ $wallClockOverride

◆ ERR_NO_RESPONSE

◆ ERR_NONE

◆ ERR_UNEXPECTED

◆ ERR_UNREACHABLE

◆ READ_LATEST

◆ READ_VERIFIED

◆ WRITE_CACHE_ONLY

◆ WRITE_SYNC