BagOStuff with utility functions for MediaWiki\\Session\\* testing. More...

Inheritance diagram for MediaWiki\Session\TestBagOStuff:

[legend]

Collaboration diagram for MediaWiki\Session\TestBagOStuff:

[legend]

Public Member Functions
	__construct ()

	deleteSession ( $id)

	getSession ( $id)

	getSessionFromBackend ( $id)

	setRawSession ( $id, $blob)

	setSession ( $id, array $blob)

	setSessionData ( $id, array $data)

	setSessionMeta ( $id, array $metadata)

Public Member Functions inherited from CachedBagOStuff
	__construct (BagOStuff $backend, $params=[])

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

	clearLastError ()
	Clear the "last error" registry.

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

	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	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.

	incr ( $key, $value=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.

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

	setDebug ( $bool)

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

Public Member Functions inherited from HashBagOStuff
	__construct ( $params=[])

	clear ()
	Clear all values in cache.

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

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

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

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

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

	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.

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

	merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
	Merge changes into the existing cache value (possibly creating a new one)

	setLogger (LoggerInterface $logger)

	setMockTime (&$time)

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

Additional Inherited Members
Public Attributes inherited from HashBagOStuff
const	KEY_CAS = 2

const	KEY_EXP = 1

const	KEY_VAL = 0

Public Attributes inherited from BagOStuff
const	READ_LATEST = 1
	Bitfield constants for get()/getMulti()

const	READ_VERIFIED = 2

const	WRITE_CACHE_ONLY = 8

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

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 inherited from HashBagOStuff
	doGet ( $key, $flags=0, &$casToken=null)

	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, $flags=0)
	Check and set an item.

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

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

	debug ( $text)

	expiryIsRelative ( $exptime)

	getCurrentTime ()

	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, $flags=0)

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

Protected Attributes inherited from CachedBagOStuff
BagOStuff	$backend

Protected Attributes inherited from HashBagOStuff
mixed[]	$bag = []

int	$maxCacheKeys
	Max entries allowed.

Protected Attributes inherited from BagOStuff
callable 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

BagOStuff with utility functions for MediaWiki\\Session\\* testing.

Definition at line 8 of file TestBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Session\TestBagOStuff::__construct ( )

Definition at line 10 of file TestBagOStuff.php.

Member Function Documentation

◆ deleteSession()

MediaWiki\Session\TestBagOStuff::deleteSession ( $id )

Parameters

string $id Session ID

Definition at line 77 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

◆ getSession()

MediaWiki\Session\TestBagOStuff::getSession ( $id )

Parameters

string $id Session ID

Returns: mixed

Definition at line 62 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

◆ getSessionFromBackend()

MediaWiki\Session\TestBagOStuff::getSessionFromBackend ( $id )

Parameters

string $id Session ID

Returns: mixed

Definition at line 70 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

◆ setRawSession()

MediaWiki\Session\TestBagOStuff::setRawSession	(		$id,
			$blob )

Parameters

string	$id	Session ID
array \| mixed	$blob	Session metadata and data

Definition at line 53 of file TestBagOStuff.php.

References $blob, and CachedBagOStuff\makeKey().

Referenced by MediaWiki\Session\TestBagOStuff\setSession().

◆ setSession()

MediaWiki\Session\TestBagOStuff::setSession	(		$id,
		array	$blob )

Parameters

string	$id	Session ID
array	$blob	Session metadata and data

Definition at line 34 of file TestBagOStuff.php.

References $blob, and MediaWiki\Session\TestBagOStuff\setRawSession().

Referenced by MediaWiki\Session\TestBagOStuff\setSessionData(), and MediaWiki\Session\TestBagOStuff\setSessionMeta().

◆ setSessionData()

MediaWiki\Session\TestBagOStuff::setSessionData	(		$id,
		array	$data )

Parameters

string	$id	Session ID
array	$data	Session data

Definition at line 18 of file TestBagOStuff.php.

References $data, and MediaWiki\Session\TestBagOStuff\setSession().

◆ setSessionMeta()

MediaWiki\Session\TestBagOStuff::setSessionMeta	(		$id,
		array	$metadata )

Parameters

string	$id	Session ID
array	$metadata	Session metadata

Definition at line 26 of file TestBagOStuff.php.

References MediaWiki\Session\TestBagOStuff\setSession().

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

tests/phpunit/includes/session/TestBagOStuff.php

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteSession()

◆ getSession()

◆ getSessionFromBackend()

◆ setRawSession()

◆ setSession()

◆ setSessionData()

◆ setSessionMeta()