Stud.IP  4.0
 All Data Structures Namespaces Files Functions Variables Groups
StudipDbCache Class Reference
Inheritance diagram for StudipDbCache:
StudipSystemCache StudipCache

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 (   $arg)

Expire item from the cache.

Parameters
string$arga single key

Implements StudipCache.

flush ( )

Expire all items from the cache.

Implements StudipCache.

static getConfig ( )
static

Return the Vue component name and props that handle configuration.

See Also
StudipCache::getConfig()
Returns
array

Implements StudipSystemCache.

static getDisplayName ( )
static
Returns
string A translateable display name for this cache class.

Implements StudipSystemCache.

getStats ( )

Return statistics.

See Also
StudipCache::getStats()
Returns
array|array[]

Implements StudipSystemCache.

purge ( )

Delete all expired items from the cache.

read (   $arg)

Retrieve item from the server.

Parameters
string$arga 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 (   $name,
  $content,
  $expires = self::DEFAULT_EXPIRATION 
)

Store data at the server.

Parameters
string$namethe item's key.
mixed$contentthe item's content (will be serialized if necessary).
int$expiredthe 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: