Simple store for keeping values in an associative array for the current process. More...

Inheritance diagram for HashBagOStuff:

[legend]

Collaboration diagram for HashBagOStuff:

[legend]

Public Member Functions
	__construct ( $params=[])

	clear ()

	delete ( $key)
	Delete an item.

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

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

	add ( $key, $value, $exptime=0)

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

	changeTTL ( $key, $expiry=0)
	Reset the TTL on a key if it exists.

	clearLastError ()
	Clear the "last error" registry.

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

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete all objects expiring before a certain date.

	get ( $key, $flags=0, $oldFlags=null)
	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)

	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)
	Increase stored value of $key by $value while preserving its TTL.

	incrWithInit ( $key, $ttl, $value=1, $init=1)
	Increase stored value of $key by $value while preserving its TTL.

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

	makeGlobalKey ( $class, $component=null)
	Make a global cache key.

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

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

	setDebug ( $bool)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

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

Public Attributes
const	KEY_EXP = 1

const	KEY_VAL = 0

Public Attributes inherited from BagOStuff
const	ERR_NO_RESPONSE = 1

const	ERR_NONE = 0
	Possible values for getLastError()

const	ERR_UNEXPECTED = 3

const	ERR_UNREACHABLE = 2

const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 2

const	WRITE_SYNC = 1
	Bitfield constants for set()/merge()

Public Attributes inherited from IExpiringStore
const	ATTR_EMULATION = 1

const	ATTR_SYNCWRITES = 2

const	QOS_EMULATION_SQL = 1

const	QOS_SYNCWRITES_BE = 2

const	QOS_SYNCWRITES_NONE = 1

const	QOS_SYNCWRITES_QC = 3

const	QOS_SYNCWRITES_SS = 4

const	QOS_UNKNOWN = INF

const	TTL_DAY = 86400

const	TTL_HOUR = 3600

const	TTL_INDEFINITE = 0

const	TTL_MINUTE = 60

const	TTL_MONTH = 2592000

const	TTL_PROC_LONG = 30

const	TTL_PROC_SHORT = 3

const	TTL_SECOND = 1

const	TTL_WEEK = 604800

const	TTL_YEAR = 31536000

Protected Member Functions
	doGet ( $key, $flags=0)

	expire ( $key)

	hasKey ( $key)
	Does this bag have a non-null value for the given key?

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

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

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

	debug ( $text)

	getCurrentTime ()

	getWithToken ( $key, &$casToken, $flags=0)

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

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

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

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

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

Protected Attributes
mixed[]	$bag = []

int	$maxCacheKeys
	Max entries allowed.

Protected Attributes inherited from BagOStuff
callback null	$asyncHandler

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

callable[]	$busyCallbacks = []

string	$keyspace = 'local'

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

array[]	$locks = []
	Lock tracking.

LoggerInterface	$logger

int	$syncTimeout
	Seconds.

Detailed Description

Simple store for keeping values in an associative array for the current process.

Data will not persist and is not shared with other processes.

Definition at line 31 of file HashBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

HashBagOStuff::__construct ( $params = [] )

Parameters

array

$params

Additional parameters include:

maxKeys : only allow this many keys (using oldest-first eviction)

Definition at line 44 of file HashBagOStuff.php.

References $params.

Member Function Documentation

◆ clear()

HashBagOStuff::clear ( )

Definition at line 115 of file HashBagOStuff.php.

Referenced by Title\clearCaches().

◆ delete()

HashBagOStuff::delete ( $key )

Delete an item.

Parameters

string $key

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

Reimplemented from BagOStuff.

Definition at line 109 of file HashBagOStuff.php.

◆ doGet()

HashBagOStuff::doGet	(		$key,
			$flags = 0 )

protected

Parameters

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

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

Reimplemented from BagOStuff.

Reimplemented in CachedBagOStuff.

Definition at line 75 of file HashBagOStuff.php.

References expire(), and hasKey().

◆ expire()

HashBagOStuff::expire ( $key )

protected

Definition at line 53 of file HashBagOStuff.php.

References BagOStuff\getCurrentTime().

Referenced by doGet().

◆ hasKey()

HashBagOStuff::hasKey ( $key )

protected

Does this bag have a non-null value for the given key?

Parameters

string $key

Returns: bool

Since: 1.27

Definition at line 71 of file HashBagOStuff.php.

Referenced by CachedBagOStuff\doGet(), and doGet().

◆ set()

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

Reimplemented in CachedBagOStuff.

Definition at line 92 of file HashBagOStuff.php.

References $value, BagOStuff\convertExpiry(), and key.

Referenced by Title\newFromTextThrow().

Member Data Documentation

◆ $bag

mixed [] HashBagOStuff::$bag = []

protected

Definition at line 33 of file HashBagOStuff.php.

◆ $maxCacheKeys

int HashBagOStuff::$maxCacheKeys

protected

Max entries allowed.

Definition at line 35 of file HashBagOStuff.php.

◆ KEY_EXP

const HashBagOStuff::KEY_EXP = 1

Definition at line 38 of file HashBagOStuff.php.

◆ KEY_VAL

const HashBagOStuff::KEY_VAL = 0

Definition at line 37 of file HashBagOStuff.php.

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

includes/libs/objectcache/HashBagOStuff.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clear()

◆ delete()

◆ doGet()

◆ expire()

◆ hasKey()

◆ set()

Member Data Documentation

◆ $bag

◆ $maxCacheKeys

◆ KEY_EXP

◆ KEY_VAL