MediaWiki  master
BagOStuff Class Reference

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

Inheritance diagram for BagOStuff:
Collaboration diagram for BagOStuff:

Public Member Functions

 __construct (array $params=[])
 Parameters include: More...
 
 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...
 
 decr ( $key, $value=1, $flags=0)
 Decrease stored value of $key by $value while preserving its TTL. 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...
 
 getCurrentTime ()
 
 getLastError ()
 Get the "last error" registered; clearLastError() should be called manually. More...
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 getQoS ( $flag)
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getSegmentationSize ()
 
 getSegmentedValueMaxSize ()
 
 getWithSetCallback ( $key, $ttl, $callback, $flags=0)
 Get an item with the given key, regenerating and setting it if not found. More...
 
 incr ( $key, $value=1, $flags=0)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 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...
 
 setDebug ( $enabled)
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0, $flags=0)
 Batch insertion/replace. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 

Public Attributes

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

Protected Member Functions

 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 null $asyncHandler
 
int[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
bool $debugMode = false
 
LoggerInterface $logger
 

Private Attributes

float null $wallClockOverride
 

Detailed Description

Class representing a cache/ephemeral data store.

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

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

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

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

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

Subclasses should override the default "segmentationSize" field with an appropriate value. The value should not be larger than what the storage backend (by default) supports. It also should be roughly informed by common performance bottlenecks (e.g. values over a certain size having poor scalability). The same goes for the "segmentedValueMaxSize" member, which limits the maximum size and chunk count (indirectly) of values.

Definition at line 63 of file BagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters include:

  • logger: Psr\Log\LoggerInterface instance
  • asyncHandler: Callable to use for scheduling tasks after the web request ends. In CLI mode, it should run the task immediately.
    Parameters
    array$params-param array{logger?:Psr\Log\LoggerInterface,asyncHandler?:callable} $params

Reimplemented in MediumSpecificBagOStuff, APCUBagOStuff, APCBagOStuff, WinCacheBagOStuff, and MemcachedBagOStuff.

Definition at line 96 of file BagOStuff.php.

References setLogger().

Member Function Documentation

◆ add()

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

Insert an item if it does not already exist.

Parameters
string$key
mixed$value
int$exptime
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

◆ addBusyCallback()

BagOStuff::addBusyCallback ( callable  $workCallback)
abstract

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 in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

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

◆ changeTTL()

BagOStuff::changeTTL (   $key,
  $exptime = 0,
  $flags = 0 
)
abstract

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$exptimeTTL or UNIX timestamp
int$flagsBitfield 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 in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

◆ changeTTLMulti()

BagOStuff::changeTTLMulti ( array  $keys,
  $exptime,
  $flags = 0 
)
abstract

Change the expiration of multiple keys that exist.

See also
BagOStuff::changeTTL()
Parameters
string[]$keysList of keys
int$exptimeTTL or UNIX timestamp
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success
Since
1.34

Reimplemented in MediumSpecificBagOStuff, SqlBagOStuff, RedisBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

◆ clearLastError()

BagOStuff::clearLastError ( )
abstract

Clear the "last error" registry.

Since
1.23

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

◆ decr()

BagOStuff::decr (   $key,
  $value = 1,
  $flags = 0 
)
abstract

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

Parameters
string$key
int$valueValue to subtract from $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure

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

◆ delete()

BagOStuff::delete (   $key,
  $flags = 0 
)
abstract

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$flagsBitfield of BagOStuff::WRITE_* constants

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

◆ deleteMulti()

BagOStuff::deleteMulti ( array  $keys,
  $flags = 0 
)
abstract

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[]$keysList of keys
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Since
1.33

Reimplemented in MediumSpecificBagOStuff, CachedBagOStuff, ReplicatedBagOStuff, and MultiWriteBagOStuff.

◆ deleteObjectsExpiringBefore()

BagOStuff::deleteObjectsExpiringBefore (   $timestamp,
callable  $progress = null,
  $limit = INF 
)
abstract

Delete all objects expiring before a certain date.

Parameters
string | int$timestampThe reference date in MW or TS_UNIX format
callable | null$progressOptional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional]
int$limitMaximum number of keys to delete [default: INF]
Returns
bool Success; false if unimplemented

