A cache class that replicates all writes to multiple child caches. More...

Inheritance diagram for MultiWriteBagOStuff:

[legend]

Collaboration diagram for MultiWriteBagOStuff:

[legend]

Public Member Functions
	__construct ( $params)

	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.

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

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

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

	deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF, string $tag=null)
	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.

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

	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, $exptime=6, $rclass='')
	Acquire an advisory lock on a key string, exclusive to the caller.

	makeGlobalKey ( $collection,... $components)
	Make a cache key for the default keyspace and given components.

	makeKey ( $collection,... $components)
	Make a cache key for the global keyspace and given components.

	makeKeyInternal ( $keyspace, $components)
	Make a cache key for the given keyspace and components.

	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.

	setMockTime (&$time)

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

	setNewPreparedValues (array $valueByKey)
	Make a "generic" reversible cache key from the given components.

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

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

	getCurrentTime ()

	getLogger ()

	getQoS ( $flag)

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

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

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

	isKeyGlobal ( $key)
	Check whether a cache key is in the global keyspace.

	registerWrapperInfoForStats (string $prefixComponent, string $statsGroup, callable $collectionCallback)
	Register info about a caching layer class that uses BagOStuff as a backing store.

	setDebug ( $enabled)

	setLogger (LoggerInterface $logger)

Protected Member Functions
	convertGenericKey ( $key)
	Convert a "generic" reversible cache key into one for this cache.

Protected Member Functions inherited from BagOStuff
	componentsFromGenericKey ( $key)
	Extract the components from a "generic" reversible cache key.

	determineKeyPrefixForStats ( $key)

	fieldHasFlags ( $field, $flags)

	genericKeyFromComponents (... $components)
	At a minimum, there must be a keyspace and collection name component.

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

	proxyCall ( $method, $arg0Sig, $resSig, array $genericArgs)
	Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys.

Protected Attributes
bool	$asyncWrites = false
	Use async secondary writes.

int[]	$cacheIndexes = []
	List of all backing cache indexes.

BagOStuff[]	$caches
	Backing cache stores in order of highest to lowest tier.

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

bool	$debugMode = true
	Whether to send debug log entries to the SPI logger instance.

string	$keyspace
	Default keyspace; used by makeKey()

LoggerInterface	$logger

StatsdDataFactoryInterface	$stats

array< string, array >	$wrapperInfoByPrefix = []
	Cache key processing callbacks and info for metrics.

Private Member Functions
	callKeyMethodOnTierCache ( $index, $method, $arg0Sig, $rvSig, array $args)
	Call a method on the cache instance for the given cache tier (index)

	callKeyWriteMethodOnTierCaches (array $indexes, $asyncSecondary, $method, $arg0Sig, $resSig, array $args)
	Call a write method on the cache instances, in order, for the given tiers (indexes)

	useAsyncSecondaryWrites ( $flags)

Static Private Attributes
static int	$UPGRADE_TTL = 3600
	TTL when a key is copied to a higher cache tier.

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.

Public Attributes inherited from Wikimedia\LightweightObjectStore\StorageAwareness
const	ATTR_DURABILITY = 2
	Durability of writes; see QOS_DURABILITY_* (higher means stronger)

const	ATTR_EMULATION = 1
	Emulation/fallback mode; see QOS_EMULATION_*; higher is better.

const	ERR_NO_RESPONSE = 1
	Storage medium failed to yield a response.

const	ERR_NONE = 0
	No storage medium error.

const	ERR_UNEXPECTED = 3
	Storage medium operation failed due to usage limitations or an I/O error.

const	ERR_UNREACHABLE = 2
	Storage medium could not be reached.

const	QOS_DURABILITY_DISK = 4
	Data is saved to disk and writes do not usually block on fsync()

const	QOS_DURABILITY_NONE = 1
	Data is never saved to begin with (blackhole store)

const	QOS_DURABILITY_RDBMS = 5
	Data is saved to disk and writes usually block on fsync(), like a standard RDBMS.

const	QOS_DURABILITY_SCRIPT = 2
	Data is lost at the end of the current web request or CLI script.

const	QOS_DURABILITY_SERVICE = 3
	Data is lost once the service storing the data restarts.

const	QOS_EMULATION_SQL = 1
	Fallback disk-based SQL store.

const	QOS_UNKNOWN = INF
	Generic "unknown" value; useful for comparisons (always "good enough")

Detailed Description

A cache class that replicates all writes to multiple child caches.

Reads are implemented by reading from the caches in the order they are given in the configuration until a cache gives a positive result.

Note that cache key construction will use the first cache backend in the list, so make sure that the other backends can handle such keys (e.g. via encoding).

@newable

Definition at line 36 of file MultiWriteBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MultiWriteBagOStuff::__construct ( $params )

