MediaWiki  REL1_31
MemcachedPhpBagOStuff Class Reference

A wrapper class for the pure-PHP memcached client, exposing a BagOStuff interface. More...

Inheritance diagram for MemcachedPhpBagOStuff:
Collaboration diagram for MemcachedPhpBagOStuff:

Public Member Functions

 __construct ( $params)
 Available parameters are: More...
 
 decr ( $key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. More...
 
 incr ( $key, $value=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 setDebug ( $debug)
 
- Public Member Functions inherited from MemcachedBagOStuff
 __construct (array $params)
 $params include: More...
 
 add ( $key, $value, $exptime=0)
 
 changeTTL ( $key, $exptime=0)
 Reset the TTL on a key if it exists. More...
 
 delete ( $key)
 Delete an item. More...
 
 fixExpiry ( $expiry)
 TTLs higher than 30 days will be detected as absolute TTLs (UNIX timestamps), and will result in the cache entry being discarded immediately because the expiry is in the past. More...
 
 getClient ()
 Get the underlying client object. More...
 
 makeKeyInternal ( $keyspace, $args)
 Construct a cache key. More...
 
 merge ( $key, callable $callback, $exptime=0, $attempts=10, $flags=0)
 Merge changes into the existing cache value (possibly creating a new one) More...
 
 modifySimpleRelayEvent (array $event)
 Modify a cache update operation array for EventRelayer::notify() More...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
 validateKeyEncoding ( $key)
 Ensure that a key is safe to use (contains no control characters and no characters above the ASCII range.) More...
 
- Public Member Functions inherited from BagOStuff
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 clearLastError ()
 Clear the "last error" registry. More...
 
 deleteObjectsExpiringBefore ( $date, $progressCallback=false)
 Delete all objects expiring before a certain date. More...
 
 get ( $key, $flags=0, $oldFlags=null)
 Get an item with the given key. More...
 
 getLastError ()
 Get the "last error" registered; clearLastError() should be called manually. More...
 
 getQoS ( $flag)
 
 getScopedLock ( $key, $timeout=6, $expiry=30, $rclass='')
 Get a lightweight exclusive self-unlocking lock. More...
 
 getWithSetCallback ( $key, $ttl, $callback, $flags=0)
 Get an item with the given key, regenerating and setting it if not found. More...
 
 incrWithInit ( $key, $ttl, $value=1, $init=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 lock ( $key, $timeout=6, $expiry=6, $rclass='')
 Acquire an advisory lock on a key string. More...
 
 makeGlobalKey ( $class, $component=null)
 Make a global cache key. More...
 
 makeKey ( $class, $component=null)
 Make a cache key, scoped to this instance's keyspace. More...
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0)
 Batch insertion. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 

Additional Inherited Members

- Public Attributes inherited from BagOStuff
const ERR_NO_RESPONSE = 1
 
const ERR_NONE = 0
 Possible values for getLastError() More...
 
const ERR_UNEXPECTED = 3
 
const ERR_UNREACHABLE = 2
 
const READ_LATEST = 1
 Bitfield constants for get()/getMulti() More...
 
const READ_VERIFIED = 2
 
const WRITE_CACHE_ONLY = 2
 
const WRITE_SYNC = 1
 Bitfield constants for set()/merge() More...
 
- Public Attributes inherited from IExpiringStore
const 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_SECOND = 1
 
const TTL_WEEK = 604800
 
const TTL_YEAR = 31536000
 
- Protected Member Functions inherited from MemcachedBagOStuff
 applyDefaultParams ( $params)
 Fill in some defaults for missing keys in $params. More...
 
 cas ( $casToken, $key, $value, $exptime=0)
 Check and set an item. More...
 
 debugLog ( $text)
 Send a debug message to the log. More...
 
 doGet ( $key, $flags=0)
 
 getWithToken ( $key, &$casToken, $flags=0)
 
- Protected Member Functions inherited from BagOStuff
 convertExpiry ( $exptime)
 Convert an optionally relative time to an absolute time. More...
 
 convertToRelative ( $exptime)
 Convert an optionally absolute expiry time to a relative time. More...
 
 debug ( $text)
 
 getCurrentTime ()
 
 isInteger ( $value)
 Check if a value is an integer. More...
 
 mergeFlagMaps (array $bags)
 Merge the flag maps of one or more BagOStuff objects into a "lowest common denominator" map. More...
 
 mergeViaCas ( $key, $callback, $exptime=0, $attempts=10)
 
 mergeViaLock ( $key, $callback, $exptime=0, $attempts=10, $flags=0)
 
 setLastError ( $err)
 Set the "last error" registry. More...
 
- Protected Attributes inherited from MemcachedBagOStuff
MemcachedClient Memcached $client
 
- Protected Attributes inherited from BagOStuff
callback null $asyncHandler
 
int[] $attrMap = []
 Map of (ATTR_* class constant => QOS_* class constant) More...
 
callable[] $busyCallbacks = []
 
string $keyspace = 'local'
 
int $lastError = self::ERR_NONE
 ERR_* class constant. More...
 
array[] $locks = []
 Lock tracking. More...
 
LoggerInterface $logger
 
int $syncTimeout
 Seconds. More...
 

Detailed Description

A wrapper class for the pure-PHP memcached client, exposing a BagOStuff interface.

Definition at line 29 of file MemcachedPhpBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

MemcachedPhpBagOStuff::__construct (   $params)

Available parameters are:

  • servers: The list of IP:port combinations holding the memcached servers.
  • debug: Whether to set the debug flag in the underlying client.
  • persistent: Whether to use a persistent connection
  • compress_threshold: The minimum size an object must be before it is compressed
  • timeout: The read timeout in microseconds
  • connect_timeout: The connect timeout in seconds
Parameters
array$params

Definition at line 41 of file MemcachedPhpBagOStuff.php.

References $params, and MemcachedBagOStuff\applyDefaultParams().

Member Function Documentation

◆ decr()

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

Definition at line 68 of file MemcachedPhpBagOStuff.php.

References $value, and MemcachedBagOStuff\validateKeyEncoding().

◆ getMulti()

MemcachedPhpBagOStuff::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
int$flagsBitfield; supports READ_LATEST [optional]
Returns
array

Reimplemented from BagOStuff.

Definition at line 54 of file MemcachedPhpBagOStuff.php.

References $keys, as, and MemcachedBagOStuff\validateKeyEncoding().

◆ incr()

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

Definition at line 62 of file MemcachedPhpBagOStuff.php.

References $value, and MemcachedBagOStuff\validateKeyEncoding().

◆ setDebug()

MemcachedPhpBagOStuff::setDebug (   $bool)
Parameters
bool$bool

Reimplemented from BagOStuff.

Definition at line 50 of file MemcachedPhpBagOStuff.php.

References $debug.


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