Reimplemented in SqlBagOStuff, MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

◆ fieldHasFlags()

◆ get()

BagOStuff::get (   $key,
  $flags = 0 
)
abstract

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$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure or if the item does not exist

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Referenced by McTest\execute(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ getCurrentTime()

◆ getLastError()

BagOStuff::getLastError ( )
abstract

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

Returns
int ERR_* constant for the "last error" registry
Since
1.23

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

◆ getMulti()

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

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

Parameters
string[]$keysList of keys
int$flagsBitfield; supports READ_LATEST [optional]
Returns
mixed[] Map of (key => value) for existing keys

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

◆ getQoS()

BagOStuff::getQoS (   $flag)
Parameters
int$flagATTR_* class constant
Returns
int QOS_* class constant
Since
1.28

Reimplemented in MediumSpecificBagOStuff.

Definition at line 467 of file BagOStuff.php.

References IExpiringStore\QOS_UNKNOWN.

Referenced by MWLBFactory\injectObjectCaches(), and Wikimedia\Rdbms\ChronologyProtector\shutdown().

◆ getScopedLock()

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

Get a lightweight exclusive self-unlocking lock.

Note that the same lock cannot be acquired twice.

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

Parameters
string$key
int$timeoutLock wait timeout; 0 for non-blocking [optional]
int$expiryLock expiry [optional]; 1 day maximum
string$rclassAllow reentry if set and the current lock used this value
Returns
ScopedCallback|null Returns null on failure
Since
1.26

Definition at line 273 of file BagOStuff.php.

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

◆ getSegmentationSize()

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

Reimplemented in MediumSpecificBagOStuff.

Definition at line 475 of file BagOStuff.php.

◆ getSegmentedValueMaxSize()

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

Reimplemented in MediumSpecificBagOStuff.

Definition at line 483 of file BagOStuff.php.

◆ getWithSetCallback()

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

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

The callback can take $ttl as argument by reference and modify it. Nothing is stored nor deleted if the callback returns false.

Parameters
string$key
int$ttlTime-to-live (seconds)
callable$callbackCallback that derives the new value
int$flagsBitfield of BagOStuff::READ_* or BagOStuff::WRITE_* constants [optional]
Returns
mixed The cached value if found or the result of $callback otherwise
Since
1.27

Definition at line 129 of file BagOStuff.php.

◆ incr()

BagOStuff::incr (   $key,
  $value = 1,
  $flags = 0 
)
abstract

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

Parameters
string$keyKey to increase
int$valueValue to add to $key (default: 1) [optional]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure

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

◆ incrWithInit()

BagOStuff::incrWithInit (   $key,
  $exptime,
  $value = 1,
  $init = null,
  $flags = 0 
)
abstract

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$keyKey built via makeKey() or makeGlobalKey()
int$exptimeTime-to-live (in seconds) or a UNIX timestamp expiration
int$valueAmount to increase the key value by [default: 1]
int | null$initValue to initialize the key to if it does not exist [default: $value]
int$flagsBit field of class WRITE_* constants [optional]
Returns
int|bool New value or false on failure
Since
1.24

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, ReplicatedBagOStuff, APCUBagOStuff, and EmptyBagOStuff.

◆ lock()

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

Acquire an advisory lock on a key string.

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

Parameters
string$key
int$timeoutLock wait timeout; 0 for non-blocking [optional]
int$expiryLock expiry [optional]; 1 day maximum
string$rclassAllow reentry if set and the current lock used this value
Returns
bool Success

Reimplemented in SqlBagOStuff, MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

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

◆ makeGlobalKey()

BagOStuff::makeGlobalKey (   $class,
  $components 
)
abstract

Make a global cache key.

Since
1.27
Parameters
string$classKey class
string|int...$components Key components (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components

Implements IStoreKeyEncoder.

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

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

◆ makeKey()

BagOStuff::makeKey (   $class,
  $components 
)
abstract

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

Since
1.27
Parameters
string$classKey class
string|int...$components Key components (starting with a key collection name)
Returns
string Colon-delimited list of $keyspace followed by escaped components

Implements IStoreKeyEncoder.

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

Referenced by CryptHKDF\__construct().

◆ makeKeyInternal()

BagOStuff::makeKeyInternal (   $keyspace,
  $args 
)
abstract

Construct a cache key.

Since
1.27
Parameters
string$keyspace
array$args
Returns
string Colon-delimited list of $keyspace followed by escaped components of $args

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, CachedBagOStuff, WinCacheBagOStuff, and MemcachedBagOStuff.

◆ merge()

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

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$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Exceptions
InvalidArgumentException

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, ReplicatedBagOStuff, and EmptyBagOStuff.

◆ mergeFlagMaps()

BagOStuff::mergeFlagMaps ( array  $bags)
finalprotected

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

Parameters
BagOStuff[]$bags
Returns
int[] Resulting flag map (class ATTR_* constant => class QOS_* constant)

Definition at line 503 of file BagOStuff.php.

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

◆ set()

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

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and CachedBagOStuff.

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

◆ setDebug()

BagOStuff::setDebug (   $enabled)
Parameters
bool$enabled

Reimplemented in MultiWriteBagOStuff, ReplicatedBagOStuff, MemcachedPhpBagOStuff, and CachedBagOStuff.

Definition at line 112 of file BagOStuff.php.

◆ setLogger()

BagOStuff::setLogger ( LoggerInterface  $logger)
Parameters
LoggerInterface$logger
Returns
void

Reimplemented in RESTBagOStuff.

Definition at line 105 of file BagOStuff.php.

References $logger.

Referenced by __construct().

◆ setMockTime()

BagOStuff::setMockTime ( $time)

Reimplemented in MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

Definition at line 532 of file BagOStuff.php.

◆ setMulti()

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

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[]$dataMap of (key => value)
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants (since 1.33)
Returns
bool Success
Since
1.24

Reimplemented in MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

◆ unlock()

BagOStuff::unlock (   $key)
abstract

Release an advisory lock on a key string.

Parameters
string$key
Returns
bool Success

Reimplemented in SqlBagOStuff, MediumSpecificBagOStuff, MultiWriteBagOStuff, CachedBagOStuff, and ReplicatedBagOStuff.

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

Member Data Documentation

◆ $asyncHandler

callable null BagOStuff::$asyncHandler
protected

◆ $attrMap

int [] BagOStuff::$attrMap = []
protected

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

Definition at line 70 of file BagOStuff.php.

◆ $debugMode

bool BagOStuff::$debugMode = false
protected

Definition at line 73 of file BagOStuff.php.

◆ $logger

LoggerInterface BagOStuff::$logger
protected

Definition at line 65 of file BagOStuff.php.

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

◆ $wallClockOverride

float null BagOStuff::$wallClockOverride
private

Definition at line 76 of file BagOStuff.php.

◆ READ_LATEST

const BagOStuff::READ_LATEST = 1

Bitfield constants for get()/getMulti(); these are only advisory.

Definition at line 79 of file BagOStuff.php.

Referenced by RESTBagOStuff\incr().

◆ READ_VERIFIED

const BagOStuff::READ_VERIFIED = 2

Definition at line 80 of file BagOStuff.php.

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

◆ WRITE_ALLOW_SEGMENTS

const BagOStuff::WRITE_ALLOW_SEGMENTS = 16

◆ WRITE_BACKGROUND

const BagOStuff::WRITE_BACKGROUND = 64

Definition at line 86 of file BagOStuff.php.

◆ WRITE_CACHE_ONLY

const BagOStuff::WRITE_CACHE_ONLY = 8

Definition at line 83 of file BagOStuff.php.

Referenced by CachedBagOStuff\get(), and MediaWiki\Session\SessionBackend\save().

◆ WRITE_PRUNE_SEGMENTS

const BagOStuff::WRITE_PRUNE_SEGMENTS = 32

◆ WRITE_SYNC

const BagOStuff::WRITE_SYNC = 4

Bitfield constants for set()/merge(); these are only advisory.

Definition at line 82 of file BagOStuff.php.

Referenced by MediaWiki\Session\SessionBackend\save().


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