Class XcacheEngine
Xcache storage engine for cache
- CacheEngine
-
XcacheEngine
Link: Xcache
Copyright: Copyright 2005-2012, Cake Software Foundation, Inc. (http://cakefoundation.org)
License: License (http://www.opensource.org/licenses/mit-license.php)
Location: cache/xcache.php
Properties summary
-
$settingspublicarraySettings
Method Summary
-
__auth() public
Populates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER
-
clear() public
Delete all keys from the cache -
decrement() public
Decrements the value of an integer cached key. If the cache key is not an integer it will be treated as 0
-
delete() public
Delete a key from the cache -
increment() public
Increments the value of an integer cached key If the cache key is not an integer it will be treated as 0
-
init() public
Initialize the Cache Engine -
read() public
Read a key from the cache -
write() public
Write data for key into cache
Method Detail
__auth() public ¶
__auth( boolean $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 $reverse optional false
- changes
clear() public ¶
clear( )
Delete all keys from the cache
Returns
True if the cache was succesfully cleared, false otherwise
Overrides
decrement() public ¶
decrement( string $key , integer $offset = 1 , integer $duration ,… )
Decrements the value of an integer cached key. If the cache key is not an integer it will be treated as 0
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to substract
- integer $duration ,…
- How long to cache the data, in seconds
Returns
decremented value, false otherwise
Overrides
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was succesfully deleted, false if it didn't exist or couldn't be removed
Overrides
increment() public ¶
increment( string $key , integer $offset = 1 , integer $duration ,… )
Increments the value of an integer cached key If the cache key is not an integer it will be treated as 0
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to increment
- integer $duration ,…
- How long to cache the data, in seconds
Returns
incremented value, false otherwise
Overrides
init() public ¶
init( array $settings )
Initialize the Cache Engine
Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
Parameters
- array $settings
- $setting array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Overrides
read() public ¶
read( string $key )
Read a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
Overrides
write() public ¶
write( string $key , mixed $value , integer $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
True if the data was succesfully cached, false on failure