MediaWiki
master
|
Storage medium specific cache for storing items (e.g. More...
Public Member Functions | |
__construct (array $params=[]) | |
add ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. More... | |
addBusyCallback (callable $workCallback) | |
Let a callback be run to avoid wasting time on special blocking calls. More... | |
changeTTL ( $key, $exptime=0, $flags=0) | |
Change the expiration on a key if it exists. More... | |
changeTTLMulti (array $keys, $exptime, $flags=0) | |
Change the expiration of multiple keys that exist. More... | |
clearLastError () | |
Clear the "last error" registry. More... | |
delete ( $key, $flags=0) | |
Delete an item. More... | |
deleteMulti (array $keys, $flags=0) | |
Batch deletion. More... | |
deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF) | |
Delete all objects expiring before a certain date. More... | |
get ( $key, $flags=0) | |
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) | |
getSegmentationSize () | |
getSegmentedValueMaxSize () | |
incrWithInit ( $key, $exptime, $value=1, $init=null, $flags=0) | |
Increase the value of the given key (no TTL change) if it exists or create it otherwise. More... | |
lock ( $key, $timeout=6, $expiry=6, $rclass='') | |
Acquire an advisory lock on a key string. More... | |
makeGlobalKey ( $class,... $components) | |
Make a cache key for the default keyspace and given components. More... | |
makeKey ( $class,... $components) | |
Make a cache key for the global keyspace and given components. More... | |
merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0) | |
Merge changes into the existing cache value (possibly creating a new one) More... | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. More... | |
setMulti (array $valueByKey, $exptime=0, $flags=0) | |
Batch insertion/replace. More... | |
setNewPreparedValues (array $valueByKey) | |
Make a "generic" reversible cache key from the given components. More... | |
unlock ( $key) | |
Release an advisory lock on a key string. More... | |
![]() | |
decr ( $key, $value=1, $flags=0) | |
Decrease stored value of $key by $value while preserving its TTL. More... | |
getCurrentTime () | |
getLogger () | |
getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. More... | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item with the given key, regenerating and setting it if not found. More... | |
incr ( $key, $value=1, $flags=0) | |
Increase stored value of $key by $value while preserving its TTL. More... | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. More... | |
makeKeyInternal ( $keyspace, $components) | |
Make a cache key for the given keyspace and components. More... | |
setDebug ( $enabled) | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
Protected Member Functions | |
cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. More... | |
convertGenericKey ( $key) | |
Convert a "generic" reversible cache key into one for this cache. More... | |
debug ( $text) | |
doAdd ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. More... | |
doCas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. More... | |
doChangeTTL ( $key, $exptime, $flags) | |
doDelete ( $key, $flags=0) | |
Delete an item. More... | |
doDeleteMulti (array $keys, $flags=0) | |
doGet ( $key, $flags=0, &$casToken=null) | |
doGetMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. More... | |
doSet ( $key, $value, $exptime=0, $flags=0) | |
Set an item. More... | |
doSetMulti (array $data, $exptime=0, $flags=0) | |
getExpirationAsTimestamp ( $exptime) | |
Convert an optionally relative timestamp to an absolute time. More... | |
getExpirationAsTTL ( $exptime) | |
Convert an optionally absolute expiry time to a relative time. More... | |
getSerialized ( $value, $key) | |
Get the serialized form a value, using any applicable prepared value. More... | |
guessSerialValueSize ( $value, $depth=0, &$loops=0) | |
Estimate the size of a variable once serialized. More... | |
isInteger ( $value) | |
Check if a value is an integer. More... | |
isRelativeExpiration ( $exptime) | |
makeValueOrSegmentList ( $key, $value, $exptime, $flags) | |
Determine the entry (inline or segment list) to store under a key to save the value. More... | |
mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags) | |
resolveSegments ( $key, $mainValue) | |
Get and reassemble the chunks of blob at the given key. More... | |
serialize ( $value) | |
setLastError ( $err) | |
Set the "last error" registry. More... | |
unserialize ( $value) | |
![]() | |
componentsFromGenericKey ( $key) | |
Extract the components from a "generic" reversible cache key. More... | |
fieldHasFlags ( $field, $flags) | |
genericKeyFromComponents (... $components) | |
At a minimum, there must be a keyspace and collection name component. More... | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More... | |
proxyCall ( $method, $arg0Sig, $resSig, array $genericArgs) | |
Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys. More... | |
Protected Attributes | |
callable[] | $busyCallbacks = [] |
int | $lastError = self::ERR_NONE |
ERR_* class constant. More... | |
array[] | $locks = [] |
Lock tracking. More... | |
array[] | $preparedValues = [] |
Map of (key => (PHP variable value, serialized value)) More... | |
int | $segmentationSize |
Bytes; chunk size of segmented cache values. More... | |
int | $segmentedValueMaxSize |
Bytes; maximum total size of a segmented cache value. More... | |
int | $syncTimeout |
Seconds. More... | |
![]() | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (ATTR_* class constant => QOS_* class constant) More... | |
bool | $debugMode = false |
Whether to send debug log entries to the SPI logger instance. More... | |
string | $keyspace |
Default keyspace; used by makeKey() More... | |
LoggerInterface | $logger |
Private Member Functions | |
trackDuplicateKeys ( $key) | |
Track the number of times that a given key has been used. More... | |
Private Attributes | |
bool | $dupeTrackScheduled = false |
array | $duplicateKeyLookups = [] |
bool | $reportDupes = false |
Additional Inherited Members | |
![]() | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. More... | |
const | READ_VERIFIED = 2 |
const | WRITE_ALLOW_SEGMENTS = 16 |
const | WRITE_BACKGROUND = 64 |
const | WRITE_CACHE_ONLY = 8 |
const | WRITE_PRUNE_SEGMENTS = 32 |
const | WRITE_SYNC = 4 |
Bitfield constants for set()/merge(); these are only advisory. More... | |
Storage medium specific cache for storing items (e.g.
redis, memcached, ...)
This should not be used for proxy classes that simply wrap other cache instances
Definition at line 34 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::__construct | ( | array | $params = [] | ) |
array | $params | -param array{logger?:Psr\Log\LoggerInterface,asyncHandler?:callable,reportDupes?:bool,syncTimeout?:int,segmentationSize?:int,segmentedValueMaxSize?:int} $params |
Reimplemented from BagOStuff.
Reimplemented in WinCacheBagOStuff, EmptyBagOStuff, APCUBagOStuff, and MemcachedBagOStuff.
Definition at line 83 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::add | ( | $key, | |
$value, | |||
$exptime = 0 , |
|||
$flags = 0 |
|||
) |
Insert an item if it does not already exist.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from BagOStuff.
Definition at line 225 of file MediumSpecificBagOStuff.php.
Referenced by MemcLockManager\acquireMutexes().
|
final |
Let a callback be run to avoid wasting time on special blocking calls.
The callbacks may or may not be called ever, in any particular order. They are likely to be invoked when something WRITE_SYNC is used used. They should follow a caching pattern as shown below, so that any code using the work will get it's result no matter what happens.
callable | $workCallback |
Reimplemented from BagOStuff.
Definition at line 755 of file MediumSpecificBagOStuff.php.
|
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 |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Definition at line 334 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::changeTTL | ( | $key, | |
$exptime = 0 , |
|||
$flags = 0 |
|||
) |
Change the expiration on a key if it exists.
If an expiry in the past is given then the key will immediately be expired
For large values written using WRITE_ALLOW_SEGMENTS, this only changes the TTL of the main segment list key. While lowering the TTL of the segment list key has the effect of functionally lowering the TTL of the key, it might leave unused blobs in cache for longer. Raising the TTL of such keys is not effective, since the expiration of a single segment key effectively expires the entire value.
string | $key | |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from BagOStuff.
Definition at line 411 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::changeTTLMulti | ( | array | $keys, |
$exptime, | |||
$flags = 0 |
|||
) |
Change the expiration of multiple keys that exist.
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from BagOStuff.
Reimplemented in SqlBagOStuff, and RedisBagOStuff.
Definition at line 667 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::clearLastError | ( | ) |
Clear the "last error" registry.
Reimplemented from BagOStuff.
Definition at line 742 of file MediumSpecificBagOStuff.php.
|
protected |
Convert a "generic" reversible cache key into one for this cache.
string | $key | Keyspace-prepended list of encoded components as a colon-separated value |
Reimplemented from BagOStuff.
Reimplemented in RESTBagOStuff, RedisBagOStuff, HashBagOStuff, EmptyBagOStuff, and APCUBagOStuff.
Definition at line 894 of file MediumSpecificBagOStuff.php.
|
protected |
string | $text |
Definition at line 1040 of file MediumSpecificBagOStuff.php.
Referenced by MemcachedPeclBagOStuff\checkResult(), MemcachedPeclBagOStuff\decr(), MemcachedPeclBagOStuff\doAdd(), MemcachedPeclBagOStuff\doCas(), MemcachedPeclBagOStuff\doChangeTTL(), MemcachedPeclBagOStuff\doDelete(), MemcachedPeclBagOStuff\doDeleteMulti(), MemcachedPeclBagOStuff\doGet(), MemcachedPeclBagOStuff\doGetMulti(), MemcachedPeclBagOStuff\doSet(), MemcachedPeclBagOStuff\doSetMulti(), SqlBagOStuff\fetchBlobMulti(), MemcachedPeclBagOStuff\incr(), and RedisBagOStuff\logRequest().
MediumSpecificBagOStuff::delete | ( | $key, | |
$flags = 0 |
|||
) |
Delete an item.
For large values written using WRITE_ALLOW_SEGMENTS, this only deletes the main segment list key unless WRITE_PRUNE_SEGMENTS is in the flags. While deleting the segment list key has the effect of functionally deleting the key, it leaves unused blobs in cache.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from BagOStuff.
Definition at line 192 of file MediumSpecificBagOStuff.php.
References doDelete(), doGet(), BagOStuff\fieldHasFlags(), SerializedValueContainer\isSegmented(), makeGlobalKey(), and SerializedValueContainer\SEGMENTED_HASHES.
Referenced by MemcLockManager\releaseMutexes().
MediumSpecificBagOStuff::deleteMulti | ( | array | $keys, |
$flags = 0 |
|||
) |
Batch deletion.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from BagOStuff.
Definition at line 635 of file MediumSpecificBagOStuff.php.
References $keys.
MediumSpecificBagOStuff::deleteObjectsExpiringBefore | ( | $timestamp, | |
callable | $progress = null , |
||
$limit = INF |
|||
) |
Delete all objects expiring before a certain date.
string | int | $timestamp | The reference date in MW or TS_UNIX format |
callable | null | $progress | Optional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter. [optional] |
int | $limit | Maximum number of keys to delete [default: INF] |
Reimplemented from BagOStuff.
Reimplemented in SqlBagOStuff.
Definition at line 541 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Insert an item if it does not already exist.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, APCUBagOStuff, and RedisBagOStuff.
|
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 |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, MemcachedPhpBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 359 of file MediumSpecificBagOStuff.php.
References $success.
|
protected |
string | $key | |
int | $exptime | |
int | $flags |
Reimplemented in SqlBagOStuff, RedisBagOStuff, MemcachedPhpBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 421 of file MediumSpecificBagOStuff.php.
References $blob.
|
abstractprotected |
Delete an item.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, RedisBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, and APCUBagOStuff.
Referenced by delete().
|
protected |
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in SqlBagOStuff, RedisBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 648 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
mixed | null | &$casToken | cas() token if MediumSpecificBagOStuff::PASS_BY_REF [returned] |
Reimplemented in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, RedisBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, and APCUBagOStuff.
|
protected |
Get an associative array containing the item for each of the keys that have items.
string[] | $keys | List of keys |
int | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented in SqlBagOStuff, RedisBagOStuff, MemcachedPhpBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 579 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
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 in SqlBagOStuff, WinCacheBagOStuff, RESTBagOStuff, RedisBagOStuff, MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, HashBagOStuff, EmptyBagOStuff, and APCUBagOStuff.
Referenced by set().
|
protected |
mixed[] | $data | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in SqlBagOStuff, RedisBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 616 of file MediumSpecificBagOStuff.php.
References $res.
MediumSpecificBagOStuff::get | ( | $key, | |
$flags = 0 |
|||
) |
Get an item with the given key.
If the key includes a deterministic input hash (e.g. the key can only have the correct value) or complete staleness checks are handled by the caller (e.g. nothing relies on the TTL), then the READ_VERIFIED flag should be set. This lets tiered backends know they can safely upgrade a cached value to higher tiers using standard TTLs.
string | $key | |
int | $flags | Bitfield of BagOStuff::READ_* constants [optional] |
Reimplemented from BagOStuff.
Definition at line 108 of file MediumSpecificBagOStuff.php.
References doGet(), resolveSegments(), and trackDuplicateKeys().
|
finalprotected |
Convert an optionally relative timestamp to an absolute time.
The input value will be cast to an integer and interpreted as follows:
int | $exptime |
Definition at line 834 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\changeTTLMulti(), SqlBagOStuff\doCas(), RedisBagOStuff\doChangeTTL(), HashBagOStuff\doSet(), and SqlBagOStuff\modifyMulti().
|
finalprotected |
Convert an optionally absolute expiry time to a relative time.
If an absolute time is specified which is in the past, use a short expiry time.
The input value will be cast to an integer and interpreted as follows:
int | $exptime |
Definition at line 858 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doAdd(), RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doSet(), and RedisBagOStuff\doSetMulti().
MediumSpecificBagOStuff::getLastError | ( | ) |
Get the "last error" registered; clearLastError() should be called manually.
Reimplemented from BagOStuff.
Definition at line 734 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getMulti | ( | array | $keys, |
$flags = 0 |
|||
) |
Get an associative array containing the item for each of the keys that have items.
string[] | $keys | List of keys; can be a map of (unused => key) for convenience |
int | $flags | Bitfield; supports READ_LATEST [optional] |
Reimplemented from BagOStuff.
Definition at line 555 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getQoS | ( | $flag | ) |
int | $flag | ATTR_* class constant |
Reimplemented from BagOStuff.
Definition at line 906 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getSegmentationSize | ( | ) |
Reimplemented from BagOStuff.
Definition at line 910 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getSegmentedValueMaxSize | ( | ) |
Reimplemented from BagOStuff.
Definition at line 914 of file MediumSpecificBagOStuff.php.
|
protected |
Get the serialized form a value, using any applicable prepared value.
mixed | $value | |
string | $key |
Definition at line 947 of file MediumSpecificBagOStuff.php.
References serialize().
Referenced by RedisBagOStuff\doAdd(), APCUBagOStuff\doAdd(), WinCacheBagOStuff\doAdd(), APCUBagOStuff\doSet(), RedisBagOStuff\doSet(), WinCacheBagOStuff\doSet(), and RedisBagOStuff\doSetMulti().
|
protected |
Estimate the size of a variable once serialized.
mixed | $value | |
int | $depth | Current stack depth |
int | &$loops | Number of iterable nodes visited |
Definition at line 975 of file MediumSpecificBagOStuff.php.
Referenced by HashBagOStuff\setNewPreparedValues(), and MemcachedPeclBagOStuff\setNewPreparedValues().
MediumSpecificBagOStuff::incrWithInit | ( | $key, | |
$exptime, | |||
$value = 1 , |
|||
$init = null , |
|||
$flags = 0 |
|||
) |
Increase the value of the given key (no TTL change) if it exists or create it otherwise.
This will create the key with the value $init and TTL $exptime instead if not present. Callers should make sure that both ($init - $value) and $exptime are invariants for all operations to any given key. The value of $init should be at least that of $value.
string | $key | Key built via makeKey() or makeGlobalKey() |
int | $exptime | Time-to-live (in seconds) or a UNIX timestamp expiration |
int | $value | Amount to increase the key value by [default: 1] |
int | null | $init | Value to initialize the key to if it does not exist [default: $value] |
int | $flags | Bit field of class WRITE_* constants [optional] |
Reimplemented from BagOStuff.
Reimplemented in EmptyBagOStuff, and APCUBagOStuff.
Definition at line 676 of file MediumSpecificBagOStuff.php.
|
finalprotected |
Check if a value is an integer.
mixed | $value |
Definition at line 874 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\incr(), HashBagOStuff\incr(), RESTBagOStuff\incr(), WinCacheBagOStuff\incr(), SqlBagOStuff\unserialize(), MemcachedPeclBagOStuff\unserialize(), and MemcachedPhpBagOStuff\unserialize().
|
finalprotected |
int | float | $exptime |
Definition at line 817 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\changeTTLMulti(), RedisBagOStuff\doChangeTTL(), and MemcachedBagOStuff\fixExpiry().
MediumSpecificBagOStuff::lock | ( | $key, | |
$timeout = 6 , |
|||
$expiry = 6 , |
|||
$rclass = '' |
|||
) |
Acquire an advisory lock on a key string.
Note that if reentry is enabled, duplicate calls ignore $expiry
string | $key | |
int | $timeout | Lock wait timeout; 0 for non-blocking [optional] |
int | $expiry | Lock expiry [optional]; 1 day maximum |
string | $rclass | Allow reentry if set and the current lock used this value |
Reimplemented from BagOStuff.
Reimplemented in SqlBagOStuff.
Definition at line 457 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::makeGlobalKey | ( | $class, | |
$components | |||
) |
Make a cache key for the default keyspace and given components.
string | $class | Key collection name component |
string|int | ...$components Key components for entity IDs |
Reimplemented from BagOStuff.
Definition at line 886 of file MediumSpecificBagOStuff.php.
Referenced by delete().
MediumSpecificBagOStuff::makeKey | ( | $class, | |
$components | |||
) |
Make a cache key for the global keyspace and given components.
string | $class | Key collection name component |
string|int | ...$components Key components for entity IDs |
Reimplemented from BagOStuff.
Definition at line 890 of file MediumSpecificBagOStuff.php.
|
finalprotected |
Determine the entry (inline or segment list) to store under a key to save the value.
string | $key | |
mixed | $value | |
int | $exptime | |
int | $flags |
Definition at line 769 of file MediumSpecificBagOStuff.php.
References $serialized, SerializedValueContainer\newSegmented(), and SerializedValueContainer\newUnified().
Referenced by set().
MediumSpecificBagOStuff::merge | ( | $key, | |
callable | $callback, | ||
$exptime = 0 , |
|||
$attempts = 10 , |
|||
$flags = 0 |
|||
) |
Merge changes into the existing cache value (possibly creating a new one)
The callback function returns the new value given the current value (which will be false if not present), and takes the arguments: (this BagOStuff, cache key, current value, TTL). The TTL parameter is reference set to $exptime. It can be overriden in the callback. Nothing is stored nor deleted if the callback returns false.
string | $key | |
callable | $callback | Callback method to be executed |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $attempts | The amount of times to attempt a merge in case of failure |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented from BagOStuff.
Reimplemented in EmptyBagOStuff.
Definition at line 258 of file MediumSpecificBagOStuff.php.
|
finalprotected |
string | $key | |
callable | $callback | Callback method to be executed |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $attempts | The amount of times to attempt a merge in case of failure |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Definition at line 271 of file MediumSpecificBagOStuff.php.
References $success.
|
finalprotected |
Get and reassemble the chunks of blob at the given key.
string | $key | |
mixed | $mainValue |
Definition at line 699 of file MediumSpecificBagOStuff.php.
References SerializedValueContainer\isUnified(), SerializedValueContainer\UNIFIED_DATA, and unserialize().
Referenced by get().
|
protected |
mixed | $value |
Reimplemented in MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, and SqlBagOStuff.
Definition at line 1024 of file MediumSpecificBagOStuff.php.
References serialize().
Referenced by RESTBagOStuff\encodeBody().
MediumSpecificBagOStuff::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 BagOStuff.
Definition at line 164 of file MediumSpecificBagOStuff.php.
References doSet(), and makeValueOrSegmentList().
|
protected |
Set the "last error" registry.
int | $err | ERR_* constant |
Definition at line 751 of file MediumSpecificBagOStuff.php.
Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\getConnection(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), and SqlBagOStuff\setAndLogDBError().
MediumSpecificBagOStuff::setMulti | ( | array | $valueByKey, |
$exptime = 0 , |
|||
$flags = 0 |
|||
) |
Batch insertion/replace.
This does not support WRITE_ALLOW_SEGMENTS to avoid excessive read I/O
mixed[] | $valueByKey | Map of (key => value) |
int | $exptime | Either an interval in seconds or a unix timestamp for expiry |
int | $flags | Bitfield of BagOStuff::WRITE_* constants (since 1.33) |
Reimplemented from BagOStuff.
Definition at line 602 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::setNewPreparedValues | ( | array | $valueByKey | ) |
Make a "generic" reversible cache key from the given components.
All previously prepared values will be cleared. Each of the new prepared values will be individually cleared as they get used by write operations for that key. This is done to avoid unchecked growth in PHP memory usage.
Example usage:
This is only useful if the caller needs an estimate of the serialized object sizes. The caller cannot know the serialization format and even if it did, it could be expensive to serialize complex values twice just to get the size information before writing them to cache. This method solves both problems by making the cache instance do the serialization and having it reuse the result when the cache write happens.
array | $valueByKey | Map of (cache key => PHP variable value to serialize) |
Reimplemented from BagOStuff.
Reimplemented in MemcachedPeclBagOStuff, and HashBagOStuff.
Definition at line 918 of file MediumSpecificBagOStuff.php.
References $serialized, and serialize().
|
private |
Track the number of times that a given key has been used.
string | $key |
Definition at line 118 of file MediumSpecificBagOStuff.php.
Referenced by get().
MediumSpecificBagOStuff::unlock | ( | $key | ) |
Release an advisory lock on a key string.
string | $key |
Reimplemented from BagOStuff.
Reimplemented in SqlBagOStuff.
Definition at line 509 of file MediumSpecificBagOStuff.php.
|
protected |
string | int | $value |
Reimplemented in MemcachedPhpBagOStuff, MemcachedPeclBagOStuff, and SqlBagOStuff.
Definition at line 1033 of file MediumSpecificBagOStuff.php.
References unserialize().
Referenced by RESTBagOStuff\decodeBody(), APCUBagOStuff\doGet(), RedisBagOStuff\doGet(), WinCacheBagOStuff\doGet(), and RedisBagOStuff\doGetMulti().
|
protected |
Definition at line 54 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\waitForReplication().
|
private |
Definition at line 51 of file MediumSpecificBagOStuff.php.
|
private |
Definition at line 47 of file MediumSpecificBagOStuff.php.
|
protected |
ERR_* class constant.
Definition at line 38 of file MediumSpecificBagOStuff.php.
|
protected |
Lock tracking.
Definition at line 36 of file MediumSpecificBagOStuff.php.
|
protected |
Map of (key => (PHP variable value, serialized value))
Definition at line 57 of file MediumSpecificBagOStuff.php.
|
private |
Definition at line 49 of file MediumSpecificBagOStuff.php.
|
protected |
Bytes; chunk size of segmented cache values.
Definition at line 42 of file MediumSpecificBagOStuff.php.
|
protected |
Bytes; maximum total size of a segmented cache value.
Definition at line 44 of file MediumSpecificBagOStuff.php.
|
protected |
Seconds.
Definition at line 40 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\waitForReplication().