interfaceCache Interface Reference

Inheritance diagram for interfaceCache:

Public Member Functions
	disconnect ()
	getFromCache ($key)
	putInCache ($key, $value, $ttl=0)
	removeFromCache ($key)
	updateInCache ($key, $value, $ttl=0)

---

Member Function Documentation

disconnect

(

)

Disconnect from remote cache store

Returns:

boolean

Implemented in classCacheDiskcache, classCacheMemcache, classCacheXcache, classCacheApc, classCacheWincache, and classCacheEaccelerator.

getFromCache

(

$

key

)

Retrieve a value from remote cache store

Parameters:

string

Cache unique key

Returns:

mixed

Implemented in classCacheMemcache, classCacheDiskcache, classCacheEaccelerator, classCacheXcache, classCacheApc, and classCacheWincache.

putInCache	(	$	key,
		$	value,
		$	ttl = 0
	)

Put data into remote cache store

Parameters:

string	Cache unique key
string	Cache value to add
integer	[Optional] Time to live

Returns:

boolean

Implemented in classCacheMemcache, classCacheEaccelerator, classCacheDiskcache, classCacheApc, classCacheWincache, and classCacheXcache.

removeFromCache

(

$

key

)

Remove a value in the remote cache store

Parameters:

string

Cache unique key

Returns:

boolean

Implemented in classCacheDiskcache, classCacheMemcache, classCacheEaccelerator, classCacheXcache, classCacheApc, and classCacheWincache.

updateInCache	(	$	key,
		$	value,
		$	ttl = 0
	)

Update value in remote cache store

Parameters:

string	Cache unique key
string	Cache value to set
integer	[Optional] Time to live

Returns:

boolean

Implemented in classCacheDiskcache, classCacheMemcache, classCacheEaccelerator, classCacheXcache, classCacheApc, and classCacheWincache.

---

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

• ips_kernel/interfaces/interfaceCache.php