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.

	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.

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

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

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

	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.

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

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

	makeKey ( $class,... $components)
	Make a cache key, scoped to this instance's keyspace.

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

	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.

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

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

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

	getCurrentTime ()

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

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

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

	setDebug ( $enabled)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

	debug ( $text)

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

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

	doChangeTTL ( $key, $exptime, $flags)

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

	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.

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

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

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

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

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

	isRelativeExpiration ( $exptime)

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

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

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

	serialize ( $value)

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

	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.

Protected Attributes
callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

array[]	$locks = []
	Lock tracking.

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

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

int	$syncTimeout
	Seconds.

Protected Attributes inherited from BagOStuff
callable null	$asyncHandler

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

bool	$debugMode = false

LoggerInterface	$logger

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

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.

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 IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	QOS_EMULATION_SQL = 1

const	QOS_SYNCWRITES_BE = 2

const	QOS_SYNCWRITES_NONE = 1

const	QOS_SYNCWRITES_QC = 3

const	QOS_SYNCWRITES_SS = 4

const	QOS_UNKNOWN = INF

const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_PROC_LONG = 30

const	TTL_PROC_SHORT = 3

const	TTL_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Detailed Description

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 MemcachedBagOStuff, APCBagOStuff, APCUBagOStuff, and WinCacheBagOStuff.

Definition at line 80 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 226 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 756 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 335 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 412 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 RedisBagOStuff, and SqlBagOStuff.

Definition at line 668 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 743 of file MediumSpecificBagOStuff.php.

◆ debug()

MediumSpecificBagOStuff::debug ( $text )

protected

Parameters

string $text

Definition at line 957 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 193 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 636 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 542 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 RedisBagOStuff, APCBagOStuff, APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.

◆ 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 MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.

Definition at line 360 of file MediumSpecificBagOStuff.php.

References $success.

◆ doChangeTTL()

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

protected

Parameters

string	$key
int	$exptime
int	$flags

Returns: bool

Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, and SqlBagOStuff.

Definition at line 422 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 APCBagOStuff, APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.

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 MemcachedPeclBagOStuff, RedisBagOStuff, and SqlBagOStuff.

Definition at line 649 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	Token to use for check-and-set comparisons

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

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

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, MemcachedPhpBagOStuff, RedisBagOStuff, and SqlBagOStuff.

Definition at line 580 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 APCBagOStuff, APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.

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, RedisBagOStuff, and SqlBagOStuff.

Definition at line 617 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 109 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 835 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 859 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 735 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 556 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 924 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 928 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 932 of file MediumSpecificBagOStuff.php.

◆ 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 $ttl instead if not present. Callers should make sure that both ($init - $value) and $ttl 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 EmptyBagOStuff.

Definition at line 677 of file MediumSpecificBagOStuff.php.

◆ isInteger()

MediumSpecificBagOStuff::isInteger ( $value )

finalprotected

Check if a value is an integer.

Parameters

mixed $value

Returns: bool

Definition at line 875 of file MediumSpecificBagOStuff.php.

Referenced by SqlBagOStuff\incr(), HashBagOStuff\incr(), RESTBagOStuff\incr(), WinCacheBagOStuff\incr(), SqlBagOStuff\unserialize(), MemcachedPeclBagOStuff\unserialize(), and MemcachedPhpBagOStuff\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 818 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 458 of file MediumSpecificBagOStuff.php.

◆ makeGlobalKey()

MediumSpecificBagOStuff::makeGlobalKey	(		$class,
			$components )

Make a global cache key.

Parameters

string	$class	Key class
	string	...$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 903 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	...$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 915 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 MemcachedBagOStuff, and WinCacheBagOStuff.

Definition at line 887 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 770 of file MediumSpecificBagOStuff.php.

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

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 259 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 272 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 700 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 SqlBagOStuff, MemcachedPeclBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 941 of file MediumSpecificBagOStuff.php.

References serialize().

◆ 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 165 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 752 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 603 of file MediumSpecificBagOStuff.php.

◆ trackDuplicateKeys()

MediumSpecificBagOStuff::trackDuplicateKeys ( $key )

private

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

Parameters

string $key

Definition at line 119 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 510 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 SqlBagOStuff, MemcachedPeclBagOStuff, and MemcachedPhpBagOStuff.

Definition at line 950 of file MediumSpecificBagOStuff.php.

References unserialize().

Referenced by RESTBagOStuff\decodeBody(), APCBagOStuff\doGet(), APCUBagOStuff\doGet(), RedisBagOStuff\doGet(), WinCacheBagOStuff\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(), and WinCacheBagOStuff\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.

◆ $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()

◆ incrWithInit()

◆ isInteger()

◆ isRelativeExpiration()

◆ lock()

◆ makeGlobalKey()

◆ makeKey()

◆ makeKeyInternal()

◆ makeValueOrSegmentList()

◆ merge()

◆ mergeViaCas()

◆ resolveSegments()

◆ serialize()

◆ set()

◆ setLastError()

◆ setMulti()

◆ trackDuplicateKeys()

◆ unlock()

◆ unserialize()

Member Data Documentation

◆ $busyCallbacks

◆ $dupeTrackScheduled

◆ $duplicateKeyLookups

◆ $keyspace

◆ $lastError

◆ $locks

◆ $reportDupes

◆ $segmentationSize

◆ $segmentedValueMaxSize

◆ $syncTimeout