XoopsCacheXcache Class Reference

Inheritance diagram for XoopsCacheXcache:

Public Member Functions
	__auth ($reverse=false)
	clear ()
	delete ($key)
	init ($settings)
	read ($key)
	write ($key, &$value, $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
	$settings = array()
Public Attributes inherited from XoopsCacheEngine
	$settings

Detailed Description

Definition at line 54 of file xcache.php.

Member Function Documentation

XoopsCacheXcache::__auth

(

$reverse = false

)

Populates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER

This has to be done because xcache_clear_cache() needs to pass Basic Http Auth (see xcache.admin configuration settings)

Parameters

boolean

$ Revert changes private

Definition at line 155 of file xcache.php.

References $_SERVER.

XoopsCacheXcache::clear

(

)

Delete all keys from the cache

Returns

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

Definition at line 131 of file xcache.php.

References $i, and $result.

XoopsCacheXcache::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 120 of file xcache.php.

XoopsCacheXcache::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 76 of file xcache.php.

XoopsCacheXcache::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 105 of file xcache.php.

XoopsCacheXcache::write	(		$key,
		&	$value,
			$duration
	)

Write data for key into cache

Parameters

string	$key	Identifier for the data
mixed	$value	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 93 of file xcache.php.

Member Data Documentation

XoopsCacheXcache::$settings = array()

Definition at line 64 of file xcache.php.

---

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

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