StudipFileCache Class Reference

Inheritance diagram for StudipFileCache:

Collaboration diagram for StudipFileCache:

Public Member Functions
	__construct ($args=array())
	getCacheDir ()
	expire ($key)
	read ($key)
	write ($key, $content, $expire=43200)
	purge ($be_quiet=true)

Constructor & Destructor Documentation

__construct

(

$args = array()

)

without the 'dir' argument the cache path is taken from $CACHING_FILECACHE_PATH or is set to $TMP_PATH/studip_cache throws exception if the directory does not exists or could not be created

Parameters

array

use $args['dir'] to set cache directory

Returns

void

Member Function Documentation

expire

(

$key

)

expire cache item

See Also

StudipCache::expire()

Parameters

string

$key

Returns

void

Implements StudipCache.

Here is the caller graph for this function:

getCacheDir

(

)

get path to cache directory

Returns

string

purge

(

$be_quiet = true

)

purges expired entries from the cache directory

Parameters

bool	echo messages if set to false

Returns

int the number of deleted files

read

(

$key

)

retrieve cache item from filesystem tests first if item is expired

See Also

StudipCache::read()

Parameters

string

a cache key

Returns

string|bool

Implements StudipCache.

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

store data as cache item in filesystem

See Also

StudipCache::write()

Parameters

string	a cache key
string	data to store
int	expiry time in seconds, default 12h

Returns

int|bool the number of bytes that were written to the file, 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:

• lib/classes/StudipFileCache.class.php