MediaWiki REL1_27
|
A wrapper class for the PECL memcached client. More...
Public Member Functions | |
__construct ( $params) | |
Constructor. | |
add ( $key, $value, $exptime=0) | |
decr ( $key, $value=1) | |
Decrease stored value of $key by $value while preserving its TTL. | |
delete ( $key) | |
Delete an item. | |
getMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
incr ( $key, $value=1) | |
Increase stored value of $key by $value while preserving its TTL. | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
setMulti (array $data, $exptime=0) | |
Public Member Functions inherited from MemcachedBagOStuff | |
fixExpiry ( $expiry) | |
TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the cache entry being discarded immediately because the expiry is in the past. | |
getClient () | |
Get the underlying client object. | |
makeKeyInternal ( $keyspace, $args) | |
Construct a cache key. | |
merge ( $key, $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() | |
validateKeyEncoding ( $key) | |
Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.) | |
Public Member Functions inherited from BagOStuff | |
__construct (array $params=[]) | |
$params include: | |
clearLastError () | |
Clear the "last error" registry. | |
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. | |
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. | |
lock ( $key, $timeout=6, $expiry=6, $rclass='') | |
Acquire an advisory lock on a key string. | |
makeGlobalKey () | |
Make a global cache key. | |
makeKey () | |
Make a cache key, scoped to this instance's keyspace. | |
setDebug ( $bool) | |
setLogger (LoggerInterface $logger) | |
unlock ( $key) | |
Release an advisory lock on a key string. | |
Protected Member Functions | |
cas ( $casToken, $key, $value, $exptime=0) | |
Check and set an item. | |
checkResult ( $key, $result) | |
Check the return value from a client method call and take any necessary action. | |
getWithToken ( $key, &$casToken, $flags=0) | |
Protected Member Functions inherited from MemcachedBagOStuff | |
applyDefaultParams ( $params) | |
Fill in some defaults for missing keys in $params. | |
debugLog ( $text) | |
Send a debug message to the log. | |
doGet ( $key, $flags=0) | |
Protected Member Functions inherited from BagOStuff | |
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) | |
isInteger ( $value) | |
Check if a value is an integer. | |
mergeViaCas ( $key, $callback, $exptime=0, $attempts=10) | |
mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0) | |
setLastError ( $err) | |
Set the "last error" registry. | |
Additional Inherited Members | |
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 | 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 MemcachedBagOStuff | |
MemcachedClient Memcached | $client |
Protected Attributes inherited from BagOStuff | |
callback null | $asyncHandler |
string | $keyspace = 'local' |
integer | $lastError = self::ERR_NONE |
array[] | $locks = [] |
Lock tracking. | |
LoggerInterface | $logger |
A wrapper class for the PECL memcached client.
Definition at line 29 of file MemcachedPeclBagOStuff.php.
MemcachedPeclBagOStuff::__construct | ( | $params | ) |
Constructor.
Available parameters are:
array | $params |
InvalidArgumentException |
Definition at line 48 of file MemcachedPeclBagOStuff.php.
References $params, MemcachedBagOStuff\applyDefaultParams(), as, serialize(), and IP\splitHostAndPort().
MemcachedPeclBagOStuff::add | ( | $key, | |
$value, | |||
$exptime = 0 |
|||
) |
string | $key | |
mixed | $value | |
int | $exptime |
Reimplemented from MemcachedBagOStuff.
Definition at line 162 of file MemcachedPeclBagOStuff.php.
References $value, checkResult(), and MemcachedBagOStuff\debugLog().
|
protected |
Check and set an item.
mixed | $casToken | |
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
Exception |
Reimplemented from MemcachedBagOStuff.
Definition at line 146 of file MemcachedPeclBagOStuff.php.
References $value, checkResult(), and MemcachedBagOStuff\debugLog().
|
protected |
Check the return value from a client method call and take any necessary action.
Returns the value that the wrapper function should return. At present, the return value is always the same as the return value from the client, but some day we might find a case where it should be different.
string | $key | The key used by the caller, or false if there wasn't one. |
mixed | $result | The return value |
Definition at line 190 of file MemcachedPeclBagOStuff.php.
References MemcachedBagOStuff\debugLog(), BagOStuff\ERR_UNEXPECTED, and BagOStuff\setLastError().
Referenced by add(), cas(), decr(), delete(), getMulti(), getWithToken(), incr(), set(), and setMulti().
MemcachedPeclBagOStuff::decr | ( | $key, | |
$value = 1 |
|||
) |
Decrease stored value of $key by $value while preserving its TTL.
string | $key | |
int | $value |
Reimplemented from BagOStuff.
Definition at line 173 of file MemcachedPeclBagOStuff.php.
References $value, checkResult(), and MemcachedBagOStuff\debugLog().
MemcachedPeclBagOStuff::delete | ( | $key | ) |
Delete an item.
string | $key |
Reimplemented from MemcachedBagOStuff.
Definition at line 151 of file MemcachedPeclBagOStuff.php.
References checkResult(), and MemcachedBagOStuff\debugLog().
MemcachedPeclBagOStuff::getMulti | ( | array | $keys, |
$flags = 0 |
|||
) |
Get an associative array containing the item for each of the keys that have items.
array | $keys | List of strings |
integer | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented from BagOStuff.
Definition at line 219 of file MemcachedPeclBagOStuff.php.
References $keys, as, checkResult(), MemcachedBagOStuff\debugLog(), and MemcachedBagOStuff\validateKeyEncoding().
|
protected |
string | $key | |
mixed | $casToken | |
integer | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
Exception |
Reimplemented from MemcachedBagOStuff.
Definition at line 122 of file MemcachedPeclBagOStuff.php.
References $flags, $res, checkResult(), MemcachedBagOStuff\debugLog(), and MemcachedBagOStuff\validateKeyEncoding().
MemcachedPeclBagOStuff::incr | ( | $key, | |
$value = 1 |
|||
) |
Increase stored value of $key by $value while preserving its TTL.
string | $key | Key to increase |
int | $value | Value to add to $key (Default 1) |
Reimplemented from BagOStuff.
Definition at line 167 of file MemcachedPeclBagOStuff.php.
References $value, checkResult(), and MemcachedBagOStuff\debugLog().
MemcachedPeclBagOStuff::set | ( | $key, | |
$value, | |||
$exptime = 0 , |
|||
$flags = 0 |
|||
) |
Set an item.
string | $key | |
mixed | $value | |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from MemcachedBagOStuff.
Definition at line 141 of file MemcachedPeclBagOStuff.php.
References $value, checkResult(), and MemcachedBagOStuff\debugLog().
MemcachedPeclBagOStuff::setMulti | ( | array | $data, |
$exptime = 0 |
|||
) |
array | $data | |
int | $exptime |
Reimplemented from BagOStuff.
Definition at line 233 of file MemcachedPeclBagOStuff.php.
References as, checkResult(), MemcachedBagOStuff\debugLog(), MemcachedBagOStuff\fixExpiry(), and MemcachedBagOStuff\validateKeyEncoding().