Storage medium specific cache for storing items (e.g. More...

Inheritance diagram for MediumSpecificBagOStuff:

[legend]

Collaboration diagram for MediumSpecificBagOStuff:

[legend]

Public Member Functions
	__construct (array $params=[])

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

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

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

	changeTTLMulti (array $keys, $exptime, $flags=0)
	Change the expiration of multiple keys that exist. More...

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

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

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

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

	getSegmentationSize ()

	getSegmentedValueMaxSize ()

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

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

	makeGlobalKey ( $class,... $components)
	Make a global cache key. More...

	makeKey ( $class,... $components)
	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...

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

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

	setNewPreparedValues (array $valueByKey)
	Prepare values for storage and get their serialized sizes, or, estimate those sizes. More...

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

Public Member Functions inherited from BagOStuff
	decr ( $key, $value=1, $flags=0)
	Decrease stored value of $key by $value while preserving its TTL. More...

	getCurrentTime ()

	getLogger ()

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

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

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

	setDebug ( $enabled)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

	debug ( $text)

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

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

	doChangeTTL ( $key, $exptime, $flags)

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

	doDeleteMulti (array $keys, $flags=0)

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

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

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

	doSetMulti (array $data, $exptime=0, $flags=0)

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

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

	getSerialized ( $value, $key)
	Get the serialized form a value, using any applicable prepared value. More...

	guessSerialValueSize ( $value, $depth=0, &$loops=0)
	Estimate the size of a variable once serialized. More...

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

	isRelativeExpiration ( $exptime)

	makeValueOrSegmentList ( $key, $value, $exptime, $flags)
	Determine the entry (inline or segment list) to store under a key to save the value. More...

	mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags)

	resolveSegments ( $key, $mainValue)
	Get and reassemble the chunks of blob at the given key. More...

	serialize ( $value)

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

	unserialize ( $value)

Protected Member Functions inherited from BagOStuff
	fieldHasFlags ( $field, $flags)

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

Protected Attributes
callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

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

array[]	$preparedValues = []
	Map of (key => (PHP variable value, serialized value)) More...

int	$segmentationSize
	Bytes; chunk size of segmented cache values. More...

int	$segmentedValueMaxSize
	Bytes; maximum total size of a segmented cache value. More...

int	$syncTimeout
	Seconds. More...

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

bool	$debugMode = false

LoggerInterface	$logger

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

Private Attributes
bool	$dupeTrackScheduled = false

array	$duplicateKeyLookups = []

bool	$reportDupes = false

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

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

Detailed Description

Storage medium specific cache for storing items (e.g.

redis, memcached, ...)

This should not be used for proxy classes that simply wrap other cache instances

Since: 1.34

Definition at line 34 of file MediumSpecificBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MediumSpecificBagOStuff::__construct ( array $params = [] )

See also

BagOStuff::__construct() Additional $params options include:

logger: Psr\Log\LoggerInterface instance
keyspace: Default keyspace for $this->makeKey()
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.
segmentationSize: The chunk size, in bytes, of segmented values. The value should not exceed the maximum size of values in the storage backend, as configured by the site administrator.
segmentedValueMaxSize: The maximum total size, in bytes, of segmented values. This should be configured to a reasonable size give the site traffic and the amount of I/O between application and cache servers that the network can handle.

Parameters

array $params -param array{logger?:Psr\Log\LoggerInterface,asyncHandler?:callable,keyspace?:string,reportDupes?:bool,syncTimeout?:int,segmentationSize?:int,segmentedValueMaxSize?:int} $params

Reimplemented from BagOStuff.

Reimplemented in APCUBagOStuff, WinCacheBagOStuff, EmptyBagOStuff, and MemcachedBagOStuff.

Definition at line 86 of file MediumSpecificBagOStuff.php.

Member Function Documentation

◆ add()

MediumSpecificBagOStuff::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 232 of file MediumSpecificBagOStuff.php.

Referenced by MemcLockManager\acquireMutexes().

◆ addBusyCallback()

MediumSpecificBagOStuff::addBusyCallback ( callable $workCallback )

