MediaWiki  master
MediaWiki\Session\TestBagOStuff Class Reference

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

Inheritance diagram for MediaWiki\Session\TestBagOStuff:
Collaboration diagram for MediaWiki\Session\TestBagOStuff:

Public Member Functions

 __construct ()
 
 deleteSession ($id)
 
 getSession ($id)
 
 getSessionFromBackend ($id)
 
 setRawSession ($id, $blob, $expiry=0)
 
 setSession ($id, array $blob, $expiry=0, User $user=null)
 
 setSessionData ($id, array $data, $expiry=0, User $user=null)
 
 setSessionMeta ($id, array $metadata, $expiry=0)
 
- Public Member Functions inherited from CachedBagOStuff
 __construct (BagOStuff $backend, $params=[])
 
 clearLastError ()
 
 delete ($key, $flags=0)
 
 deleteObjectsExpiringBefore ($date, $progressCallback=false)
 
 getLastError ()
 
 lock ($key, $timeout=6, $expiry=6, $rclass= '')
 
 makeGlobalKey ()
 
 makeKey ()
 
 modifySimpleRelayEvent (array $event)
 
 set ($key, $value, $exptime=0, $flags=0)
 
 setDebug ($bool)
 
 unlock ($key)
 
- Public Member Functions inherited from HashBagOStuff
 __construct ($params=[])
 
 clear ()
 
 delete ($key)
 
 set ($key, $value, $exptime=0, $flags=0)
 
- Public Member Functions inherited from BagOStuff
 __construct (array $params=[])
 $params include: More...
 
 add ($key, $value, $exptime=0)
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ($key, $expiry=0)
 Reset the TTL on a key if it exists. More...
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 decr ($key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 delete ($key)
 Delete an item. More...
 
 deleteObjectsExpiringBefore ($date, $progressCallback=false)
 Delete all objects expiring before a certain date. More...
 
 get ($key, $flags=0, $oldFlags=null)
 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)
 
 getScopedLock ($key, $timeout=6, $expiry=30, $rclass= '')
 Get a lightweight exclusive self-unlocking lock. More...
 
 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)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 incrWithInit ($key, $ttl, $value=1, $init=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 lock ($key, $timeout=6, $expiry=6, $rclass= '')
 Acquire an advisory lock on a key string. More...
 
 makeGlobalKey ()
 Make a global cache key. More...
 
 makeKey ()
 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...
 
 modifySimpleRelayEvent (array $event)
 Modify a cache update operation array for EventRelayer::notify() More...
 
 set ($key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 setDebug ($bool)
 
 setLogger (LoggerInterface $logger)
 
 setMulti (array $data, $exptime=0)
 Batch insertion. More...
 
 unlock ($key)
 Release an advisory lock on a key string. More...
 

Additional Inherited Members

- Public Attributes inherited from HashBagOStuff
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() More...
 
const ERR_UNEXPECTED = 3
 
const ERR_UNREACHABLE = 2
 
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_CACHE_ONLY = 2
 
const WRITE_SYNC = 1
 Bitfield constants for set()/merge() More...
 
- 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_WEEK = 604800
 
const TTL_YEAR = 31536000
 
- Protected Member Functions inherited from CachedBagOStuff
 doGet ($key, $flags=0)
 
- Protected Member Functions inherited from HashBagOStuff
 doGet ($key, $flags=0)
 
 expire ($key)
 
 hasKey ($key)
 Does this bag have a non-null value for the given key? More...
 
- Protected Member Functions inherited from BagOStuff
 cas ($casToken, $key, $value, $exptime=0)
 Check and set an item. More...
 
 convertExpiry ($exptime)
 Convert an optionally relative time to an absolute time. More...
 
 convertToRelative ($exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ($text)
 
 doGet ($key, $flags=0)
 
 getWithToken ($key, &$casToken, $flags=0)
 
 isInteger ($value)
 Check if a value is an integer. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 mergeViaCas ($key, $callback, $exptime=0, $attempts=10)
 
 mergeViaLock ($key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ($err)
 Set the "last error" registry. More...
 
- Protected Attributes inherited from CachedBagOStuff
BagOStuff $backend
 
- Protected Attributes inherited from HashBagOStuff
mixed[] $bag = []
 
integer $maxCacheKeys
 Max entries allowed. More...
 
- Protected Attributes inherited from BagOStuff
callback null $asyncHandler
 
integer[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
callable[] $busyCallbacks = []
 
string $keyspace = 'local'
 
integer $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array[] $locks = []
 Lock tracking. More...
 
LoggerInterface $logger
 
integer $syncTimeout
 Seconds. More...
 

Detailed Description

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

Definition at line 8 of file TestBagOStuff.php.

Constructor & Destructor Documentation

MediaWiki\Session\TestBagOStuff::__construct ( )

Definition at line 10 of file TestBagOStuff.php.

Member Function Documentation

MediaWiki\Session\TestBagOStuff::deleteSession (   $id)
Parameters
string$idSession ID

Definition at line 86 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

MediaWiki\Session\TestBagOStuff::getSession (   $id)
Parameters
string$idSession ID
Returns
mixed

Definition at line 71 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

MediaWiki\Session\TestBagOStuff::getSessionFromBackend (   $id)
Parameters
string$idSession ID
Returns
mixed

Definition at line 79 of file TestBagOStuff.php.

References CachedBagOStuff\makeKey().

MediaWiki\Session\TestBagOStuff::setRawSession (   $id,
  $blob,
  $expiry = 0 
)
Parameters
string$idSession ID
array | mixed$blobSession metadata and data
int$expiryExpiry

Definition at line 59 of file TestBagOStuff.php.

References $blob, RequestContext\getMain(), CachedBagOStuff\makeKey(), and CachedBagOStuff\set().

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

MediaWiki\Session\TestBagOStuff::setSession (   $id,
array  $blob,
  $expiry = 0,
User  $user = null 
)
Parameters
string$idSession ID
array$blobSession metadata and data
int$expiryExpiry
User$userUser for metadata

Definition at line 39 of file TestBagOStuff.php.

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

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

MediaWiki\Session\TestBagOStuff::setSessionData (   $id,
array  $data,
  $expiry = 0,
User  $user = null 
)
Parameters
string$idSession ID
array$dataSession data
int$expiryExpiry
User$userUser for metadata

Definition at line 20 of file TestBagOStuff.php.

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

MediaWiki\Session\TestBagOStuff::setSessionMeta (   $id,
array  $metadata,
  $expiry = 0 
)
Parameters
string$idSession ID
array$metadataSession metadata
int$expiryExpiry

Definition at line 29 of file TestBagOStuff.php.

References MediaWiki\Session\TestBagOStuff\setSession().


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