Class XcacheEngine
Xcache storage engine for cache
- CacheEngine
-
XcacheEngine
Link: Xcache
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Cache/Engine/XcacheEngine.php
Properties summary
-
$settingspublicarraySettings
Inherited Properties
Method Summary
-
_auth() protected
Populates and reverses $_SERVER authentication values Makes necessary changes (and reverting them back) in $_SERVER
-
clear() public
Delete all keys from the cache -
clearGroup() public
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
-
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 -
groups() public
Returns the
group valuefor each of the configured groups If the group initial value was not found, then it initializes the group accordingly. -
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() protected ¶
_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
- Revert changes
clear() public ¶
clear( boolean $check )
Delete all keys from the cache
Parameters
- boolean $check
Returns
True if the cache was successfully cleared, false otherwise
clearGroup() public ¶
clearGroup( string $group )
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Parameters
- string $group
- $groups name of the group to be cleared
Returns
success
Overrides
decrement() public ¶
decrement( string $key , integer $offset = 1 )
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 subtract
Returns
decremented value, false otherwise
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was successfully deleted, false if it didn't exist or couldn't be removed
groups() public ¶
groups( )
Returns the group value for each of the configured groups
If the group initial value was not found, then it initializes
the group accordingly.
Returns
Overrides
increment() public ¶
increment( string $key , integer $offset = 1 )
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
Returns
incremented value, false otherwise
init() public ¶
init( array $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 $settings optional array()
- 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
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 successfully cached, false on failure
Methods inherited from CacheEngine
gc() public ¶
gc( integer $expires = null )
Garbage collection
Permanently remove all expired and deleted data
Parameters
- integer $expires optional null
- [optional] An expires timestamp, invalidating all data before.