CacheEngine Class Reference

Inheritance diagram for CacheEngine:

List of all members.

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

---

Detailed Description

Definition at line 409 of file cache.php.

---

Member Function Documentation

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

Reimplemented in FileEngine.

Definition at line 480 of file cache.php.

CacheEngine::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 in ApcEngine, FileEngine, MemcacheEngine, and XcacheEngine.

Definition at line 471 of file cache.php.

CacheEngine::gc

(

)

Garbage collection

Permanently remove all expired and deleted data

public

Reimplemented in FileEngine.

Definition at line 440 of file cache.php.

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

Reimplemented in ApcEngine, FileEngine, MemcacheEngine, and XcacheEngine.

Definition at line 426 of file cache.php.

References $settings, and settings().

CacheEngine::key

(

$

key

)

generates a safe key

Parameters:

string

$key the key passed over

Returns:

mixed string $key or false public

Definition at line 498 of file cache.php.

References underscore().

CacheEngine::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 in ApcEngine, FileEngine, MemcacheEngine, and XcacheEngine.

Definition at line 461 of file cache.php.

References __().

CacheEngine::settings

(

)

Cache Engine settings

Returns:

array settings public

Definition at line 488 of file cache.php.

Referenced by FileEngine::__active(), XcacheEngine::__auth(), FileEngine::__setKey(), FileEngine::clear(), MemcacheEngine::init(), FileEngine::init(), init(), XcacheEngine::read(), MemcacheEngine::read(), FileEngine::read(), ApcEngine::read(), MemcacheEngine::write(), and FileEngine::write().

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

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

Reimplemented in ApcEngine, FileEngine, MemcacheEngine, and XcacheEngine.

Definition at line 451 of file cache.php.

References __().

---

Member Data Documentation

CacheEngine::$settings = array()

Reimplemented in FileEngine, MemcacheEngine, and XcacheEngine.

Definition at line 416 of file cache.php.

Referenced by ApcEngine::init(), and init().

---

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

• libs/cache.php

---