StudipDbCache Class Reference

Inheritance diagram for StudipDbCache:

Public Member Functions
	expire ($arg)
	flush ()
	purge ()
	read ($arg)
	write ($name, $content, $expires=self::DEFAULT_EXPIRATION)
	getStats ()

Static Public Member Functions
static	getDisplayName ()
static	getConfig ()

Additional Inherited Members
Data Fields inherited from StudipCache
const	DEFAULT_EXPIRATION = 12 * 60 * 60

Member Function Documentation

expire()

expire

(

$arg

)

Expire item from the cache.

Parameters

string

$arg

a single key

Implements StudipCache.

flush()

flush

(

)

Expire all items from the cache.

Implements StudipCache.

getConfig()

static getConfig ( )

static

Return the Vue component name and props that handle configuration.

See also

StudipCache::getConfig()

Returns

array

Implements StudipCache.

getDisplayName()

static getDisplayName ( )

static

Returns

string A translateable display name for this cache class.

Implements StudipCache.

getStats()

getStats

(

)

Return statistics.

See also

StudipCache::getStats()

Returns

array|array[]

Implements StudipCache.

purge()

purge

(

)

Delete all expired items from the cache.

read()

read

(

$arg

)

Retrieve item from the server.

Parameters

string

$arg

a single key

Returns

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

Implements StudipCache.

write()

write	(		$name,
			$content,
			$expires = self::DEFAULT_EXPIRATION
	)

Store data at the server.

Parameters

string	$name	the item's key.
mixed	$content	the item's content (will be serialized if necessary).
int	$expired	the item's expiry time in seconds. Optional, defaults to 12h.

Returns

bool returns TRUE on success or FALSE on failure.

Implements StudipCache.

---

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

• lib/classes/StudipDbCache.class.php