CacheEngine Class Reference
Public Member Functions | |
| clear ($check) | |
| delete ($key) | |
| gc () | |
| init ($settings=array()) | |
| read ($key) | |
| settings () | |
| write ($key, &$value, $duration) | |
Public Attributes | |
| $settings = array() | |
Detailed Description
Definition at line 362 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.
| 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.
| CacheEngine::gc | ( | ) |
Garbage collection
Permanently remove all expired and deleted data
public
Reimplemented in FileEngine.
| 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 379 of file cache.php.
References $settings, and settings().
| 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.
| CacheEngine::settings | ( | ) |
Cache Engine settings
- Returns:
- array settings public
Definition at line 438 of file cache.php.
Referenced by FileEngine::clear(), MemcacheEngine::init(), FileEngine::init(), init(), FileEngine::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.
Member Data Documentation
| CacheEngine::$settings = array() |
Reimplemented in FileEngine, MemcacheEngine, and XcacheEngine.
Definition at line 369 of file cache.php.
Referenced by ApcEngine::init(), and init().
The documentation for this class was generated from the following file:
- 1.2.x.x/cake/libs/cache.php
