EhcacheBagOStuff Class Reference

Client for the Ehcache RESTful web service - http://ehcache.org/documentation/cache_server.html TODO: Simplify configuration and add to the installer. More...

Inheritance diagram for EhcacheBagOStuff:

Collaboration diagram for EhcacheBagOStuff:

List of all members.

Public Member Functions
	__construct ($params)
	cas ($casToken, $key, $value, $exptime=0)
	delete ($key, $time=0)
	get ($key, &$casToken=null)
	merge ($key, closure $callback, $exptime=0, $attempts=10)
	set ($key, $value, $expiry=0)
Public Attributes
	$cacheName
	$connectTimeout
	$curlOptions
	$curls = array()
	$requestData
	$requestDataPos
	$servers
	$timeout
Protected Member Functions
	attemptPut ($key, $data, $type, $ttl)
	createCache ($key)
	doCacheRequest ($key, $curlOptions=array())
	doItemRequest ($key, $curlOptions=array())
	doRequest ($curl, $url, $curlOptions=array())
	getCacheUrl ($key)
	getCurl ($cacheUrl)
	Get a cURL handle for the given cache URL.

---

Detailed Description

Client for the Ehcache RESTful web service - http://ehcache.org/documentation/cache_server.html TODO: Simplify configuration and add to the installer.

Definition at line 30 of file EhcacheBagOStuff.php.

---

Constructor & Destructor Documentation

EhcacheBagOStuff::__construct

(

$

params

)

Parameters:

$params

array

Exceptions:

MWException

Definition at line 40 of file EhcacheBagOStuff.php.

References $params, array(), and servers.

---

Member Function Documentation

EhcacheBagOStuff::attemptPut	(	$	key,
		$	data,
		$	type,
		$	ttl
	)		[protected]

Parameters:

$key	string
$data
$type
$ttl

Returns:

int

Definition at line 230 of file EhcacheBagOStuff.php.

References $key, $response, array(), and doItemRequest().

Referenced by set().

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

Parameters:

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

Returns:

bool

Reimplemented from BagOStuff.

Definition at line 157 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::createCache

(

$

key

)

[protected]

Parameters:

$key

string

Returns:

bool

Definition at line 258 of file EhcacheBagOStuff.php.

References $key, $response, array(), doCacheRequest(), and wfDebug().

Referenced by set().

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

Parameters:

$key	string
$time	int

Returns:

bool

Reimplemented from BagOStuff.

Definition at line 169 of file EhcacheBagOStuff.php.

References $key, $response, $result, array(), doItemRequest(), wfDebug(), wfProfileIn(), and wfProfileOut().

EhcacheBagOStuff::doCacheRequest	(	$	key,
		$	curlOptions = array()
	)		[protected]

Parameters:

$key	string
$curlOptions	array

Returns:

array|bool|mixed

Definition at line 279 of file EhcacheBagOStuff.php.

References $curlOptions, $key, doRequest(), getCacheUrl(), and getCurl().

Referenced by createCache().

EhcacheBagOStuff::doItemRequest	(	$	key,
		$	curlOptions = array()
	)		[protected]

Parameters:

$key	string
$curlOptions	array

Returns:

array|bool|mixed

Definition at line 290 of file EhcacheBagOStuff.php.

References $curlOptions, $key, doRequest(), getCacheUrl(), and getCurl().

Referenced by attemptPut(), delete(), and get().

EhcacheBagOStuff::doRequest	(	$	curl,
		$	url,
		$	curlOptions = array()
	)		[protected]

Parameters:

$curl
$url	string
$curlOptions	array

Returns:

array|bool|mixed

Exceptions:

MWException

Definition at line 304 of file EhcacheBagOStuff.php.

References $curlOptions, $result, and wfDebug().

Referenced by doCacheRequest(), and doItemRequest().

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

Parameters:

$key	string
$casToken[optional]	mixed

Returns:

bool|mixed

Reimplemented from BagOStuff.

Definition at line 71 of file EhcacheBagOStuff.php.

References $key, $response, doItemRequest(), wfDebug(), wfProfileIn(), and wfProfileOut().

EhcacheBagOStuff::getCacheUrl

(

$

key

)

[protected]

Parameters:

$key

string

Returns:

string

Definition at line 196 of file EhcacheBagOStuff.php.

References $hashes, $key, array(), as, key, and servers.

Referenced by doCacheRequest(), and doItemRequest().

EhcacheBagOStuff::getCurl

(

$

cacheUrl

)

[protected]

Get a cURL handle for the given cache URL.

We cache the handles to allow keepalive.

Definition at line 216 of file EhcacheBagOStuff.php.

Referenced by doCacheRequest(), and doItemRequest().

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

See also:

BagOStuff::merge()

Returns:

bool success

Reimplemented from BagOStuff.

Definition at line 188 of file EhcacheBagOStuff.php.

References $key, and BagOStuff\mergeViaLock().

EhcacheBagOStuff::set	(	$	key,
		$	value,
		$	expiry = 0
	)

Parameters:

$key	string
$value	mixed
$expiry	int

Returns:

bool

Reimplemented from BagOStuff.

Definition at line 113 of file EhcacheBagOStuff.php.

References $blob, $key, $result, $value, attemptPut(), BagOStuff\convertExpiry(), createCache(), wfDebug(), wfProfileIn(), and wfProfileOut().

---

Member Data Documentation

EhcacheBagOStuff::$cacheName

Definition at line 31 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$connectTimeout

Definition at line 31 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$curlOptions

Definition at line 31 of file EhcacheBagOStuff.php.

Referenced by doCacheRequest(), doItemRequest(), and doRequest().

EhcacheBagOStuff::$curls = array()

Definition at line 34 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$requestData

Definition at line 31 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$requestDataPos

Definition at line 31 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$servers

Definition at line 31 of file EhcacheBagOStuff.php.

EhcacheBagOStuff::$timeout

Definition at line 31 of file EhcacheBagOStuff.php.

---

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

• includes/objectcache/EhcacheBagOStuff.php