cakephp/cache

Easy to use Caching library with support for multiple caching backends

5.1.4 2024-11-22 12:03 UTC

Requires

• php: >=8.1
• cakephp/core: ^5.1
• psr/simple-cache: ^2.0 || ^3.0

Provides

• psr/simple-cache-implementation: ^3.0

MIT

• CakePHP Community

• cache
• cakephp
• caching

README

The Cache library provides a Cache service locator for interfacing with multiple caching backends using a simple to use interface.

The caching backends supported are:

• Files
• APC
• Memcached
• Redis
• Wincache
• Xcache

Usage

Caching engines need to be configured with the Cache::config() method.

use Cake\Cache\Cache;

// Using a short name
Cache::config('default', [
    'className' => 'File',
    'duration' => '+1 hours',
    'path' => sys_get_tmp_dir(),
    'prefix' => 'my_app_'
]);

// Using a fully namespaced name.
Cache::config('long', [
    'className' => \Cake\Cache\Engine\ApcuEngine::class,
    'duration' => '+1 week',
    'prefix' => 'my_app_'
]);

// Using a constructed object.
$object = new FileEngine($config);
Cache::config('other', $object);

You can now read and write from the cache:

$data = Cache::remember('my_cache_key', function () {
	return Service::expensiveCall();
});

The code above will try to look for data stored in cache under the my_cache_key, if not found the callback will be executed and the returned data will be cached for future calls.

Documentation

Please make sure you check the official documentation