final

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 762 of file MediumSpecificBagOStuff.php.

◆ cas()

MediumSpecificBagOStuff::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

Definition at line 341 of file MediumSpecificBagOStuff.php.

◆ changeTTL()

MediumSpecificBagOStuff::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 418 of file MediumSpecificBagOStuff.php.

◆ changeTTLMulti()

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

Change the expiration of multiple keys that exist.

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

See also: BagOStuff::changeTTL()

Since: 1.34

Reimplemented from BagOStuff.

Reimplemented in SqlBagOStuff, and RedisBagOStuff.

Definition at line 674 of file MediumSpecificBagOStuff.php.

References $keys, and $res.

◆ clearLastError()

MediumSpecificBagOStuff::clearLastError ( )

Clear the "last error" registry.

Since: 1.23

Reimplemented from BagOStuff.

Definition at line 749 of file MediumSpecificBagOStuff.php.

◆ debug()

MediumSpecificBagOStuff::debug ( $text )

protected

Parameters

string $text

Definition at line 1064 of file MediumSpecificBagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), MemcachedPeclBagOStuff\decr(), MemcachedPeclBagOStuff\doAdd(), MemcachedPeclBagOStuff\doCas(), MemcachedPeclBagOStuff\doChangeTTL(), MemcachedPeclBagOStuff\doDelete(), MemcachedPeclBagOStuff\doDeleteMulti(), MemcachedPeclBagOStuff\doGet(), MemcachedPeclBagOStuff\doGetMulti(), MemcachedPeclBagOStuff\doSet(), MemcachedPeclBagOStuff\doSetMulti(), SqlBagOStuff\fetchBlobMulti(), MemcachedPeclBagOStuff\incr(), and RedisBagOStuff\logRequest().

◆ delete()

MediumSpecificBagOStuff::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
int	$flags	Bitfield of BagOStuff::WRITE_* constants

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

Reimplemented from BagOStuff.

Definition at line 199 of file MediumSpecificBagOStuff.php.

References doDelete(), doGet(), BagOStuff\fieldHasFlags(), SerializedValueContainer\isSegmented(), makeGlobalKey(), and SerializedValueContainer\SEGMENTED_HASHES.

Referenced by MemcLockManager\releaseMutexes().

◆ deleteMulti()

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

Batch deletion.

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

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 642 of file MediumSpecificBagOStuff.php.

References $keys.

◆ deleteObjectsExpiringBefore()

MediumSpecificBagOStuff::deleteObjectsExpiringBefore	(		$timestamp,
		callable	$progress = `null`,
			$limit = `INF`
	)

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]

Returns: bool Success; false if unimplemented

Reimplemented from BagOStuff.

Reimplemented in SqlBagOStuff.

Definition at line 548 of file MediumSpecificBagOStuff.php.

◆ doAdd()

MediumSpecificBagOStuff::doAdd	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

abstractprotected

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 in SqlBagOStuff, MemcachedPeclBagOStuff, RESTBagOStuff, HashBagOStuff, MemcachedPhpBagOStuff, WinCacheBagOStuff, APCUBagOStuff, EmptyBagOStuff, and RedisBagOStuff.

◆ doCas()

