MediaWiki  REL1_31
APCBagOStuff Class Reference

This is a wrapper for APC's shared memory functions. More...

Inheritance diagram for APCBagOStuff:
Collaboration diagram for APCBagOStuff:

Public Member Functions

 __construct (array $params=[])
 Available parameters are: More...
 
 decr ( $key, $value=1)
 Decrease stored value of $key by $value while preserving its TTL. More...
 
 delete ( $key)
 Delete an item. More...
 
 incr ( $key, $value=1)
 Increase stored value of $key by $value while preserving its TTL. More...
 
 set ( $key, $value, $exptime=0, $flags=0)
 Set an item. More...
 
- Public Member Functions inherited from BagOStuff
 add ( $key, $value, $exptime=0)
 
 addBusyCallback (callable $workCallback)
 Let a callback be run to avoid wasting time on special blocking calls. More...
 
 changeTTL ( $key, $expiry=0)
 Reset the TTL on a key if it exists. 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...
 
 getMulti (array $keys, $flags=0)
 Get an associative array containing the item for each of the keys that have items. 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...
 
 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...
 
 setDebug ( $bool)
 
 setLogger (LoggerInterface $logger)
 
 setMockTime (&$time)
 
 setMulti (array $data, $exptime=0)
 Batch insertion. More...
 
 unlock ( $key)
 Release an advisory lock on a key string. More...
 

Protected Member Functions

 doGet ( $key, $flags=0)
 
 getUnserialize ( $value)
 
 setSerialize ( $value)
 
- Protected Member Functions inherited from BagOStuff
 cas ( $casToken, $key, $value, $exptime=0)
 Check and set an item. More...
 
 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 ()
 
 getWithToken ( $key, &$casToken, $flags=0)
 
 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

bool $nativeSerialize
 If true, trust the APC implementation to serialize and deserialize objects correctly. More...
 
- 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...
 

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
 

Detailed Description

This is a wrapper for APC's shared memory functions.

Definition at line 29 of file APCBagOStuff.php.

Constructor & Destructor Documentation

◆ __construct()

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

Available parameters are:

  • nativeSerialize: If true, pass objects to apc_store(), and trust it to serialize them correctly. If false, serialize all values in PHP.
Parameters
array$params

Reimplemented from BagOStuff.

Reimplemented in APCUBagOStuff.

Definition at line 52 of file APCBagOStuff.php.

References $params.

Member Function Documentation

◆ decr()

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

Reimplemented in APCUBagOStuff.

Definition at line 117 of file APCBagOStuff.php.

References $value.

◆ delete()

APCBagOStuff::delete (   $key)

Delete an item.

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

Reimplemented from BagOStuff.

Reimplemented in APCUBagOStuff.

Definition at line 107 of file APCBagOStuff.php.

◆ doGet()

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

Reimplemented from BagOStuff.

Reimplemented in APCUBagOStuff.

Definition at line 75 of file APCBagOStuff.php.

References getUnserialize().

◆ getUnserialize()

APCBagOStuff::getUnserialize (   $value)
protected

Definition at line 81 of file APCBagOStuff.php.

References $value, BagOStuff\isInteger(), and unserialize().

Referenced by doGet(), and APCUBagOStuff\doGet().

◆ incr()

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

Reimplemented in APCUBagOStuff.

Definition at line 113 of file APCBagOStuff.php.

References $value.

◆ set()

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

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

Reimplemented in APCUBagOStuff.

Definition at line 90 of file APCBagOStuff.php.

References setSerialize().

◆ setSerialize()

APCBagOStuff::setSerialize (   $value)
protected

Definition at line 100 of file APCBagOStuff.php.

References $value, BagOStuff\isInteger(), and serialize().

Referenced by set(), and APCUBagOStuff\set().

Member Data Documentation

◆ $nativeSerialize

bool APCBagOStuff::$nativeSerialize
protected

If true, trust the APC implementation to serialize and deserialize objects correctly.

If false, (de-)serialize in PHP.

Definition at line 35 of file APCBagOStuff.php.


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