Stability: stable: to call

Parameters

array

$params

caches: A numbered array of either ObjectFactory::getObjectFromSpec arrays yielding BagOStuff objects or direct BagOStuff objects. If using the former, the 'args' field must be set. The first cache is the primary one, being the first to be read in the fallback chain. Writes happen to all stores in the order they are defined. However, lock()/unlock() calls only use the primary store.
replication: Either 'sync' or 'async'. This controls whether writes to secondary stores are deferred when possible. To use 'async' writes requires the 'asyncHandler' option to be set as well. Async writes can increase the chance of some race conditions or cause keys to expire seconds later than expected. It is safe to use for modules when cached values: are immutable, invalidation uses logical TTLs, invalidation uses etag/timestamp validation against the DB, or merge() is used to handle races.

Exceptions

InvalidArgumentException

Definition at line 69 of file MultiWriteBagOStuff.php.

References BagOStuff\mergeFlagMaps().

Member Function Documentation

◆ add()

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

Definition at line 181 of file MultiWriteBagOStuff.php.

References callKeyMethodOnTierCache(), callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ addBusyCallback()

MultiWriteBagOStuff::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 work 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

Reimplemented from BagOStuff.

Definition at line 383 of file MultiWriteBagOStuff.php.

◆ callKeyMethodOnTierCache()

MultiWriteBagOStuff::callKeyMethodOnTierCache	(		$index,
			$method,
			$arg0Sig,
			$rvSig,
		array	$args
	)

private

Call a method on the cache instance for the given cache tier (index)

Parameters

int	$index	Cache tier
string	$method	Method name
int	$arg0Sig	BagOStuff::A0_* constant describing argument 0
int	$rvSig	BagOStuff::RV_* constant describing the return value
array	$args	Method arguments

Returns: mixed The result of calling the given method

Definition at line 414 of file MultiWriteBagOStuff.php.

References $args.

Referenced by add(), get(), lock(), setNewPreparedValues(), and unlock().

◆ callKeyWriteMethodOnTierCaches()

MultiWriteBagOStuff::callKeyWriteMethodOnTierCaches	(	array	$indexes,
			$asyncSecondary,
			$method,
			$arg0Sig,
			$resSig,
		array	$args
	)

private

Call a write method on the cache instances, in order, for the given tiers (indexes)

Parameters

int[]	$indexes	List of cache tiers
bool	$asyncSecondary	Whether to use asynchronous writes for secondary tiers
string	$method	Method name
int	$arg0Sig	BagOStuff::ARG0_* constant describing argument 0
int	$resSig	BagOStuff::RES_* constant describing the return value
array	$args	Method arguments

Returns: mixed First synchronous result or false if any failed; null if all asynchronous

Definition at line 429 of file MultiWriteBagOStuff.php.

References $args, BagOStuff\$asyncHandler, $cache, $res, serialize(), and unserialize().

Referenced by add(), changeTTL(), changeTTLMulti(), decr(), delete(), deleteMulti(), get(), incr(), incrWithInit(), merge(), set(), and setMulti().

◆ changeTTL()

