StudipCache Interface Reference

Inheritance diagram for StudipCache:

Collaboration diagram for StudipCache:

Public Member Functions
	expire ($arg)
	read ($arg)
	write ($name, $content, $expire=43200)

Member Function Documentation

expire

(

$arg

)

Expire item from the cache.

Example:

expires foo

$cache->expire('foo');

Parameters

string

a single key.

Returns

void

Implemented in StudipFileCache, and StudipNullCache.

read

(

$arg

)

Retrieve item from the server.

Example:

reads foo

$foo = $cache->reads('foo');

Parameters

string

a single key

Returns

mixed the previously stored data if an item with such a key exists on the server or FALSE on failure.

Implemented in StudipFileCache, and StudipNullCache.

write	(		$name,
			$content,
			$expire = 43200
	)

Store data at the server.

Parameters

string	the item's key.
string	the item's content.
int	the item's expiry time in seconds. Defaults to 12h.

Returns

mixed returns TRUE on success or FALSE on failure.

Implemented in StudipFileCache, and StudipNullCache.

---

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

• lib/classes/StudipCache.class.php