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
	cas ( $casToken, $key, $value, $exptime=0)
	decr ( $key, $value=1)
	Decrease stored value of $key by $value while preserving its TTL. More...
	delete ( $key, $time=0)
	get ( $key, &$casToken=null)
	incr ( $key, $value=1)
	Increase stored value of $key by $value while preserving its TTL. More...
	merge ( $key, closure $callback, $exptime=0, $attempts=10)
	set ( $key, $value, $exptime=0)
Public Member Functions inherited from BagOStuff
	add ( $key, $value, $exptime=0)
	clearLastError ()
	Clear the "last error" registry. More...
	debug ( $text)
	deleteObjectsExpiringBefore ( $date, $progressCallback=false)
	Delete all objects expiring before a certain date. More...
	getLastError ()
	Get the "last error" registered; clearLastError() should be called manually. More...
	getMulti (array $keys)
	Get an associative array containing the item for each of the keys that have items. More...
	lock ( $key, $timeout=6)
	replace ( $key, $value, $exptime=0)
	setDebug ( $bool)
	unlock ( $key)

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
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...
	isInteger ( $value)
	Check if a value is an integer. More...
	mergeViaCas ( $key, closure $callback, $exptime=0, $attempts=10)
	mergeViaLock ( $key, closure $callback, $exptime=0, $attempts=10)
	setLastError ( $err)
	Set the "last error" registry. More...
Protected Attributes inherited from BagOStuff
	$lastError = self::ERR_NONE

Detailed Description

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

Definition at line 29 of file APCBagOStuff.php.

Member Function Documentation

cas()

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

Parameters

$casToken	mixed
$key	string
$value	mixed
$exptime	int

Returns

bool

Reimplemented from BagOStuff.

Definition at line 74 of file APCBagOStuff.php.

decr()

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

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

Parameters

$key	String
$value	Integer

Returns

integer

Reimplemented from BagOStuff.

Definition at line 105 of file APCBagOStuff.php.

References $value.

delete()

APCBagOStuff::delete	(		$key,
			$time = 0
	)

Parameters

$key	string
$time	int

Returns

bool

Reimplemented from BagOStuff.

Definition at line 84 of file APCBagOStuff.php.

get()

APCBagOStuff::get	(		$key,
		&	$casToken = null
	)

Parameters

$key	string
$casToken[optional]	int

Returns

mixed

Reimplemented from BagOStuff.

Definition at line 35 of file APCBagOStuff.php.

References BagOStuff\isInteger().

incr()

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

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

Parameters

string	$key	Key to increase
	$value	Integer: Value to add to $key (Default 1)

Returns

integer|bool New value or false on failure

Reimplemented from BagOStuff.

Definition at line 101 of file APCBagOStuff.php.

References $value.

merge()

APCBagOStuff::merge	(		$key,
		closure	$callback,
			$exptime = 0,
			$attempts = 10
	)

Parameters

	$key	string
	$callback	closure 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

Returns

bool success

Reimplemented from BagOStuff.

Definition at line 97 of file APCBagOStuff.php.

References BagOStuff\mergeViaLock().

set()

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

Parameters

$key	string
$value	mixed
$exptime	int

Returns

bool

Reimplemented from BagOStuff.

Definition at line 57 of file APCBagOStuff.php.

References $value, and BagOStuff\isInteger().

---

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

• includes/objectcache/APCBagOStuff.php