XoopsCacheModel Class Reference

Inheritance diagram for XoopsCacheModel:

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

Public Attributes
	$fields = array()
	$model = null
	$settings = array()
Public Attributes inherited from XoopsCacheEngine
	$settings

Detailed Description

Definition at line 53 of file model.php.

Member Function Documentation

XoopsCacheModel::clear

(

)

Delete all keys from the cache

Returns

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

Definition at line 174 of file model.php.

XoopsCacheModel::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 163 of file model.php.

XoopsCacheModel::gc

(

)

Garbage collection. Permanently remove all expired and deleted data

public

Definition at line 108 of file model.php.

XoopsCacheModel::init

(

$settings

)

Initialize the Cache Engine

Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());

Parameters

array

$setting

array of setting for the engine

Returns

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

Definition at line 91 of file model.php.

References $xoopsDB, and XoopsDatabaseFactory\getDatabaseConnection().

Here is the call graph for this function:

XoopsCacheModel::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 144 of file model.php.

References $criteria.

XoopsCacheModel::write	(		$key,
			$data,
			$duration
	)

Write data for key into cache

Parameters

string	$key	Identifier for the data
mixed	$data	Data to be cached
integer	$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 122 of file model.php.

Member Data Documentation

XoopsCacheModel::$fields = array()

Definition at line 79 of file model.php.

XoopsCacheModel::$model = null

Definition at line 71 of file model.php.

XoopsCacheModel::$settings = array()

Definition at line 63 of file model.php.

---

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

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