EmptyBagOStuff Class Reference
A BagOStuff object with no objects in it. More...
Inheritance diagram for EmptyBagOStuff:
Collaboration diagram for EmptyBagOStuff:
Public Member Functions | |
| delete ($key) | |
| merge ($key, $callback, $exptime=0, $attempts=10, $flags=0) | |
| set ($key, $value, $exp=0, $flags=0) | |
 Public Member Functions inherited from BagOStuff | |
| __construct (array $params=[]) | |
| $params include: More... | |
| add ($key, $value, $exptime=0) | |
| 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... | |
| 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, $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... | |
Protected Member Functions | |
| doGet ($key, $flags=0) | |
| 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... | |
| mergeViaCas ($key, $callback, $exptime=0, $attempts=10) | |
| mergeViaLock ($key, $callback, $exptime=0, $attempts=10, $flags=0) | |
| setLastError ($err) | |
| Set the "last error" registry. More... | |
Additional Inherited Members | |
| 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 | TTL_DAY = 86400 |
| const | TTL_HOUR = 3600 |
| const | TTL_INDEFINITE = 0 |
| const | TTL_MINUTE = 60 |
| const | TTL_MONTH = 2592000 |
| const | TTL_WEEK = 604800 |
| const | TTL_YEAR = 31536000 |
| Protected Attributes inherited from BagOStuff | |
| callback null | $asyncHandler |
| string | $keyspace = 'local' |
| integer | $lastError = self::ERR_NONE |
| array[] | $locks = [] |
| Lock tracking. More... | |
| LoggerInterface | $logger |
Detailed Description
A BagOStuff object with no objects in it.
Used to provide a no-op object to calling code.
Definition at line 29 of file EmptyBagOStuff.php.
Member Function Documentation
| EmptyBagOStuff::delete | ( | $key | ) |
Definition at line 38 of file EmptyBagOStuff.php.
|
protected |
Definition at line 30 of file EmptyBagOStuff.php.
| EmptyBagOStuff::merge | ( | $key, | |
| $callback, | |||
$exptime = 0, |
|||
$attempts = 10, |
|||
$flags = 0 |
|||
| ) |
Definition at line 42 of file EmptyBagOStuff.php.
| EmptyBagOStuff::set | ( | $key, | |
| $value, | |||
$exp = 0, |
|||
$flags = 0 |
|||
| ) |
Definition at line 34 of file EmptyBagOStuff.php.
The documentation for this class was generated from the following file:
- includes/libs/objectcache/EmptyBagOStuff.php
