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.

Namespace: Cake\Cache

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(mixed $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

bool

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

clearGroup() public 

clearGroup(mixed $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

bool

decrement() public 

decrement(mixed $key, mixed $offset)

Decrement a number under the key and return decremented value

Parameters

string $key

Identifier for the data

int $offset optional

How much to subtract

Returns

int|false

New incremented value, false otherwise

increment() public 

increment(mixed $key, mixed $offset)

Increment a number under the key and return incremented value

Parameters

string $key

Identifier for the data

int $offset optional

How much to add

Returns

int|false

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.9/interface-Cake.Cache.CacheEngineInterface.html