Stud.IP  4.2 Revision
StudipDbCache Class Reference
Inheritance diagram for StudipDbCache:
Inheritance graph
Collaboration diagram for StudipDbCache:
Collaboration graph

Public Member Functions

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

Additional Inherited Members

- Data Fields inherited from StudipCache
const DEFAULT_EXPIRATION = 43200
 

Member Function Documentation

◆ expire()

expire (   $arg)

Expire item from the cache.

Parameters
string$arga single key

Implements StudipCache.

Here is the call graph for this function:

◆ flush()

flush ( )

Expire all items from the cache.

Implements StudipCache.

Here is the call graph for this function:

◆ purge()

purge ( )

Delete all expired items from the cache.

Here is the call graph for this function:

◆ read()

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.

Here is the call graph for this function:

◆ write()

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.

Here is the call graph for this function:

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