MemcachedPeclBagOStuff Class Reference

A wrapper class for the PECL memcached client. More...

Inheritance diagram for MemcachedPeclBagOStuff:

Collaboration diagram for MemcachedPeclBagOStuff:

List of all members.

Public Member Functions
	__construct ($params)
	Constructor.
	add ($key, $value, $exptime=0)
	cas ($casToken, $key, $value, $exptime=0)
	decr ($key, $value=1)
	delete ($key, $time=0)
	get ($key, &$casToken=null)
	getMulti (array $keys)
	incr ($key, $value=1)
	replace ($key, $value, $exptime=0)
	set ($key, $value, $exptime=0)
Protected Member Functions
	checkResult ($key, $result)
	Check the return value from a client method call and take any necessary action.

---

Detailed Description

A wrapper class for the PECL memcached client.

Definition at line 29 of file MemcachedPeclBagOStuff.php.

---

Constructor & Destructor Documentation

MemcachedPeclBagOStuff::__construct

(

$

params

)

Constructor.

Available parameters are:

• servers: The list of IP:port combinations holding the memcached servers.
• 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
• serializer: May be either "php" or "igbinary". Igbinary produces more compact values, but serialization is much slower unless the php.ini option igbinary.compact_strings is off.

Definition at line 44 of file MemcachedPeclBagOStuff.php.

References $params, MemcachedBagOStuff\applyDefaultParams(), array(), as, IP\splitHostAndPort(), and wfDebug().

---

Member Function Documentation

MemcachedPeclBagOStuff::add	(	$	key,
		$	value,
		$	exptime = 0
	)

Parameters:

$key	string
$value	int
$exptime	int

Returns:

Mixed

Reimplemented from MemcachedBagOStuff.

Definition at line 164 of file MemcachedPeclBagOStuff.php.

References $value, add, checkResult(), and MemcachedBagOStuff\debugLog().

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

Parameters:

$casToken	float
$key	string
$value
$exptime	int

Returns:

bool

Reimplemented from MemcachedBagOStuff.

Definition at line 137 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::checkResult	(	$	key,
		$	result
	)		[protected]

Check the return value from a client method call and take any necessary action.

Returns the value that the wrapper function should return. At present, the return value is always the same as the return value from the client, but some day we might find a case where it should be different.

Parameters:

string	$key	The key used by the caller, or false if there wasn't one.
	$result	Mixed The return value

Returns:

Mixed

Definition at line 213 of file MemcachedPeclBagOStuff.php.

References $result, MemcachedBagOStuff\debugLog(), and wfDebugLog().

Referenced by add(), cas(), decr(), delete(), get(), getMulti(), incr(), replace(), and set().

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

Parameters:

$key	string
$value	int

Returns:

Mixed

Reimplemented from BagOStuff.

Definition at line 196 of file MemcachedPeclBagOStuff.php.

References $result, $value, checkResult(), and MemcachedBagOStuff\debugLog().

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

Parameters:

$key	string
$time	int

Returns:

bool

Reimplemented from MemcachedBagOStuff.

Definition at line 147 of file MemcachedPeclBagOStuff.php.

References $result, $time, checkResult(), and MemcachedBagOStuff\debugLog().

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

Parameters:

$key	string
$casToken[optional]	float

Returns:

Mixed

Reimplemented from MemcachedBagOStuff.

Definition at line 110 of file MemcachedPeclBagOStuff.php.

References $result, checkResult(), MemcachedBagOStuff\debugLog(), MemcachedBagOStuff\encodeKey(), wfProfileIn(), and wfProfileOut().

MemcachedPeclBagOStuff::getMulti

(

array $

keys

)

Parameters:

$keys

Array

Returns:

Array

Reimplemented from BagOStuff.

Definition at line 243 of file MemcachedPeclBagOStuff.php.

References $result, array(), checkResult(), MemcachedBagOStuff\debugLog(), wfProfileIn(), and wfProfileOut().

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

Parameters:

$key	string
$value	int

Returns:

Mixed

Reimplemented from BagOStuff.

Definition at line 185 of file MemcachedPeclBagOStuff.php.

References $result, $value, checkResult(), and MemcachedBagOStuff\debugLog().

MemcachedPeclBagOStuff::replace	(	$	key,
		$	value,
		$	exptime = 0
	)

Parameters:

$key	string
$value	int
$exptime

Returns:

Mixed

Reimplemented from MemcachedBagOStuff.

Definition at line 175 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), and MemcachedBagOStuff\debugLog().

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

Parameters:

$key	string
$value
$exptime	int

Returns:

bool

Reimplemented from MemcachedBagOStuff.

Definition at line 125 of file MemcachedPeclBagOStuff.php.

References $value, checkResult(), MemcachedBagOStuff\debugLog(), and set.

---

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

• includes/objectcache/MemcachedPeclBagOStuff.php