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

Namespace: Cake\Cache
Since: 3.7.0
Location: Cache/CacheEngineInterface.php

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

add( string $key , mixed $value )

Write data for key into a cache engine if it doesn't exist already.

boolean

True if the data was successfully cached, false on failure. Or if the key existed already.

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.

boolean

decrement( string $key , integer $offset = 1 )

Decrement a number under the key and return decremented value

boolean|integer
New incremented value, false otherwise

increment( string $key , integer $offset = 1 )

Increment a number under the key and return incremented value

boolean|integer
New incremented value, false otherwise

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.8/class-Cake.Cache.CacheEngineInterface.html