MediumSpecificBagOStuff::doCas	(	$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

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, and WinCacheBagOStuff.

Definition at line 366 of file MediumSpecificBagOStuff.php.

References $success.

◆ doChangeTTL()

MediumSpecificBagOStuff::doChangeTTL	(	$key,
		$exptime,
		$flags
	)

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented in SqlBagOStuff, RedisBagOStuff, MemcachedPeclBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 428 of file MediumSpecificBagOStuff.php.

References $blob.

◆ doDelete()

MediumSpecificBagOStuff::doDelete	(	$key,
		$flags = `0`
	)

abstractprotected

Delete an item.

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::WRITE_* constants

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

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, RESTBagOStuff, RedisBagOStuff, HashBagOStuff, WinCacheBagOStuff, APCUBagOStuff, MemcachedPhpBagOStuff, and EmptyBagOStuff.

Referenced by delete().

◆ doDeleteMulti()

MediumSpecificBagOStuff::doDeleteMulti	(	array	$keys,
			$flags = `0`
	)

protected

Parameters

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

Returns: bool Success

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, and RedisBagOStuff.

Definition at line 655 of file MediumSpecificBagOStuff.php.

References $keys, and $res.

◆ doGet()

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

abstractprotected

Parameters

string	$key
int	$flags	Bitfield of BagOStuff::READ_* constants [optional]
mixed \| null	&$casToken	cas() token if MediumSpecificBagOStuff::PASS_BY_REF [returned]

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

Reimplemented in SqlBagOStuff, MemcachedPeclBagOStuff, RESTBagOStuff, RedisBagOStuff, HashBagOStuff, APCUBagOStuff, MemcachedPhpBagOStuff, EmptyBagOStuff, and WinCacheBagOStuff.

Referenced by delete(), and get().

◆ doGetMulti()

MediumSpecificBagOStuff::doGetMulti	(	array	$keys,
			$flags = `0`
	)

protected

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 Map of (key => value) for existing keys

Reimplemented in MemcachedPeclBagOStuff, SqlBagOStuff, RedisBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 586 of file MediumSpecificBagOStuff.php.

References $keys, and $res.

◆ doSet()

MediumSpecificBagOStuff::doSet	(	$key,
		$value,
		$exptime = `0`,
		$flags = `0`
	)

abstractprotected

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, RedisBagOStuff, HashBagOStuff, APCUBagOStuff, WinCacheBagOStuff, MemcachedPhpBagOStuff, and EmptyBagOStuff.

Referenced by set().

◆ doSetMulti()

MediumSpecificBagOStuff::doSetMulti	(	array	$data,
			$exptime = `0`,
			$flags = `0`
	)

protected

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

Returns: bool Success

Reimplemented in MemcachedPeclBagOStuff, SqlBagOStuff, and RedisBagOStuff.

Definition at line 623 of file MediumSpecificBagOStuff.php.

References $res.

◆ get()

MediumSpecificBagOStuff::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 115 of file MediumSpecificBagOStuff.php.

References doGet(), resolveSegments(), and trackDuplicateKeys().

◆ getExpirationAsTimestamp()

MediumSpecificBagOStuff::getExpirationAsTimestamp ( $exptime )

finalprotected

Convert an optionally relative timestamp to an absolute time.

The input value will be cast to an integer and interpreted as follows:

zero: no expiry; return zero (e.g. TTL_INDEFINITE)
negative: relative TTL; return UNIX timestamp offset by this value
positive (< 10 years): relative TTL; return UNIX timestamp offset by this value
positive (>= 10 years): absolute UNIX timestamp; return this value

Parameters

int $exptime

Returns: int Expiration timestamp or TTL_INDEFINITE for indefinite

Since: 1.34

Definition at line 841 of file MediumSpecificBagOStuff.php.

Referenced by RedisBagOStuff\changeTTLMulti(), SqlBagOStuff\doCas(), RedisBagOStuff\doChangeTTL(), HashBagOStuff\doSet(), and SqlBagOStuff\modifyMulti().

◆ getExpirationAsTTL()

MediumSpecificBagOStuff::getExpirationAsTTL ( $exptime )

finalprotected

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.

The input value will be cast to an integer and interpreted as follows:

zero: no expiry; return zero (e.g. TTL_INDEFINITE)
negative: relative TTL; return a short expiry time (1 second)
positive (< 10 years): relative TTL; return this value
positive (>= 10 years): absolute UNIX timestamp; return offset to current time

Parameters

int $exptime

Returns: int Relative TTL or TTL_INDEFINITE for indefinite

Since: 1.34

Definition at line 865 of file MediumSpecificBagOStuff.php.

Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doAdd(), RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doSet(), and RedisBagOStuff\doSetMulti().

◆ getLastError()

MediumSpecificBagOStuff::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 741 of file MediumSpecificBagOStuff.php.

◆ getMulti()

MediumSpecificBagOStuff::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; can be a map of (unused => key) for convenience
int	$flags	Bitfield; supports READ_LATEST [optional]

Returns: mixed[] Map of (key => value) for existing keys; preserves the order of $keys

Reimplemented from BagOStuff.

Definition at line 562 of file MediumSpecificBagOStuff.php.

References $keys, and $res.

◆ getQoS()

MediumSpecificBagOStuff::getQoS ( $flag )

Parameters

int $flag ATTR_* class constant

Returns: int QOS_* class constant

Since: 1.28

Reimplemented from BagOStuff.

Definition at line 930 of file MediumSpecificBagOStuff.php.

◆ getSegmentationSize()

MediumSpecificBagOStuff::getSegmentationSize ( )

Returns: int|float The chunk size, in bytes, of segmented objects (INF for no limit)

Since: 1.34

Reimplemented from BagOStuff.

Definition at line 934 of file MediumSpecificBagOStuff.php.

◆ getSegmentedValueMaxSize()

MediumSpecificBagOStuff::getSegmentedValueMaxSize ( )

Returns: int|float Maximum total segmented object size in bytes (INF for no limit)

Since: 1.34

Reimplemented from BagOStuff.

Definition at line 938 of file MediumSpecificBagOStuff.php.

◆ getSerialized()

MediumSpecificBagOStuff::getSerialized	(	$value,
		$key
	)

protected

Get the serialized form a value, using any applicable prepared value.

See also: BagOStuff::setNewPreparedValues()

Parameters

mixed	$value
string	$key

Returns: string|int String/integer representation

Since: 1.35

Definition at line 971 of file MediumSpecificBagOStuff.php.

References serialize().

Referenced by APCUBagOStuff\doAdd(), WinCacheBagOStuff\doAdd(), RedisBagOStuff\doAdd(), WinCacheBagOStuff\doSet(), APCUBagOStuff\doSet(), RedisBagOStuff\doSet(), and RedisBagOStuff\doSetMulti().

◆ guessSerialValueSize()

MediumSpecificBagOStuff::guessSerialValueSize	(		$value,
			$depth = `0`,
		&	$loops = `0`
	)

protected

Estimate the size of a variable once serialized.

Parameters

mixed	$value
int	$depth	Current stack depth
int	&$loops	Number of iterable nodes visited

Returns: int|null Size in bytes; null for unsupported variable types

Since: 1.35

Definition at line 999 of file MediumSpecificBagOStuff.php.

Referenced by HashBagOStuff\setNewPreparedValues(), and MemcachedPeclBagOStuff\setNewPreparedValues().

◆ incrWithInit()

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

Reimplemented in APCUBagOStuff, and EmptyBagOStuff.

Definition at line 683 of file MediumSpecificBagOStuff.php.

◆ isInteger()

MediumSpecificBagOStuff::isInteger ( $value )

finalprotected

Check if a value is an integer.

Parameters

mixed $value

Returns: bool

Definition at line 881 of file MediumSpecificBagOStuff.php.

Referenced by HashBagOStuff\incr(), WinCacheBagOStuff\incr(), RESTBagOStuff\incr(), SqlBagOStuff\incr(), MemcachedPhpBagOStuff\unserialize(), MemcachedPeclBagOStuff\unserialize(), and SqlBagOStuff\unserialize().

◆ isRelativeExpiration()

MediumSpecificBagOStuff::isRelativeExpiration ( $exptime )

finalprotected

Parameters

int | float $exptime

Returns: bool Whether the expiry is non-infinite, and, negative or not a UNIX timestamp

Since: 1.34

Definition at line 824 of file MediumSpecificBagOStuff.php.

Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doChangeTTL(), and MemcachedBagOStuff\fixExpiry().

◆ lock()

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

Reimplemented in SqlBagOStuff.

Definition at line 464 of file MediumSpecificBagOStuff.php.

◆ makeGlobalKey()

MediumSpecificBagOStuff::makeGlobalKey	(	$class,
		$components
	)

Make a global cache key.

Parameters

string	$class	Key class
	string\|int	...$components Key components (starting with a key collection name)

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

Since: 1.27

Reimplemented from BagOStuff.

Definition at line 909 of file MediumSpecificBagOStuff.php.

Referenced by delete().

◆ makeKey()

MediumSpecificBagOStuff::makeKey	(	$class,
		$components
	)

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

Parameters

string	$class	Key class
	string\|int	...$components Key components (starting with a key collection name)

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

Since: 1.27

Reimplemented from BagOStuff.

Definition at line 921 of file MediumSpecificBagOStuff.php.

◆ makeKeyInternal()

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

Reimplemented in SqlBagOStuff, WinCacheBagOStuff, and MemcachedBagOStuff.

Definition at line 893 of file MediumSpecificBagOStuff.php.

References $args.

◆ makeValueOrSegmentList()

MediumSpecificBagOStuff::makeValueOrSegmentList	(	$key,
		$value,
		$exptime,
		$flags
	)

finalprotected

Determine the entry (inline or segment list) to store under a key to save the value.

Parameters

string	$key
mixed	$value
int	$exptime
int	$flags

Returns: array (inline value or segment list, whether the entry is usable)

Since: 1.34

Definition at line 776 of file MediumSpecificBagOStuff.php.

References $serialized, SerializedValueContainer\newSegmented(), and SerializedValueContainer\newUnified().

Referenced by set().

◆ merge()

MediumSpecificBagOStuff::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

Reimplemented from BagOStuff.

Reimplemented in EmptyBagOStuff.

Definition at line 265 of file MediumSpecificBagOStuff.php.

◆ mergeViaCas()

MediumSpecificBagOStuff::mergeViaCas	(		$key,
		callable	$callback,
			$exptime,
			$attempts,
			$flags
	)

finalprotected

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

See also: BagOStuff::merge()

Definition at line 278 of file MediumSpecificBagOStuff.php.

References $success.

◆ resolveSegments()

MediumSpecificBagOStuff::resolveSegments	(	$key,
		$mainValue
	)

finalprotected

Get and reassemble the chunks of blob at the given key.

Parameters

string	$key
mixed	$mainValue

Returns: string|null|bool The combined string, false if missing, null on error

Definition at line 706 of file MediumSpecificBagOStuff.php.

References SerializedValueContainer\isUnified(), SerializedValueContainer\UNIFIED_DATA, and unserialize().

Referenced by get().

◆ serialize()

MediumSpecificBagOStuff::serialize ( $value )

protected

Parameters

mixed $value

Returns: string|int String/integer representation

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 1048 of file MediumSpecificBagOStuff.php.

References serialize().

Referenced by RESTBagOStuff\encodeBody().

◆ set()

MediumSpecificBagOStuff::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 171 of file MediumSpecificBagOStuff.php.

References doSet(), and makeValueOrSegmentList().

◆ setLastError()

MediumSpecificBagOStuff::setLastError ( $err )

protected

Set the "last error" registry.

Parameters

int $err ERR_* constant

Since: 1.23

Definition at line 758 of file MediumSpecificBagOStuff.php.

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

◆ setMulti()

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

Batch insertion/replace.

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

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 609 of file MediumSpecificBagOStuff.php.

◆ setNewPreparedValues()

MediumSpecificBagOStuff::setNewPreparedValues ( array $valueByKey )

Prepare values for storage and get their serialized sizes, or, estimate those sizes.

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.

Reimplemented in MemcachedPeclBagOStuff, and HashBagOStuff.

Definition at line 942 of file MediumSpecificBagOStuff.php.

References $serialized, and serialize().

◆ trackDuplicateKeys()

MediumSpecificBagOStuff::trackDuplicateKeys ( $key )

private

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

Parameters

string $key

Definition at line 125 of file MediumSpecificBagOStuff.php.

Referenced by get().

◆ unlock()

MediumSpecificBagOStuff::unlock ( $key )

Release an advisory lock on a key string.

Parameters

string $key

Returns: bool Success

Reimplemented from BagOStuff.

Reimplemented in SqlBagOStuff.

Definition at line 516 of file MediumSpecificBagOStuff.php.

◆ unserialize()

MediumSpecificBagOStuff::unserialize ( $value )

protected

Parameters

string | int $value

Returns: mixed Original value or false on error

Note: Special handling is usually needed for integers so incr()/decr() work

Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, and SqlBagOStuff.

Definition at line 1057 of file MediumSpecificBagOStuff.php.

References unserialize().

Referenced by RESTBagOStuff\decodeBody(), WinCacheBagOStuff\doGet(), APCUBagOStuff\doGet(), RedisBagOStuff\doGet(), and RedisBagOStuff\doGetMulti().

Member Data Documentation

◆ $busyCallbacks

callable [] MediumSpecificBagOStuff::$busyCallbacks = []

protected

Definition at line 56 of file MediumSpecificBagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

◆ $dupeTrackScheduled

bool MediumSpecificBagOStuff::$dupeTrackScheduled = false

private

Definition at line 53 of file MediumSpecificBagOStuff.php.

◆ $duplicateKeyLookups

array MediumSpecificBagOStuff::$duplicateKeyLookups = []

private

Definition at line 49 of file MediumSpecificBagOStuff.php.

◆ $keyspace

string MediumSpecificBagOStuff::$keyspace = 'local'

protected

Definition at line 40 of file MediumSpecificBagOStuff.php.

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

◆ $lastError

int MediumSpecificBagOStuff::$lastError = self::ERR_NONE

protected

ERR_* class constant.

Definition at line 38 of file MediumSpecificBagOStuff.php.

◆ $locks

array [] MediumSpecificBagOStuff::$locks = []

protected

Lock tracking.

Definition at line 36 of file MediumSpecificBagOStuff.php.

◆ $preparedValues

array [] MediumSpecificBagOStuff::$preparedValues = []

protected

Map of (key => (PHP variable value, serialized value))

Definition at line 59 of file MediumSpecificBagOStuff.php.

◆ $reportDupes

bool MediumSpecificBagOStuff::$reportDupes = false

private

Definition at line 51 of file MediumSpecificBagOStuff.php.

◆ $segmentationSize

int MediumSpecificBagOStuff::$segmentationSize

protected

Bytes; chunk size of segmented cache values.

Definition at line 44 of file MediumSpecificBagOStuff.php.

◆ $segmentedValueMaxSize

int MediumSpecificBagOStuff::$segmentedValueMaxSize

protected

Bytes; maximum total size of a segmented cache value.

Definition at line 46 of file MediumSpecificBagOStuff.php.

◆ $syncTimeout

int MediumSpecificBagOStuff::$syncTimeout

protected

Seconds.

Definition at line 42 of file MediumSpecificBagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

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

includes/libs/objectcache/MediumSpecificBagOStuff.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ addBusyCallback()

◆ cas()

◆ changeTTL()

◆ changeTTLMulti()

◆ clearLastError()

◆ debug()

◆ delete()

◆ deleteMulti()

◆ deleteObjectsExpiringBefore()

◆ doAdd()

◆ doCas()

◆ doChangeTTL()

◆ doDelete()

◆ doDeleteMulti()

◆ doGet()

◆ doGetMulti()

◆ doSet()

◆ doSetMulti()

◆ get()

◆ getExpirationAsTimestamp()

◆ getExpirationAsTTL()

◆ getLastError()

◆ getMulti()

◆ getQoS()

◆ getSegmentationSize()

◆ getSegmentedValueMaxSize()

◆ getSerialized()

◆ guessSerialValueSize()

◆ incrWithInit()

◆ isInteger()

◆ isRelativeExpiration()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ makeValueOrSegmentList()

◆ merge()

◆ mergeViaCas()

◆ resolveSegments()

◆ serialize()

◆ set()

◆ setLastError()

◆ setMulti()

◆ setNewPreparedValues()

◆ trackDuplicateKeys()

◆ unlock()

◆ unserialize()

Member Data Documentation

◆ $busyCallbacks

◆ $dupeTrackScheduled

◆ $duplicateKeyLookups

◆ $keyspace

◆ $lastError

◆ $locks

◆ $preparedValues

◆ $reportDupes

◆ $segmentationSize

◆ $segmentedValueMaxSize

◆ $syncTimeout