MediaWiki REL1_37
|
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. | |
addBusyCallback (callable $workCallback) | |
Let a callback be run to avoid wasting time on special blocking calls. | |
changeTTL ( $key, $exptime=0, $flags=0) | |
Change the expiration on a key if it exists. | |
changeTTLMulti (array $keys, $exptime, $flags=0) | |
Change the expiration of multiple keys that exist. | |
clearLastError () | |
Clear the "last error" registry. | |
delete ( $key, $flags=0) | |
Delete an item. | |
deleteMulti (array $keys, $flags=0) | |
Batch deletion. | |
deleteObjectsExpiringBefore ( $timestamp, callable $progress=null, $limit=INF, string $tag=null) | |
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. | |
getMulti (array $keys, $flags=0) | |
Get an associative array containing the item for each of the keys that have items. | |
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. | |
lock ( $key, $timeout=6, $exptime=6, $rclass='') | |
makeGlobalKey ( $collection,... $components) | |
Make a cache key for the default keyspace and given components. | |
makeKey ( $collection,... $components) | |
Make a cache key for the global keyspace and given components. | |
merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0) | |
Merge changes into the existing cache value (possibly creating a new one) | |
set ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
setMulti (array $valueByKey, $exptime=0, $flags=0) | |
Batch insertion/replace. | |
setNewPreparedValues (array $valueByKey) | |
Make a "generic" reversible cache key from the given components. | |
unlock ( $key) | |
Release an advisory lock on a key string. | |
Public Member Functions inherited from BagOStuff | |
decr ( $key, $value=1, $flags=0) | |
Decrease stored value of $key by $value while preserving its TTL. | |
getCurrentTime () | |
getLogger () | |
getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='') | |
Get a lightweight exclusive self-unlocking lock. | |
getWithSetCallback ( $key, $exptime, $callback, $flags=0) | |
Get an item with the given key, regenerating and setting it if not found. | |
incr ( $key, $value=1, $flags=0) | |
Increase stored value of $key by $value while preserving its TTL. | |
isKeyGlobal ( $key) | |
Check whether a cache key is in the global keyspace. | |
makeKeyInternal ( $keyspace, $components) | |
Make a cache key for the given keyspace and components. | |
registerWrapperInfoForStats (string $prefixComponent, string $statsGroup, callable $collectionCallback) | |
Register info about a caching layer class that uses BagOStuff as a backing store. | |
setDebug ( $enabled) | |
setLogger (LoggerInterface $logger) | |
setMockTime (&$time) | |
Protected Member Functions | |
cas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. | |
convertGenericKey ( $key) | |
Convert a "generic" reversible cache key into one for this cache. | |
debug ( $text) | |
doAdd ( $key, $value, $exptime=0, $flags=0) | |
Insert an item if it does not already exist. | |
doCas ( $casToken, $key, $value, $exptime=0, $flags=0) | |
Check and set an item. | |
doChangeTTL ( $key, $exptime, $flags) | |
doChangeTTLMulti (array $keys, $exptime, $flags=0) | |
doDelete ( $key, $flags=0) | |
Delete an item. | |
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. | |
doLock ( $key, $timeout, $exptime) | |
doSet ( $key, $value, $exptime=0, $flags=0) | |
Set an item. | |
doSetMulti (array $data, $exptime=0, $flags=0) | |
doUnlock ( $key) | |
getExpirationAsTimestamp ( $exptime) | |
Convert an optionally relative timestamp to an absolute time. | |
getExpirationAsTTL ( $exptime) | |
Convert an optionally absolute expiry time to a relative time. | |
getSerialized ( $value, $key) | |
Get the serialized form a value, using any applicable prepared value. | |
guessSerialValueSize ( $value, $depth=0, &$loops=0) | |
Estimate the size of a variable once serialized. | |
isInteger ( $value) | |
Check if a value is an integer. | |
isRelativeExpiration ( $exptime) | |
makeLockKey ( $key) | |
makeValueOrSegmentList ( $key, $value, $exptime, $flags) | |
Determine the entry (inline or segment list) to store under a key to save the value. | |
mergeViaCas ( $key, callable $callback, $exptime, $attempts, $flags) | |
resolveSegments ( $key, $mainValue) | |
Get and reassemble the chunks of blob at the given key. | |
serialize ( $value) | |
setLastError ( $err) | |
Set the "last error" registry. | |
unserialize ( $value) | |
updateOpStats (string $op, array $keyInfo) | |
Protected Member Functions inherited from BagOStuff | |
componentsFromGenericKey ( $key) | |
Extract the components from a "generic" reversible cache key. | |
determineKeyPrefixForStats ( $key) | |
fieldHasFlags ( $field, $flags) | |
genericKeyFromComponents (... $components) | |
At a minimum, there must be a keyspace and collection name component. | |
mergeFlagMaps (array $bags) | |
Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. | |
proxyCall ( $method, $arg0Sig, $resSig, array $genericArgs) | |
Call a method on behalf of wrapper BagOStuff instance that uses "generic" keys. | |
Protected Attributes | |
callable[] | $busyCallbacks = [] |
int | $lastError = self::ERR_NONE |
ERR_* class constant. | |
array< string, array > | $locks = [] |
Map of (key => (class, depth, expiry) | |
array[] | $preparedValues = [] |
Map of (key => (PHP variable value, serialized value)) | |
int | $segmentationSize |
Bytes; chunk size of segmented cache values. | |
int | $segmentedValueMaxSize |
Bytes; maximum total size of a segmented cache value. | |
int | $syncTimeout |
Seconds. | |
const | LOCK_DEPTH = 1 |
const | LOCK_EXPIRY = 3 |
const | LOCK_RCLASS = 0 |
const | LOCK_TIME = 2 |
const | METRIC_OP_ADD = 'add' |
const | METRIC_OP_CAS = 'cas' |
const | METRIC_OP_CHANGE_TTL = 'change_ttl' |
const | METRIC_OP_DECR = 'decr' |
const | METRIC_OP_DELETE = 'delete' |
const | METRIC_OP_GET = 'get' |
const | METRIC_OP_INCR = 'incr' |
const | METRIC_OP_SET = 'set' |
Protected Attributes inherited from BagOStuff | |
callable null | $asyncHandler |
int[] | $attrMap = [] |
Map of (ATTR_* class constant => QOS_* class constant) | |
bool | $debugMode = true |
Whether to send debug log entries to the SPI logger instance. | |
string | $keyspace |
Default keyspace; used by makeKey() | |
LoggerInterface | $logger |
StatsdDataFactoryInterface | $stats |
array< string, array > | $wrapperInfoByPrefix = [] |
Cache key processing callbacks and info for metrics. | |
Private Member Functions | |
checkIterableMapSerializability ( $value, $key) | |
checkValueSerializability ( $value, $key) | |
Log if a new cache value does not appear suitable for serialization at a quick glance. | |
trackDuplicateKeys ( $key) | |
Track the number of times that a given key has been used. | |
Private Attributes | |
bool | $dupeTrackScheduled = false |
array | $duplicateKeyLookups = [] |
bool | $reportDupes = false |
Additional Inherited Members | |
Public Attributes inherited from BagOStuff | |
const | READ_LATEST = 1 |
Bitfield constants for get()/getMulti(); these are only advisory. | |
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. | |
Public Attributes inherited from Wikimedia\LightweightObjectStore\StorageAwareness | |
const | ATTR_DURABILITY = 2 |
Durability of writes; see QOS_DURABILITY_* (higher means stronger) | |
const | ATTR_EMULATION = 1 |
Emulation/fallback mode; see QOS_EMULATION_*; higher is better. | |
const | ERR_NO_RESPONSE = 1 |
Storage medium failed to yield a response. | |
const | ERR_NONE = 0 |
No storage medium error. | |
const | ERR_UNEXPECTED = 3 |
Storage medium operation failed due to usage limitations or an I/O error. | |
const | ERR_UNREACHABLE = 2 |
Storage medium could not be reached. | |
const | QOS_DURABILITY_DISK = 4 |
Data is saved to disk and writes do not usually block on fsync() | |
const | QOS_DURABILITY_NONE = 1 |
Data is never saved to begin with (blackhole store) | |
const | QOS_DURABILITY_RDBMS = 5 |
Data is saved to disk and writes usually block on fsync(), like a standard RDBMS. | |
const | QOS_DURABILITY_SCRIPT = 2 |
Data is lost at the end of the current web request or CLI script. | |
const | QOS_DURABILITY_SERVICE = 3 |
Data is lost once the service storing the data restarts. | |
const | QOS_EMULATION_SQL = 1 |
Fallback disk-based SQL store. | |
const | QOS_UNKNOWN = INF |
Generic "unknown" value; useful for comparisons (always "good enough") | |
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 | @phpcs:ignore Generic.Files.LineLength |
Reimplemented from BagOStuff.
Reimplemented in MemcachedBagOStuff, APCUBagOStuff, EmptyBagOStuff, and WinCacheBagOStuff.
Definition at line 96 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 238 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 834 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 347 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 424 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.
Definition at line 736 of file MediumSpecificBagOStuff.php.
References $keys.
|
private |
array | stdClass | $value | Result of the value generation callback for the key |
string | $key | Cache key |
Definition at line 1140 of file MediumSpecificBagOStuff.php.
|
private |
Log if a new cache value does not appear suitable for serialization at a quick glance.
This aids migration of values to JSON-like structures and the debugging of exceptions due to serialization failure.
This does not recurse more than one level into container structures.
A proper cache key value is one of the following:
mixed | $value | Result of the value generation callback for the key |
string | $key | Cache key |
Definition at line 1120 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::clearLastError | ( | ) |
Clear the "last error" registry.
Reimplemented from BagOStuff.
Definition at line 821 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 APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, RedisBagOStuff, and RESTBagOStuff.
Definition at line 973 of file MediumSpecificBagOStuff.php.
|
protected |
string | $text |
Definition at line 1180 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\fetchBlobs(), 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 205 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 705 of file MediumSpecificBagOStuff.php.
References $keys.
MediumSpecificBagOStuff::deleteObjectsExpiringBefore | ( | $timestamp, | |
callable | $progress = null , |
||
$limit = INF , |
|||
string | $tag = null |
||
) |
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] |
string | null | $tag | Tag to purge a single shard only. This is only supported when server tags are used in configuration. |
Reimplemented from BagOStuff.
Reimplemented in SqlBagOStuff.
Definition at line 610 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 RedisBagOStuff, APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.
|
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 MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.
Definition at line 372 of file MediumSpecificBagOStuff.php.
References $success.
|
protected |
string | $key | |
int | $exptime | |
int | $flags |
Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, and SqlBagOStuff.
Definition at line 434 of file MediumSpecificBagOStuff.php.
References $blob.
|
protected |
string[] | $keys | List of keys |
int | $exptime | TTL or UNIX timestamp |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in RedisBagOStuff, and SqlBagOStuff.
Definition at line 746 of file MediumSpecificBagOStuff.php.
|
abstractprotected |
Delete an item.
string | $key | |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.
Referenced by delete().
|
protected |
string[] | $keys | List of keys |
int | $flags | Bitfield of BagOStuff::WRITE_* constants |
Reimplemented in MemcachedPeclBagOStuff, RedisBagOStuff, and SqlBagOStuff.
Definition at line 718 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 APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.
|
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 MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, and SqlBagOStuff.
Definition at line 649 of file MediumSpecificBagOStuff.php.
|
protected |
string | $key | |
int | $timeout | Lock wait timeout; 0 for non-blocking [optional] |
int | $exptime | Lock time-to-live 1 day maximum [optional] |
Reimplemented in SqlBagOStuff.
Definition at line 503 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 APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, RESTBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.
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 MemcachedPeclBagOStuff, RedisBagOStuff, and SqlBagOStuff.
Definition at line 686 of file MediumSpecificBagOStuff.php.
References $res.
|
protected |
string | $key |
Reimplemented in SqlBagOStuff.
Definition at line 577 of file MediumSpecificBagOStuff.php.
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 121 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 913 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doChangeTTLMulti(), HashBagOStuff\doSet(), and SqlBagOStuff\makeNewKeyExpiry().
|
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 937 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\doAdd(), APCUBagOStuff\doAdd(), WinCacheBagOStuff\doAdd(), RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doChangeTTLMulti(), APCUBagOStuff\doSet(), RedisBagOStuff\doSet(), WinCacheBagOStuff\doSet(), RedisBagOStuff\doSetMulti(), and APCUBagOStuff\incrWithInit().
MediumSpecificBagOStuff::getLastError | ( | ) |
Get the "last error" registered; clearLastError() should be called manually.
Reimplemented from BagOStuff.
Definition at line 813 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 625 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getQoS | ( | $flag | ) |
int | $flag | ATTR_* class constant |
Reimplemented from BagOStuff.
Definition at line 985 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getSegmentationSize | ( | ) |
Reimplemented from BagOStuff.
Definition at line 989 of file MediumSpecificBagOStuff.php.
MediumSpecificBagOStuff::getSegmentedValueMaxSize | ( | ) |
Reimplemented from BagOStuff.
Definition at line 993 of file MediumSpecificBagOStuff.php.
|
protected |
Get the serialized form a value, using any applicable prepared value.
mixed | $value | |
string | $key |
Definition at line 1026 of file MediumSpecificBagOStuff.php.
References serialize().
Referenced by RedisBagOStuff\doAdd(), APCUBagOStuff\doAdd(), WinCacheBagOStuff\doAdd(), APCUBagOStuff\doSet(), RedisBagOStuff\doSet(), WinCacheBagOStuff\doSet(), RedisBagOStuff\doSetMulti(), SqlBagOStuff\modifyTableSpecificBlobsForAdd(), SqlBagOStuff\modifyTableSpecificBlobsForCas(), and SqlBagOStuff\modifyTableSpecificBlobsForSet().
|
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 1056 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 APCUBagOStuff, EmptyBagOStuff, and SqlBagOStuff.
Definition at line 755 of file MediumSpecificBagOStuff.php.
|
finalprotected |
Check if a value is an integer.
mixed | $value |
Definition at line 953 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\dbDecodeSerialValue(), SqlBagOStuff\doIncr(), HashBagOStuff\incr(), RESTBagOStuff\incr(), WinCacheBagOStuff\incr(), SqlBagOStuff\modifyTableSpecificBlobsForIncrInit(), MemcachedPeclBagOStuff\unserialize(), MemcachedPhpBagOStuff\unserialize(), and SqlBagOStuff\unserialize().
|
finalprotected |
int | float | $exptime |
Definition at line 896 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doChangeTTLMulti(), and MemcachedBagOStuff\fixExpiry().
MediumSpecificBagOStuff::lock | ( | $key, | |
$timeout = 6 , |
|||
$exptime = 6 , |
|||
$rclass = '' |
|||
) |
string | $key | |
int | $timeout | |
int | $exptime | |
string | $rclass |
Reimplemented from BagOStuff.
Definition at line 467 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\newLockingWriteSectionModificationTimestamp().
MediumSpecificBagOStuff::makeGlobalKey | ( | $collection, | |
$components | |||
) |
Make a cache key for the default keyspace and given components.
string | $collection | Key collection name component |
string|int | ...$components Additional, ordered, key components for entity IDs |
Reimplemented from BagOStuff.
Definition at line 965 of file MediumSpecificBagOStuff.php.
Referenced by delete().
MediumSpecificBagOStuff::makeKey | ( | $collection, | |
$components | |||
) |
Make a cache key for the global keyspace and given components.
string | $collection | Key collection name component |
string|int | ...$components Additional, ordered, key components for entity IDs |
Reimplemented from BagOStuff.
Definition at line 969 of file MediumSpecificBagOStuff.php.
|
protected |
|
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 848 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 271 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 284 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 778 of file MediumSpecificBagOStuff.php.
References SerializedValueContainer\isUnified(), SerializedValueContainer\UNIFIED_DATA, and unserialize().
Referenced by get().
|
protected |
mixed | $value |
Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, and SqlBagOStuff.
Definition at line 1164 of file MediumSpecificBagOStuff.php.
References serialize().
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 177 of file MediumSpecificBagOStuff.php.
References doSet(), and makeValueOrSegmentList().
|
protected |
Set the "last error" registry.
int | $err | ERR_* constant |
Definition at line 830 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 672 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 HashBagOStuff, and MemcachedPeclBagOStuff.
Definition at line 997 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 131 of file MediumSpecificBagOStuff.php.
Referenced by get().
MediumSpecificBagOStuff::unlock | ( | $key | ) |
Release an advisory lock on a key string.
string | $key |
Reimplemented from BagOStuff.
Definition at line 545 of file MediumSpecificBagOStuff.php.
Referenced by SqlBagOStuff\newLockingWriteSectionModificationTimestamp().
|
protected |
string | int | false | $value |
Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, and SqlBagOStuff.
Definition at line 1173 of file MediumSpecificBagOStuff.php.
References unserialize().
Referenced by RESTBagOStuff\decodeBody(), APCUBagOStuff\doGet(), RedisBagOStuff\doGet(), WinCacheBagOStuff\doGet(), and RedisBagOStuff\doGetMulti().
|
protected |
string | $op | Operation name as a MediumSpecificBagOStuff::METRIC_OP_* constant |
array<int,string>|array<string,int[]> | $keyInfo Key list, if payload sizes are not applicable, otherwise, map of (key => (send payload size, receive payload size)); send and receive sizes are null where not applicable and receive sizes are "false" for keys that were not found during read operations |
Definition at line 1191 of file MediumSpecificBagOStuff.php.
Referenced by RedisBagOStuff\decr(), RedisBagOStuff\doAdd(), RedisBagOStuff\doChangeTTL(), RedisBagOStuff\doChangeTTLMulti(), RedisBagOStuff\doDelete(), RESTBagOStuff\doDelete(), RedisBagOStuff\doDeleteMulti(), RedisBagOStuff\doGet(), RESTBagOStuff\doGet(), SqlBagOStuff\doGet(), RedisBagOStuff\doGetMulti(), SqlBagOStuff\doGetMulti(), RedisBagOStuff\doSet(), RESTBagOStuff\doSet(), RedisBagOStuff\doSetMulti(), RedisBagOStuff\incr(), SqlBagOStuff\modifyTableSpecificBlobsForAdd(), SqlBagOStuff\modifyTableSpecificBlobsForCas(), SqlBagOStuff\modifyTableSpecificBlobsForChangeTTL(), SqlBagOStuff\modifyTableSpecificBlobsForDelete(), SqlBagOStuff\modifyTableSpecificBlobsForIncrInit(), and SqlBagOStuff\modifyTableSpecificBlobsForSet().
|
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 |
Map of (key => (class, depth, expiry)
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().
|
protected |
Definition at line 75 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 77 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 74 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 76 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 69 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 72 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 68 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 71 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 67 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 65 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 70 of file MediumSpecificBagOStuff.php.
|
protected |
Definition at line 66 of file MediumSpecificBagOStuff.php.