Interface CacheEngineInterface
Interface for cache engines that defines methods
outside of the PSR16 interface that are used by Cache.
Internally Cache uses this interface when calling engine methods.
Direct Implementers
Method Summary
-
add() public
Write data for key into a cache engine if it doesn't exist already. -
clearGroup() public
Clear all values belonging to the named group. -
decrement() public
Decrement a number under the key and return decremented value -
increment() public
Increment a number under the key and return incremented value
Method Detail
add() public ¶
add( string $key , mixed $value )
Write data for key into a cache engine if it doesn't exist already.
Parameters
- string $key
- Identifier for the data.
- mixed $value
- Data to be cached - anything except a resource.
Returns
True if the data was successfully cached, false on failure. Or if the key existed already.
clearGroup() public ¶
clearGroup( string $group )
Clear all values belonging to the named group.
Each implementation needs to decide whether actually delete the keys or just augment a group generation value to achieve the same result.
Parameters
- string $group
- name of the group to be cleared
Returns
decrement() public ¶
decrement( string $key , integer $offset = 1 )
Decrement a number under the key and return decremented value
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to subtract
Returns
New incremented value, false otherwise
increment() public ¶
increment( string $key , integer $offset = 1 )
Increment a number under the key and return incremented value
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to add
Returns
New incremented value, false otherwise