XcacheEngine Class Reference

Inheritance diagram for XcacheEngine:

List of all members.

Public Member Functions
	__auth ($reverse=false)
	clear ()
	delete ($key)
	init ($settings)
	read ($key)
	write ($key, &$value, $duration)
Public Attributes
	$settings = array()

---

Detailed Description

Definition at line 33 of file xcache.php.

---

Member Function Documentation

XcacheEngine::__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 127 of file xcache.php.

References env(), and CacheEngine::settings().

Referenced by clear().

XcacheEngine::clear

(

)

Delete all keys from the cache

Returns:

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

Definition at line 108 of file xcache.php.

References __auth().

XcacheEngine::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

Reimplemented from CacheEngine.

Definition at line 99 of file xcache.php.

XcacheEngine::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

Reimplemented from CacheEngine.

Definition at line 53 of file xcache.php.

References $settings, and slug().

XcacheEngine::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

Reimplemented from CacheEngine.

Definition at line 81 of file xcache.php.

References CacheEngine::settings().

XcacheEngine::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

Reimplemented from CacheEngine.

Definition at line 69 of file xcache.php.

---

Member Data Documentation

XcacheEngine::$settings = array()

Reimplemented from CacheEngine.

Definition at line 42 of file xcache.php.

Referenced by init().

---

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

• libs/cache/xcache.php

---