FileEngine Class Reference

Inheritance diagram for FileEngine:

CacheEngine Object

List of all members.


Public Member Functions

 clear ($check)
 delete ($key)
 gc ()
 init ($settings=array())
 read ($key)
 write ($key, &$data, $duration)

Public Attributes

 $settings = array()

Detailed Description

Definition at line 35 of file file.php.

Member Function Documentation

FileEngine::clear ( $  check  ) 

Delete all values from the cache

Parameters:
boolean $check Optional - only delete expired cache items
Returns:
boolean True if the cache was succesfully cleared, false otherwise public

Reimplemented from CacheEngine.

Definition at line 209 of file file.php.

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

Referenced by gc().

FileEngine::delete ( $  key  ) 

Delete a key from the cache

Parameters:
string $key Identifier for the data
Returns:
boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed public

Reimplemented from CacheEngine.

Definition at line 196 of file file.php.

FileEngine::gc (  ) 

Garbage collection. Permanently remove all expired and deleted data

Returns:
boolean True if garbage collection was succesful, false on failure public

Reimplemented from CacheEngine.

Definition at line 110 of file file.php.

References clear().

FileEngine::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 public

Reimplemented from CacheEngine.

Definition at line 79 of file file.php.

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

FileEngine::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 164 of file file.php.

References CacheEngine::settings().

Referenced by clear().

FileEngine::write ( $  key,
&$  data,
$  duration 
)

Write data for key into cache

Parameters:
string $key Identifier for the data
mixed $data 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 from CacheEngine.

Definition at line 122 of file file.php.

References CacheEngine::settings().

Member Data Documentation

FileEngine::$settings = array()

Reimplemented from CacheEngine.

Definition at line 54 of file file.php.

Referenced by init().

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