Jose Lorenzo Rodriguez 97c2cd5e45 Better sasl detection in tests 11 years ago
..
Engine 97c2cd5e45 Better sasl detection in tests 11 years ago
Cache.php be845a3a01 Run phpcbf for PSR2 CS fixers 11 years ago
CacheEngine.php 6cf7b52897 Use short array syntax. 11 years ago
CacheRegistry.php be845a3a01 Run phpcbf for PSR2 CS fixers 11 years ago
README.md 6d777f5fbf use short array syntax for docs 11 years ago
composer.json 30b8b6f63b Adding composer.json and Readme to Cache 11 years ago

README.md

CakePHP Caching Library

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\ApcEngine',
    'duration' => '+1 week',
    'prefix' => 'my_app_'
]);

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

You can now read a 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