ApcEngine Class Reference

Inheritance diagram for ApcEngine:

List of all members.

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

---

Detailed Description

Definition at line 32 of file apc.php.

---

Member Function Documentation

ApcEngine::clear

(

)

Delete all keys from the cache

Returns:

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

Definition at line 93 of file apc.php.

ApcEngine::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 84 of file apc.php.

ApcEngine::init

(

$

settings = array()

)

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

See also:

CacheEngine::__defaults public

Reimplemented from CacheEngine.

Definition at line 44 of file apc.php.

References CacheEngine::$settings, and slug().

ApcEngine::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 69 of file apc.php.

References CacheEngine::settings().

ApcEngine::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 57 of file apc.php.

---

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

• libs/cache/apc.php

---