XoopsCacheEngine Class Reference

Inheritance diagram for XoopsCacheEngine:

Public Member Functions
	clear ($check)
	delete ($key)
	gc ()
	init ($settings=array())
	read ($key)
	settings ()
	write ($key, $value=null, $duration=null)

Public Attributes
	$settings

Detailed Description

Definition at line 394 of file xoopscache.php.

Member Function Documentation

XoopsCacheEngine::clear

(

$check

)

Delete all keys from the cache

Parameters

boolean

$check

if true will check expiration, otherwise delete all

Returns

boolean True if the cache was succesfully cleared, false otherwise public

Definition at line 476 of file xoopscache.php.

XoopsCacheEngine::delete

(

$key

)

Delete a key from the cache

Parameters

string

$key

Identifier for the data

Returns

boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed public

Definition at line 465 of file xoopscache.php.

XoopsCacheEngine::gc

(

)

Garbage collection

Permanently remove all expired and deleted data

public

Definition at line 428 of file xoopscache.php.

XoopsCacheEngine::init

(

$settings = array()

)

Iitialize the cache engine

Called automatically by the cache frontend

Parameters

array

$params

Associative array of parameters for the engine

Returns

boolean True if the engine has been succesfully initialized, false if not public

Definition at line 413 of file xoopscache.php.

References $settings, and settings().

Here is the call graph for this function:

XoopsCacheEngine::read

(

$key

)

Read a key from the cache

Parameters

string

$key

Identifier for the data

Returns

mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it public

Definition at line 453 of file xoopscache.php.

XoopsCacheEngine::settings

(

)

Cache Engine settings

Returns

array settings public

Definition at line 486 of file xoopscache.php.

References $settings.

Referenced by init().

Here is the caller graph for this function:

XoopsCacheEngine::write	(		$key,
			$value = null,
			$duration = null
	)

Write value for a key into cache

Parameters

string	$key	Identifier for the data
mixed	$value	Data to be cached
mixed	$duration	How long to cache the data, in seconds

Returns

boolean True if the data was succesfully cached, false on failure public

Definition at line 441 of file xoopscache.php.

Member Data Documentation

XoopsCacheEngine::$settings

Definition at line 402 of file xoopscache.php.

Referenced by init(), and settings().

---

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

• L:/0xoops/xoops-2.5.6/htdocs/class/cache/xoopscache.php