MediaWiki REL1_28
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
BagOStuff Class Reference
Cache

interface is intended to be more or less compatible with the PHP memcached client. More...

Inheritance diagram for BagOStuff:
Inheritance graph
[legend]
Collaboration diagram for BagOStuff:
Collaboration graph
[legend]

Public Member Functions

 __construct (array $params=[])
 $params include:
 
 add ( $key, $value, $exptime=0)
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls.
 
 changeTTL ( $key, $expiry=0)
 Reset the TTL on a key if it exists.
 
 clearLastError ()
 Clear the "last error" registry.
 
 decr ( $key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL.
 
 delete ( $key)
 Delete an item.
 
 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.
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items.
 
 getQoS ( $flag)
 
 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.
 
 incr ( $key, $value=1)
 Increase stored value of $key by $value while preserving its TTL.
 
 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.
 
 makeKeyInternal ( $keyspace, $args)
 Construct a cache key.
 
 merge ( $key, callable $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()
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item.
 
 setDebug ( $bool)
 
 setLogger (LoggerInterface $logger)
 
 setMulti (array $data, $exptime=0)
 Batch insertion.
 
 unlock ( $key)
 Release an advisory lock on a key string.
 

Public Attributes

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 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

 cas ( $casToken, $key, $value, $exptime=0)
 Check and set an item.
 
 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)
 
 doGet ( $key, $flags=0)
 
 getWithToken ( $key, &$casToken, $flags=0)
 
 isInteger ( $value)
 Check if a value is an integer.
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.
 
 mergeViaCas ( $key, $callback, $exptime=0, $attempts=10)
 
 mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ( $err)
 Set the "last error" registry.
 

Protected Attributes

callback null $asyncHandler
 
integer[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant)
 
callable[] $busyCallbacks = []
 
string $keyspace = 'local'
 
integer $lastError = self::ERR_NONE
 ERR_* class constant.
 
array[] $locks = []
 Lock tracking.
 
LoggerInterface $logger
 
integer $syncTimeout
 Seconds.
 

Private Member Functions

 trackDuplicateKeys ( $key)
 Track the number of times that a given key has been used.
 

Private Attributes

bool $debugMode = false
 
bool $dupeTrackScheduled = false
 
array $duplicateKeyLookups = []
 
bool $reportDupes = false
 

Detailed Description

interface is intended to be more or less compatible with the PHP memcached client.

backends for local hash array and SQL table included:

$bag = new HashBagOStuff();
$bag = new SqlBagOStuff(); # connect to db first
HashBagOStuff
Simple store for keeping values in an associative array for the current process.
Definition HashBagOStuff.php:31
SqlBagOStuff
Class to store objects in the database.
Definition SqlBagOStuff.php:32

Definition at line 47 of file BagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

BagOStuff::__construct ( array  $params = [])

$params include:

  • logger: Psr\Log\LoggerInterface instance
  • keyspace: Default keyspace for $this->makeKey()
  • asyncHandler: Callable to use for scheduling tasks after the web request ends. In CLI mode, it should run the task immediately.
  • reportDupes: Whether to emit warning log messages for all keys that were requested more than once (requires an asyncHandler).
  • syncTimeout: How long to wait with WRITE_SYNC in seconds.
    Parameters
    array$params

Reimplemented in MemcachedBagOStuff, APCBagOStuff, and APCUBagOStuff.

Definition at line 100 of file BagOStuff.php.

References $params, and setLogger().

Member Function Documentation

◆ add()

BagOStuff::add (   $key,
  $value,
  $exptime = 0 
)
Parameters
string$key
mixed$value
int$exptime
Returns
bool Success

Reimplemented in EmptyBagOStuff, RedisBagOStuff, MemcachedBagOStuff, MemcachedPeclBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 543 of file BagOStuff.php.

References $value.

Referenced by incrWithInit(), lock(), and mergeViaCas().

◆ addBusyCallback()

BagOStuff::addBusyCallback ( callable  $workCallback)

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 word will get it's result no matter what happens.

$result = null;
$workCallback = function () use ( &$result ) {
if ( !$result ) {
$result = ....
}
return $result;
}
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Associative array mapping language codes to prefixed links of the form "language:title". & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition hooks.txt:1937
Parameters
callable$workCallback
Since
1.28

Definition at line 654 of file BagOStuff.php.

Referenced by ChronologyProtector\shutdown().

◆ cas()

BagOStuff::cas (   $casToken,
  $key,
  $value,
  $exptime = 0 
)
protected

Check and set an item.

Parameters
mixed$casToken
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
Returns
bool Success
Exceptions
Exception

Reimplemented in MemcachedBagOStuff, MemcachedPeclBagOStuff, and SqlBagOStuff.

Definition at line 333 of file BagOStuff.php.

Referenced by mergeViaCas().

◆ changeTTL()

BagOStuff::changeTTL (   $key,
  $expiry = 0 
)

Reset the TTL on a key if it exists.

Parameters
string$key
int$expiry
Returns
bool Success Returns false if there is no key
Since
1.28

Reimplemented in MemcachedPeclBagOStuff, RedisBagOStuff, SqlBagOStuff, and MemcachedBagOStuff.

Definition at line 386 of file BagOStuff.php.

References $value, and false.

◆ clearLastError()

BagOStuff::clearLastError ( )

Clear the "last error" registry.

Since
1.23

Reimplemented in CachedBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 621 of file BagOStuff.php.

Referenced by lock(), mergeViaCas(), and mergeViaLock().

◆ convertExpiry()

BagOStuff::convertExpiry (   $exptime)
protected

Convert an optionally relative time to an absolute time.

Parameters
int$exptime
Returns
int

Definition at line 692 of file BagOStuff.php.

Referenced by SqlBagOStuff\cas(), HashBagOStuff\set(), and SqlBagOStuff\setMulti().

◆ convertToRelative()

BagOStuff::convertToRelative (   $exptime)
protected

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.

Parameters
int$exptime
Returns
int

Definition at line 707 of file BagOStuff.php.

Referenced by RedisBagOStuff\add(), RedisBagOStuff\changeTTL(), RedisBagOStuff\set(), and RedisBagOStuff\setMulti().

◆ debug()

BagOStuff::debug (   $text)
protected
Parameters
string$text

Definition at line 679 of file BagOStuff.php.

Referenced by RedisBagOStuff\getMulti(), SqlBagOStuff\getMulti(), RedisBagOStuff\logRequest(), and RedisBagOStuff\setMulti().

◆ decr()

BagOStuff::decr (   $key,
  $value = 1 
)

Decrease stored value of $key by $value while preserving its TTL.

Parameters
string$key
int$value
Returns
int|bool New value or false on failure

Reimplemented in APCBagOStuff, APCUBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, and XCacheBagOStuff.

Definition at line 578 of file BagOStuff.php.

References $value, and incr().

◆ delete()

BagOStuff::delete (   $key)
abstract

Delete an item.

Parameters
string$key
Returns
bool True if the item was deleted or not found, false on failure

Reimplemented in APCBagOStuff, APCUBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedBagOStuff, MemcachedPeclBagOStuff, MultiWriteBagOStuff, RedisBagOStuff, ReplicatedBagOStuff, RESTBagOStuff, WinCacheBagOStuff, XCacheBagOStuff, and SqlBagOStuff.

◆ deleteObjectsExpiringBefore()

BagOStuff::deleteObjectsExpiringBefore (   $date,
  $progressCallback = false 
)

Delete all objects expiring before a certain date.

Parameters
string$dateThe reference date in MW format
callable | bool$progressCallbackOptional, a function which will be called regularly during long-running operations with the percentage progress as the first parameter.
Returns
bool Success, false if unimplemented

Reimplemented in CachedBagOStuff, MultiWriteBagOStuff, and SqlBagOStuff.

Definition at line 498 of file BagOStuff.php.

◆ doGet()

BagOStuff::doGet (   $key,
  $flags = 0 
)
abstractprotected
Parameters
string$key
integer$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist

Reimplemented in APCBagOStuff, APCUBagOStuff, CachedBagOStuff, EmptyBagOStuff, HashBagOStuff, MemcachedBagOStuff, MultiWriteBagOStuff, RedisBagOStuff, ReplicatedBagOStuff, RESTBagOStuff, WinCacheBagOStuff, XCacheBagOStuff, and SqlBagOStuff.

Referenced by get().

◆ get()

BagOStuff::get (   $key,
  $flags = 0,
  $oldFlags = null 
)

Get an item with the given key.

If the key includes a determistic 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.

Parameters
string$key
integer$flagsBitfield of BagOStuff::READ_* constants [optional]
integer$oldFlags[unused]
Returns
mixed Returns false on failure and if the item does not exist

Definition at line 179 of file BagOStuff.php.

References $flags, doGet(), and trackDuplicateKeys().

Referenced by MediaWiki\Session\SessionBackend\__construct(), Title\newFromTextThrow(), ChronologyProtector\shutdown(), and BagOStuffTest\testReportDupes().

◆ getLastError()

BagOStuff::getLastError ( )

Get the "last error" registered; clearLastError() should be called manually.

Returns
int ERR_* constant for the "last error" registry
Since
1.23

Reimplemented in CachedBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 613 of file BagOStuff.php.

Referenced by lock(), mergeViaCas(), and mergeViaLock().

◆ getMulti()

BagOStuff::getMulti ( array  $keys,
  $flags = 0 
)

Get an associative array containing the item for each of the keys that have items.

Parameters
array$keysList of strings
integer$flagsBitfield; supports READ_LATEST [optional]
Returns
array

Reimplemented in MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, RedisBagOStuff, ReplicatedBagOStuff, and SqlBagOStuff.

Definition at line 509 of file BagOStuff.php.

References $keys, $res, and as.

◆ getQoS()

BagOStuff::getQoS (   $flag)
Parameters
integer$flagATTR_* class constant
Returns
integer QOS_* class constant
Since
1.28

Definition at line 773 of file BagOStuff.php.

Referenced by ChronologyProtector\shutdown().

◆ getScopedLock()

BagOStuff::getScopedLock (   $key,
  $timeout = 6,
  $expiry = 30,
  $rclass = '' 
)
final

Get a lightweight exclusive self-unlocking lock.

Note that the same lock cannot be acquired twice.

This is useful for task de-duplication or to avoid obtrusive (though non-corrupting) DB errors like INSERT key conflicts or deadlocks when using LOCK IN SHARE MODE.

Parameters
string$key
int$timeoutLock wait timeout; 0 for non-blocking [optional]
int$expiryLock expiry [optional]; 1 day maximum
string$rclassAllow reentry if set and the current lock used this value
Returns
ScopedCallback|null Returns null on failure
Since
1.26

Definition at line 469 of file BagOStuff.php.

References lock(), unlock(), and use.

◆ getWithSetCallback()

BagOStuff::getWithSetCallback (   $key,
  $ttl,
  $callback,
  $flags = 0 
)
final

Get an item with the given key, regenerating and setting it if not found.

If the callback returns false, then nothing is stored.

Parameters
string$key
int$ttlTime-to-live (seconds)
callable$callbackCallback that derives the new value
integer$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed The cached value if found or the result of $callback otherwise
Since
1.27

Definition at line 149 of file BagOStuff.php.

References $flags, and $value.

Referenced by ChangesList\numberofWatchingusers().

◆ getWithToken()

BagOStuff::getWithToken (   $key,
&  $casToken,
  $flags = 0 
)
protected
Note
: This method is only needed if merge() uses mergeViaCas()
Parameters
string$key
mixed$casToken
integer$flagsBitfield of BagOStuff::READ_* constants [optional]
Returns
mixed Returns false on failure and if the item does not exist
Exceptions
Exception

Reimplemented in MemcachedBagOStuff, MemcachedPeclBagOStuff, and SqlBagOStuff.

Definition at line 237 of file BagOStuff.php.

Referenced by mergeViaCas().

◆ incr()

BagOStuff::incr (   $key,
  $value = 1 
)

Increase stored value of $key by $value while preserving its TTL.

Parameters
string$keyKey to increase
int$valueValue to add to $key (Default 1)
Returns
int|bool New value or false on failure

Reimplemented in SqlBagOStuff, APCBagOStuff, APCUBagOStuff, MemcachedPeclBagOStuff, MemcachedPhpBagOStuff, MultiWriteBagOStuff, RedisBagOStuff, ReplicatedBagOStuff, and XCacheBagOStuff.

Definition at line 556 of file BagOStuff.php.

References $value, isInteger(), lock(), and unlock().

Referenced by decr(), and incrWithInit().

◆ incrWithInit()

BagOStuff::incrWithInit (   $key,
  $ttl,
  $value = 1,
  $init = 1 
)

Increase stored value of $key by $value while preserving its TTL.

This will create the key with value $init and TTL $ttl instead if not present

Parameters
string$key
int$ttl
int$value
int$init
Returns
int|bool New value or false on failure
Since
1.24

Definition at line 594 of file BagOStuff.php.

References $value, add(), and incr().

◆ isInteger()

BagOStuff::isInteger (   $value)
protected

Check if a value is an integer.

Parameters
mixed$value
Returns
bool

Definition at line 725 of file BagOStuff.php.

References $value.

Referenced by XCacheBagOStuff\doGet(), APCBagOStuff\getUnserialize(), incr(), XCacheBagOStuff\set(), and APCBagOStuff\setSerialize().

◆ lock()

BagOStuff::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

Parameters
string$key
int$timeoutLock wait timeout; 0 for non-blocking [optional]
int$expiryLock expiry [optional]; 1 day maximum
string$rclassAllow reentry if set and the current lock used this value
Returns
bool Success

Reimplemented in CachedBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 403 of file BagOStuff.php.

References add(), clearLastError(), getLastError(), and use.

Referenced by getScopedLock(), incr(), mergeViaLock(), and ChronologyProtector\shutdown().

◆ makeGlobalKey()

BagOStuff::makeGlobalKey ( )

Make a global cache key.

Since
1.27
Parameters
string... Key component (variadic)
Returns
string

Definition at line 753 of file BagOStuff.php.

References makeKeyInternal().

Referenced by ChronologyProtector\__construct(), DatabaseMysqlBase\getMasterServerInfo(), ChronologyProtector\getTouchedKey(), and BagOStuffTest\testMakeKey().

◆ makeKey()

BagOStuff::makeKey ( )

Make a cache key, scoped to this instance's keyspace.

Since
1.27
Parameters
string... Key component (variadic)
Returns
string

Definition at line 764 of file BagOStuff.php.

References makeKeyInternal().

Referenced by BagOStuffTest\testMakeKey().

◆ makeKeyInternal()

BagOStuff::makeKeyInternal (   $keyspace,
  $args 
)

Construct a cache key.

Since
1.27
Parameters
string$keyspace
array$args
Returns
string

Reimplemented in MemcachedBagOStuff.

Definition at line 737 of file BagOStuff.php.

References $args, and as.

Referenced by makeGlobalKey(), makeKey(), and BagOStuffTest\testMakeKey().

◆ merge()

BagOStuff::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.

Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success
Exceptions
InvalidArgumentException

Reimplemented in EmptyBagOStuff, MemcachedBagOStuff, ReplicatedBagOStuff, WinCacheBagOStuff, and SqlBagOStuff.

Definition at line 276 of file BagOStuff.php.

References $flags, and mergeViaLock().

◆ mergeFlagMaps()

BagOStuff::mergeFlagMaps ( array  $bags)
protected

Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map.

Parameters
BagOStuff[]$bags
Returns
integer[] Resulting flag map (class ATTR_* constant => class QOS_* constant)

Definition at line 783 of file BagOStuff.php.

References as.

Referenced by MultiWriteBagOStuff\__construct(), and ReplicatedBagOStuff\__construct().

◆ mergeViaCas()

BagOStuff::mergeViaCas (   $key,
  $callback,
  $exptime = 0,
  $attempts = 10 
)
protected
See also
BagOStuff::merge()
Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
Returns
bool Success

Definition at line 289 of file BagOStuff.php.

References $success, $value, add(), cas(), clearLastError(), getLastError(), and getWithToken().

Referenced by MemcachedBagOStuff\merge(), and SqlBagOStuff\merge().

◆ mergeViaLock()

BagOStuff::mergeViaLock (   $key,
  $callback,
  $exptime = 0,
  $attempts = 10,
  $flags = 0 
)
protected
See also
BagOStuff::merge()
Parameters
string$key
callable$callbackCallback method to be executed
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$attemptsThe amount of times to attempt a merge in case of failure
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Definition at line 347 of file BagOStuff.php.

References $flags, $success, $value, clearLastError(), getLastError(), lock(), and unlock().

Referenced by merge(), and WinCacheBagOStuff\merge().

◆ modifySimpleRelayEvent()

BagOStuff::modifySimpleRelayEvent ( array  $event)

Modify a cache update operation array for EventRelayer::notify()

This is used for relayed writes, e.g. for broadcasting a change to multiple data-centers. If the array contains a 'val' field then the command involves setting a key to that value. Note that for simplicity, 'val' is always a simple scalar value. This method is used to possibly serialize the value and add any cache-specific key/values needed for the relayer daemon (e.g. memcached flags).

Parameters
array$event
Returns
array
Since
1.26

Reimplemented in CachedBagOStuff, MemcachedBagOStuff, and RedisBagOStuff.

Definition at line 672 of file BagOStuff.php.

◆ set()

BagOStuff::set (   $key,
  $value,
  $exptime = 0,
  $flags = 0 
)
abstract

Set an item.

Parameters
string$key
mixed$value
int$exptimeEither an interval in seconds or a unix timestamp for expiry
int$flagsBitfield of BagOStuff::WRITE_* constants
Returns
bool Success

Reimplemented in EmptyBagOStuff, WinCacheBagOStuff, XCacheBagOStuff, RedisBagOStuff, APCBagOStuff, APCUBagOStuff, CachedBagOStuff, HashBagOStuff, MemcachedBagOStuff, MemcachedPeclBagOStuff, MultiWriteBagOStuff, ReplicatedBagOStuff, RESTBagOStuff, and SqlBagOStuff.

Referenced by ChronologyProtector\shutdown().

◆ setDebug()

BagOStuff::setDebug (   $bool)
Parameters
bool$bool

Reimplemented in CachedBagOStuff, MemcachedPhpBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 133 of file BagOStuff.php.

◆ setLastError()

BagOStuff::setLastError (   $err)
protected

Set the "last error" registry.

Parameters
int$errERR_* constant
Since
1.23

Definition at line 630 of file BagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RedisBagOStuff\getConnection(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), SqlBagOStuff\handleReadError(), and SqlBagOStuff\handleWriteError().

◆ setLogger()

BagOStuff::setLogger ( LoggerInterface  $logger)
Parameters
LoggerInterface$logger
Returns
null

Definition at line 126 of file BagOStuff.php.

Referenced by __construct().

◆ setMulti()

BagOStuff::setMulti ( array  $data,
  $exptime = 0 
)

Batch insertion.

Parameters
array$data$key => $value assoc array
int$exptimeEither an interval in seconds or a unix timestamp for expiry
Returns
bool Success
Since
1.24

Reimplemented in RedisBagOStuff, SqlBagOStuff, and MemcachedPeclBagOStuff.

Definition at line 527 of file BagOStuff.php.

References $res, $value, and as.

◆ trackDuplicateKeys()

BagOStuff::trackDuplicateKeys (   $key)
private

Track the number of times that a given key has been used.

Parameters
string$key

Definition at line 192 of file BagOStuff.php.

References $count, and as.

Referenced by get().

◆ unlock()

BagOStuff::unlock (   $key)

Release an advisory lock on a key string.

Parameters
string$key
Returns
bool Success

Reimplemented in CachedBagOStuff, MultiWriteBagOStuff, and ReplicatedBagOStuff.

Definition at line 443 of file BagOStuff.php.

Referenced by getScopedLock(), incr(), mergeViaLock(), and ChronologyProtector\shutdown().

Member Data Documentation

◆ $asyncHandler

callback null BagOStuff::$asyncHandler
protected

Definition at line 57 of file BagOStuff.php.

◆ $attrMap

integer [] BagOStuff::$attrMap = []
protected

Map of (ATTR_* class constant => QOS_* class constant)

Definition at line 74 of file BagOStuff.php.

◆ $busyCallbacks

callable [] BagOStuff::$busyCallbacks = []
protected

Definition at line 71 of file BagOStuff.php.

Referenced by SqlBagOStuff\waitForReplication().

◆ $debugMode

bool BagOStuff::$debugMode = false
private

Definition at line 62 of file BagOStuff.php.

◆ $dupeTrackScheduled

bool BagOStuff::$dupeTrackScheduled = false
private

Definition at line 68 of file BagOStuff.php.

◆ $duplicateKeyLookups

array BagOStuff::$duplicateKeyLookups = []
private

Definition at line 64 of file BagOStuff.php.

◆ $keyspace

string BagOStuff::$keyspace = 'local'
protected

Definition at line 53 of file BagOStuff.php.

Referenced by MemcachedBagOStuff\makeKeyInternal().

◆ $lastError

integer BagOStuff::$lastError = self::ERR_NONE
protected

ERR_* class constant.

Definition at line 51 of file BagOStuff.php.

◆ $locks

array [] BagOStuff::$locks = []
protected

Lock tracking.

Definition at line 49 of file BagOStuff.php.

◆ $logger

LoggerInterface BagOStuff::$logger
protected

Definition at line 55 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\doWrite().

◆ $reportDupes

bool BagOStuff::$reportDupes = false
private

Definition at line 66 of file BagOStuff.php.

◆ $syncTimeout

integer BagOStuff::$syncTimeout
protected

Seconds.

Definition at line 59 of file BagOStuff.php.

◆ ERR_NO_RESPONSE

const BagOStuff::ERR_NO_RESPONSE = 1

Definition at line 78 of file BagOStuff.php.

◆ ERR_NONE

const BagOStuff::ERR_NONE = 0

Possible values for getLastError()

Definition at line 77 of file BagOStuff.php.

◆ ERR_UNEXPECTED

const BagOStuff::ERR_UNEXPECTED = 3

Definition at line 80 of file BagOStuff.php.

Referenced by MemcachedPeclBagOStuff\checkResult(), RESTBagOStuff\handleError(), RedisBagOStuff\handleException(), SqlBagOStuff\handleReadError(), and SqlBagOStuff\handleWriteError().

◆ ERR_UNREACHABLE

const BagOStuff::ERR_UNREACHABLE = 2

Definition at line 79 of file BagOStuff.php.

Referenced by RedisBagOStuff\getConnection(), SqlBagOStuff\handleReadError(), and SqlBagOStuff\handleWriteError().

◆ READ_LATEST

const BagOStuff::READ_LATEST = 1

Bitfield constants for get()/getMulti()

Definition at line 83 of file BagOStuff.php.

◆ READ_VERIFIED

const BagOStuff::READ_VERIFIED = 2

Definition at line 84 of file BagOStuff.php.

◆ WRITE_CACHE_ONLY

const BagOStuff::WRITE_CACHE_ONLY = 2

Definition at line 87 of file BagOStuff.php.

◆ WRITE_SYNC

const BagOStuff::WRITE_SYNC = 1

Bitfield constants for set()/merge()

Definition at line 86 of file BagOStuff.php.

Referenced by MultiWriteBagOStuff\set().

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