Cache provides a consistent interface to Caching in your application. It allows you to use several different Cache engines, without coupling your application to a specific implementation. It also allows you to change out cache storage or configuration without effecting the rest of your application.
You can configure Cache engines in your application's Config/cache.php file. A sample configuration would be:
Cache::config('shared', [
'className' => Cake\Cache\Engine\ApcuEngine::class,
'prefix' => 'my_app_'
]); This would configure an APCu cache engine to the 'shared' alias. You could then read and write to that cache alias by using it for the $config parameter in the various Cache methods.
In general all Cache operations are supported by all cache engines. However, Cache::increment() and Cache::decrement() are not supported by File caching.
There are 7 built-in caching engines:
ApcuEngine - Uses the APCu object cache, one of the fastest caching engines.ArrayEngine - Uses only memory to store all data, not actually a persistent engine. Can be useful in test or CLI environment.FileEngine - Uses simple files to store content. Poor performance, but good for storing large objects, or things that are not IO sensitive. Well suited to development as it is an easy cache to inspect and manually flush.MemcacheEngine - Uses the PECL::Memcache extension and Memcached for storage. Fast reads/writes, and benefits from memcache being distributed.RedisEngine - Uses redis and php-redis extension to store cache data.WincacheEngine - Uses Windows Cache Extension for PHP. Supports wincache 1.1.0 and higher. This engine is recommended to people deploying on windows with IIS.XcacheEngine - Uses the Xcache extension, an alternative to APCu.See Cache engine documentation for expected configuration keys.
arrayConfiguration sets.
string[]An array mapping URL schemes to fully qualified caching engine class names.
boolFlag for tracking whether or not caching is enabled.
arrayGroup to Config mapping
\Cake\Cache\CacheRegistry|nullCache Registry used for creating and using cache adapters.
Returns the Cache Registry instance used for creating and using cache adapters.
This method can be used to define configuration adapters for an application.
Sets the Cache Registry instance used for creating and using cache adapters.
_buildEngine(string $name)
Finds and builds the instance of the required engine class.
string $name Name of the config array that needs an engine instance built
Cake\Cache\InvalidArgumentExceptionRuntimeExceptionadd(string $key, mixed $value, string $config)
Write data for key into a cache engine if it doesn't exist already.
Writing to the active cache config:
Cache::add('cached_data', $data); Writing to a specific cache config:
Cache::add('cached_data', $data, 'long_term'); string $key Identifier for the data.
mixed $value Data to be cached - anything except a resource.
string $config optional Optional string configuration name to write to. Defaults to 'default'.
boolTrue if the data was successfully cached, false on failure. Or if the key existed already.
clear(string $config)
Delete all keys from the cache.
string $config optional name of the configuration to use. Defaults to 'default'
boolTrue if the cache was successfully cleared, false otherwise
clearAll()
Delete all keys from the cache from all configurations.
bool[]Status code. For each configuration, it reports the status of the operation
clearGroup(string $group, string $config)
Delete all keys from the cache belonging to the same group.
string $group name of the group to be cleared
string $config optional name of the configuration to use. Defaults to 'default'
boolTrue if the cache group was successfully cleared, false otherwise
configured()
Returns an array containing the named configurations
string[]Array of configurations.
decrement(string $key, int $offset, string $config)
Decrement a number under the key and return decremented value.
string $key Identifier for the data
int $offset optional How much to subtract
string $config optional Optional string configuration name. Defaults to 'default'
int|falseNew value, or false if the data doesn't exist, is not integer, or if there was an error fetching it
Cake\Cache\InvalidArgumentExceptiondelete(string $key, string $config)
Delete a key from the cache.
Deleting from the active cache configuration.
Cache::delete('my_data'); Deleting from a specific cache configuration.
Cache::delete('my_data', 'long_term'); string $key Identifier for the data
string $config optional name of the configuration to use. Defaults to 'default'
boolTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed
deleteMany(iterable $keys, string $config)
Delete many keys from the cache.
Deleting multiple keys from the active cache configuration.
Cache::deleteMany(['my_data_1', 'my_data_2']);
Deleting from a specific cache configuration.
Cache::deleteMany(['my_data_1', 'my_data_2], 'long_term');
iterable $keys Array or Traversable of cache keys to be deleted
string $config optional name of the configuration to use. Defaults to 'default'
boolTrue on success, false on failure.
Cake\Cache\InvalidArgumentExceptiondisable()
Disable caching.
When disabled all cache operations will return null.
drop(string $config)
Drops a constructed adapter.
If you wish to modify an existing configuration, you should drop it, change configuration and then re-add it.
If the implementing objects supports a $_registry object the named configuration will also be unloaded from the registry.
string $config An existing configuration you wish to remove.
boolSuccess of the removal, returns false when the config does not exist.
enable()
Re-enable caching.
If caching has been disabled with Cache::disable() this method will reverse that effect.
enabled()
Check whether or not caching is enabled.
boolengine(string $config)
Get a cache engine object for the named cache config.
string $config The name of the configured cache backend.
\Psr\SimpleCache\CacheInterface&\Cake\Cache\CacheEngineInterfacegetConfig(string $key)
Reads existing configuration.
string $key The name of the configuration.
mixed|nullConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Reads existing configuration for a specific key.
The config value for this key must exist, it can never be null.
string $key The name of the configuration.
mixedConfiguration data at the named key.
InvalidArgumentExceptiongetDsnClassMap()
Returns the DSN class map for this class.
string[]getRegistry()
Returns the Cache Registry instance used for creating and using cache adapters.
\Cake\Cache\CacheRegistrygroupConfigs(?string $group)
Retrieve group names to config mapping.
Cache::config('daily', ['duration' => '1 day', 'groups' => ['posts']]);
Cache::config('weekly', ['duration' => '1 week', 'groups' => ['posts', 'archive']]);
$configs = Cache::groupConfigs('posts'); $configs will equal to ['posts' => ['daily', 'weekly']] Calling this method will load all the configured engines.
string|null $group optional group name or null to retrieve all group mappings
arraymap of group and all configuration that has the same group
Cake\Cache\InvalidArgumentExceptionincrement(string $key, int $offset, string $config)
Increment a number under the key and return incremented value.
string $key Identifier for the data
int $offset optional How much to add
string $config optional Optional string configuration name. Defaults to 'default'
int|falseNew value, or false if the data doesn't exist, is not integer, or if there was an error fetching it.
Cake\Cache\InvalidArgumentExceptionparseDsn(string $dsn)
Parses a DSN into a valid connection configuration
This method allows setting a DSN using formatting similar to that used by PEAR::DB. The following is an example of its usage:
$dsn = 'mysql://user:pass@localhost/database?'; $config = ConnectionManager::parseDsn($dsn); $dsn = 'Cake\Log\Engine\FileLog://?types=notice,info,debug&file=debug&path=LOGS'; $config = Log::parseDsn($dsn); $dsn = 'smtp://user:secret@localhost:25?timeout=30&client=null&tls=null'; $config = Email::parseDsn($dsn); $dsn = 'file:///?className=\My\Cache\Engine\FileEngine'; $config = Cache::parseDsn($dsn); $dsn = 'File://?prefix=myapp_cake_core_&serialize=true&duration=+2 minutes&path=/tmp/persistent/'; $config = Cache::parseDsn($dsn);
For all classes, the value of scheme is set as the value of both the className unless they have been otherwise specified.
Note that querystring arguments are also parsed and set as values in the returned configuration.
string $dsn The DSN string to convert to a configuration array
arrayThe configuration array to be stored after parsing the DSN
InvalidArgumentExceptionpool(string $config)
Get a SimpleCacheEngine object for the named cache pool.
string $config The name of the configured cache backend.
\Psr\SimpleCache\CacheInterface&\Cake\Cache\CacheEngineInterfaceread(string $key, string $config)
Read a key from the cache.
Reading from the active cache configuration.
Cache::read('my_data'); Reading from a specific cache configuration.
Cache::read('my_data', 'long_term'); string $key Identifier for the data
string $config optional optional name of the configuration to use. Defaults to 'default'
mixedThe cached data, or null if the data doesn't exist, has expired, or if there was an error fetching it.
readMany(iterable $keys, string $config)
Read multiple keys from the cache.
Reading multiple keys from the active cache configuration.
Cache::readMany(['my_data_1', 'my_data_2]);
Reading from a specific cache configuration.
Cache::readMany(['my_data_1', 'my_data_2], 'long_term');
iterable $keys An array or Traversable of keys to fetch from the cache
string $config optional optional name of the configuration to use. Defaults to 'default'
iterableAn array containing, for each of the given $keys, the cached data or false if cached data could not be retrieved.
Cake\Cache\InvalidArgumentExceptionremember(string $key, callable $callable, string $config)
Provides the ability to easily do read-through caching.
When called if the $key is not set in $config, the $callable function will be invoked. The results will then be stored into the cache config at key.
Examples:
Using a Closure to provide data, assume $this is a Table object:
$results = Cache::remember('all_articles', function () {
return $this->find('all');
}); string $key The cache key to read/store data at.
callable $callable The callable that provides data in the case when the cache key is empty. Can be any callable type supported by your PHP.
string $config optional The cache configuration to use for this operation. Defaults to default.
mixedIf the key is found: the cached data, false if the data missing/expired, or an error. If the key is not found: boolean of the success of the write
setConfig(mixed $key, mixed $config)
This method can be used to define configuration adapters for an application.
To change an adapter's configuration at runtime, first drop the adapter and then reconfigure it.
Adapters will not be constructed until the first operation is done.
Assuming that the class' name is Cache the following scenarios are supported:
Setting a cache engine up.
Cache::setConfig('default', $settings); Injecting a constructed adapter in:
Cache::setConfig('default', $instance); Configure multiple adapters at once:
Cache::setConfig($arrayOfConfig);
string|array $key The name of the configuration, or an array of multiple configs.
array|object|null $config optional An array of name => configuration data for adapter.
BadMethodCallExceptionLogicExceptionsetDsnClassMap(array $map)
Updates the DSN class map for this class.
string[] $map Additions/edits to the class map to apply.
setRegistry(\Cake\Cache\CacheRegistry $registry)
Sets the Cache Registry instance used for creating and using cache adapters.
Also allows for injecting of a new registry instance.
\Cake\Cache\CacheRegistry $registry Injectable registry object.
write(string $key, mixed $value, string $config)
Write data for key into cache.
Writing to the active cache config:
Cache::write('cached_data', $data); Writing to a specific cache config:
Cache::write('cached_data', $data, 'long_term'); string $key Identifier for the data
mixed $value Data to be cached - anything except a resource
string $config optional Optional string configuration name to write to. Defaults to 'default'
boolTrue if the data was successfully cached, false on failure
writeMany(iterable $data, string $config)
Write data for many keys into cache.
Writing to the active cache config:
Cache::writeMany(['cached_data_1' => 'data 1', 'cached_data_2' => 'data 2']);
Writing to a specific cache config:
Cache::writeMany(['cached_data_1' => 'data 1', 'cached_data_2' => 'data 2'], 'long_term');
iterable $data An array or Traversable of data to be stored in the cache
string $config optional Optional string configuration name to write to. Defaults to 'default'
boolTrue on success, false on failure
Cake\Cache\InvalidArgumentExceptionConfiguration sets.
arrayAn array mapping URL schemes to fully qualified caching engine class names.
string[]Flag for tracking whether or not caching is enabled.
boolGroup to Config mapping
arrayCache Registry used for creating and using cache adapters.
\Cake\Cache\CacheRegistry|null
© 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/4.1/class-Cake.Cache.Cache.html