MultiWriteBagOStuff::changeTTL	(	$key,
		$exptime = `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

For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.

Parameters

string	$key
int	$exptime	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.

Definition at line 222 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ changeTTLMulti()

MultiWriteBagOStuff::changeTTLMulti	(	array	$keys,
			$exptime,
			$flags = `0`
	)

Change the expiration of multiple keys that exist.

See also: BagOStuff::changeTTL()

Parameters

string[]	$keys	List of keys
int	$exptime	TTL or UNIX timestamp
int	$flags	Bitfield of BagOStuff::WRITE_* constants (since 1.33)

Returns: bool Success

Since: 1.34

Reimplemented from BagOStuff.

Definition at line 306 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ clearLastError()

MultiWriteBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 361 of file MultiWriteBagOStuff.php.

References $cache.

◆ convertGenericKey()

MultiWriteBagOStuff::convertGenericKey ( $key )

protected

Convert a "generic" reversible cache key into one for this cache.

See also: BagOStuff::genericKeyFromComponents()

Parameters

string $key Keyspace-prepended list of encoded components as a colon-separated value

Returns: string Keyspace-prepended list of encoded components as a colon-separated value

Reimplemented from BagOStuff.

Definition at line 379 of file MultiWriteBagOStuff.php.

◆ decr()

MultiWriteBagOStuff::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 328 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ delete()

MultiWriteBagOStuff::delete	(	$key,
		$flags = `0`
	)

Delete an item.

For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.

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.

Definition at line 170 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ deleteMulti()

MultiWriteBagOStuff::deleteMulti	(	array	$keys,
			$flags = `0`
	)

Batch deletion.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

WRITE_BACKGROUND can be used for bulk deletion where the response is not vital

Parameters

string[]	$keys	List of keys
int	$flags	Bitfield of BagOStuff::WRITE_* constants

Returns: bool Success

Since: 1.33

Reimplemented from BagOStuff.

Definition at line 295 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ deleteObjectsExpiringBefore()

MultiWriteBagOStuff::deleteObjectsExpiringBefore	(		$timestamp,
		callable	$progress = `null`,
			$limit = `INF`,
		string	$tag = `null`
	)

Delete all objects expiring before a certain date.

Parameters

string \| int	$timestamp	The reference date in MW or TS_UNIX format
callable \| null	$progress	Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional]
int	$limit	Maximum number of keys to delete [default: INF]
string \| null	$tag	Tag to purge a single shard only. This is only supported when server tags are used in configuration.

Returns: bool Success; false if unimplemented

Reimplemented from BagOStuff.

Definition at line 255 of file MultiWriteBagOStuff.php.

References $cache.

◆ get()

MultiWriteBagOStuff::get	(	$key,
		$flags = `0`
	)

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]

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

Reimplemented from BagOStuff.

Definition at line 108 of file MultiWriteBagOStuff.php.

References $args, callKeyMethodOnTierCache(), callKeyWriteMethodOnTierCaches(), and BagOStuff\fieldHasFlags().

◆ getLastError()

MultiWriteBagOStuff::getLastError ( )

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

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

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 350 of file MultiWriteBagOStuff.php.

References $cache, and Wikimedia\LightweightObjectStore\StorageAwareness\ERR_NONE.

◆ getMulti()

MultiWriteBagOStuff::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: mixed[] Map of (key => value) for existing keys

Reimplemented from BagOStuff.

Definition at line 271 of file MultiWriteBagOStuff.php.

References $keys, and $res.

◆ incr()

MultiWriteBagOStuff::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 317 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ incrWithInit()

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

This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $value) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $value.

Parameters

string	$key	Key built via makeKey() or makeGlobalKey()
int	$exptime	Time-to-live (in seconds) or a UNIX timestamp expiration
int	$value	Amount to increase the key value by [default: 1]
int \| null	$init	Value to initialize the key to if it does not exist [default: $value]
int	$flags	Bit field of class WRITE_* constants [optional]

Returns: int|bool New value or false on failure

Since: 1.24

Reimplemented from BagOStuff.

Definition at line 339 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ lock()

MultiWriteBagOStuff::lock	(	$key,
		$timeout = `6`,
		$exptime = `6`,
		$rclass = `''`
	)

Acquire an advisory lock on a key string, exclusive to the caller.

Parameters

string	$key
int	$timeout	Lock wait timeout; 0 for non-blocking [optional]
int	$exptime	Lock time-to-live in seconds; 1 day maximum [optional]
string	$rclass	If this thread already holds the lock, and the lock was acquired using the same value for this parameter, then return true and use reference counting so that only the unlock() call from the outermost lock() caller actually releases the lock (note that only the outermost time-to-live is used) [optional]

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 233 of file MultiWriteBagOStuff.php.

References callKeyMethodOnTierCache().

◆ makeGlobalKey()

MultiWriteBagOStuff::makeGlobalKey	(	$collection,
		$components
	)

Make a cache key for the default keyspace and given components.

See also: IStoreKeyEncoder::makeGlobalKey()

Parameters

string	$collection	Key collection name component
	string\|int	...$components Additional, ordered, key components for entity IDs

Returns: string Colon-separated, keyspace-prepended, ordered list of encoded components

Since: 1.27

Reimplemented from BagOStuff.

Definition at line 375 of file MultiWriteBagOStuff.php.

References BagOStuff\genericKeyFromComponents().

◆ makeKey()

MultiWriteBagOStuff::makeKey	(	$collection,
		$components
	)

Make a cache key for the global keyspace and given components.

See also: IStoreKeyEncoder::makeKey()

Parameters

string	$collection	Key collection name component
	string\|int	...$components Additional, ordered, key components for entity IDs

Returns: string Colon-separated, keyspace-prepended, ordered list of encoded components

Since: 1.27

Reimplemented from BagOStuff.

Definition at line 371 of file MultiWriteBagOStuff.php.

References BagOStuff\genericKeyFromComponents().

◆ makeKeyInternal()

MultiWriteBagOStuff::makeKeyInternal	(	$keyspace,
		$components
	)

Make a cache key for the given keyspace and components.

Long components might be converted to respective hashes due to size constraints. In extreme cases, all of them might be combined into a single hash component.

Access: internal: This method should not be used outside of BagOStuff (since 1.36)

Parameters

string	$keyspace	Keyspace component
string[] \| int[]	$components	Key components (key collection name first)

Returns: string Keyspace-prepended list of encoded components as a colon-separated value

Since: 1.27

Reimplemented from BagOStuff.

Definition at line 367 of file MultiWriteBagOStuff.php.

References BagOStuff\$keyspace, and BagOStuff\genericKeyFromComponents().

◆ merge()

MultiWriteBagOStuff::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. Nothing is stored nor deleted if the callback returns false.

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

Definition at line 211 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ set()

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

Definition at line 159 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ setMockTime()

MultiWriteBagOStuff::setMockTime ( & $time )

Access: internal: For testing only

Parameters

float | null &$time Mock UNIX timestamp

Reimplemented from BagOStuff.

Definition at line 397 of file MultiWriteBagOStuff.php.

References $cache.

◆ setMulti()

MultiWriteBagOStuff::setMulti	(	array	$valueByKey,
			$exptime = `0`,
			$flags = `0`
	)

Batch insertion/replace.

This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O

WRITE_BACKGROUND can be used for bulk insertion where the response is not vital

Parameters

mixed[]	$valueByKey	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 284 of file MultiWriteBagOStuff.php.

References callKeyWriteMethodOnTierCaches(), and useAsyncSecondaryWrites().

◆ setNewPreparedValues()

MultiWriteBagOStuff::setNewPreparedValues ( array $valueByKey )

Make a "generic" reversible cache key from the given components.

All previously prepared values will be cleared. Each of the new prepared values will be individually cleared as they get used by write operations for that key. This is done to avoid unchecked growth in PHP memory usage.

Example usage:

$valueByKey = [ $key1 => $value1, $key2 => $value2, $key3 => $value3 ];
$cache->setNewPreparedValues( $valueByKey );
$cache->set( $key1, $value1, $cache::TTL_HOUR );
$cache->setMulti( [ $key2 => $value2, $key3 => $value3 ], $cache::TTL_HOUR );

This is only useful if the caller needs an estimate of the serialized object sizes. The caller cannot know the serialization format and even if it did, it could be expensive to serialize complex values twice just to get the size information before writing them to cache. This method solves both problems by making the cache instance do the serialization and having it reuse the result when the cache write happens.

Parameters

array $valueByKey Map of (cache key => PHP variable value to serialize)

Returns: int[]|null[] Corresponding list of size estimates (null for invalid values)

Since: 1.35

Reimplemented from BagOStuff.

Definition at line 387 of file MultiWriteBagOStuff.php.

References callKeyMethodOnTierCache().

◆ unlock()

MultiWriteBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from BagOStuff.

Definition at line 244 of file MultiWriteBagOStuff.php.

References callKeyMethodOnTierCache().

◆ useAsyncSecondaryWrites()

MultiWriteBagOStuff::useAsyncSecondaryWrites ( $flags )

private

Parameters

int $flags

Returns: bool

Definition at line 473 of file MultiWriteBagOStuff.php.

References $asyncWrites, and BagOStuff\fieldHasFlags().

Referenced by add(), changeTTL(), changeTTLMulti(), decr(), delete(), deleteMulti(), incr(), incrWithInit(), merge(), set(), and setMulti().

Member Data Documentation

◆ $asyncWrites

bool MultiWriteBagOStuff::$asyncWrites = false

protected

Use async secondary writes.

Definition at line 41 of file MultiWriteBagOStuff.php.

Referenced by useAsyncSecondaryWrites().

◆ $cacheIndexes

int [] MultiWriteBagOStuff::$cacheIndexes = []

protected

List of all backing cache indexes.

Definition at line 43 of file MultiWriteBagOStuff.php.

◆ $caches

BagOStuff [] MultiWriteBagOStuff::$caches

protected

Backing cache stores in order of highest to lowest tier.

Definition at line 38 of file MultiWriteBagOStuff.php.

◆ $UPGRADE_TTL

int MultiWriteBagOStuff::$UPGRADE_TTL = 3600

staticprivate

TTL when a key is copied to a higher cache tier.

Definition at line 46 of file MultiWriteBagOStuff.php.

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

includes/libs/objectcache/MultiWriteBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Static Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addBusyCallback()

◆ callKeyMethodOnTierCache()

◆ callKeyWriteMethodOnTierCaches()

◆ changeTTL()

◆ changeTTLMulti()

◆ clearLastError()

◆ convertGenericKey()

◆ decr()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ get()

◆ getLastError()

◆ getMulti()

◆ incr()

◆ incrWithInit()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ merge()

◆ set()

◆ setMockTime()

◆ setMulti()

◆ setNewPreparedValues()

◆ unlock()

◆ useAsyncSecondaryWrites()

Member Data Documentation

◆ $asyncWrites

◆ $cacheIndexes

◆ $caches

◆ $UPGRADE_TTL