ElggFileCache Class Reference

Inheritance diagram for ElggFileCache:

List of all members.

Public Member Functions
	__construct ($cache_path, $max_age=0, $max_size=0)
	Set the Elgg cache.
	save ($key, $data)
	Save a key.
	load ($key, $offset=0, $limit=null)
	Load a key.
	delete ($key)
	Invalidate a given key.
	clear ()
	Clear out all the contents of the cache.
	__destruct ()
Protected Member Functions
	create_file ($filename, $rw="rb")
	Create and return a handle to a file.
	sanitise_filename ($filename)
	Create a sanitised filename for the file.

---

Detailed Description

Definition at line 278 of file cache.php.

---

Constructor & Destructor Documentation

ElggFileCache::__construct	(	$	cache_path,
		$	max_age = 0,
		$	max_size = 0
	)

Set the Elgg cache.

Parameters:

	string	$cache_path The cache path.
	int	$max_age Maximum age in seconds, 0 if no limit.
	int	$max_size Maximum size of cache in seconds, 0 if no limit.

Definition at line 286 of file cache.php.

ElggFileCache::__destruct

(

)

Definition at line 398 of file cache.php.

---

Member Function Documentation

ElggFileCache::clear

(

)

Clear out all the contents of the cache.

Reimplemented from ElggCache.

Definition at line 394 of file cache.php.

ElggFileCache::create_file	(	$	filename,
		$	rw = "rb"
	)			[protected]

Create and return a handle to a file.

Parameters:

	string	$filename
	string	$rw

Definition at line 302 of file cache.php.

ElggFileCache::delete

(

$

key

)

Invalidate a given key.

Parameters:

string

$key

Returns:

bool

Reimplemented from ElggCache.

Definition at line 385 of file cache.php.

ElggFileCache::load	(	$	key,
		$	offset = 0,
		$	limit = null
	)

Load a key.

Parameters:

	string	$key
	int	$offset
	int	$limit

Returns:

string

Reimplemented from ElggCache.

Definition at line 362 of file cache.php.

ElggFileCache::sanitise_filename

(

$

filename

)

[protected]

Create a sanitised filename for the file.

Parameters:

string

$filename

Definition at line 329 of file cache.php.

ElggFileCache::save	(	$	key,
		$	data
	)

Save a key.

Parameters:

	string	$key
	string	$data

Returns:

boolean

Reimplemented from ElggCache.

Definition at line 342 of file cache.php.

---

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

• engine/lib/cache.php