File Storage engine for cache. Filestorage is the slowest cache storage to read and write. However, it is good for servers that don't have other storage engine available, or have content which is not performance sensitive.
You can configure a FileEngine cache, using Cache::config()
string
'key'
string
'value'
\SplFileObject|null
Instance of SplFileObject class
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
The default config used unless overridden by runtime configuration
string
Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
bool
True unless FileEngine::__active(); fails
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Does whatever initialization for each group is required and returns the group value
for each of them, this is the token representing each group in the cache key
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
_active()
Determine if cache directory is writable
bool
_clearDirectory(string $path)
Used to clear a directory of matching files.
string
$path The path to search.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_key(mixed $key)
Generates a key for cache backend usage.
If the requested key is valid, the group prefix value and engine prefix are applied. Whitespace in keys will be replaced.
string
$key the key passed over
string
Prefixed key with potentially unsafe characters replaced.
Cake\Cache\InvalidArgumentException
_setKey(string $key, bool $createKey)
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
string
$key The key
bool
$createKey optional Whether the key should be created if it doesn't exists, or not
bool
true if the cache key could be set, false otherwise
add(string $key, mixed $value)
Add a key to the cache if it does not already exist.
Defaults to a non-atomic implementation. Subclasses should prefer atomic implementations.
string
$key Identifier for the data.
mixed
$value Data to be cached.
bool
True if the data was successfully cached, false on failure.
clear()
Delete all values from the cache
bool
True if the cache was successfully cleared, false otherwise
clearGroup(string $group)
Recursively deletes all files under any directory named as $group
string
$group The group to clear.
bool
success
configShallow(mixed $key, mixed $value)
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
decrement(string $key, int $offset)
Not implemented
string
$key The key to decrement
int
$offset optional The number to offset
int|false
LogicException
delete(mixed $key)
Delete a key from the cache
string
$key Identifier for the data
bool
True if the value was successfully deleted, false if it didn't exist or couldn't be removed
deleteMultiple(mixed $keys)
Deletes multiple cache items in a single operation.
iterable
$keys A list of string-based keys to be deleted.
bool
True if the items were successfully removed. False if there was an error.
Cake\Cache\InvalidArgumentException
duration(mixed $ttl)
Convert the various expressions of a TTL value into duration in seconds
\DateInterval|int|null
$ttl The TTL value of this item. If null is sent, the driver's default duration will be used.
int
ensureValidKey(mixed $key)
Ensure the validity of the given cache key.
string
$key Key to check.
Cake\Cache\InvalidArgumentException
ensureValidType(mixed $iterable, string $check)
Ensure the validity of the argument type and cache keys.
iterable
$iterable The iterable to check.
string
$check optional Whether to check keys or values.
Cake\Cache\InvalidArgumentException
get(mixed $key, mixed $default)
Read a key from the cache
string
$key Identifier for the data
mixed
$default optional Default value to return if the key does not exist.
mixed
The cached data, or default value if the data doesn't exist, has expired, or if there was an error fetching it
getConfig(?string $key, mixed $default)
Returns the config.
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getMultiple(mixed $keys, mixed $default)
Obtains multiple cache items by their unique keys.
iterable
$keys A list of keys that can obtained in a single operation.
mixed
$default optional Default value to return for keys that do not exist.
iterable
A list of key value pairs. Cache keys that do not exist or are stale will have $default as value.
Cake\Cache\InvalidArgumentException
groups()
Does whatever initialization for each group is required and returns the group value
for each of them, this is the token representing each group in the cache key
string[]
has(mixed $key)
Determines whether an item is present in the cache.
NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.
string
$key The cache item key.
bool
Cake\Cache\InvalidArgumentException
increment(string $key, int $offset)
Not implemented
string
$key The key to increment
int
$offset optional The number to offset
int|false
LogicException
init(array $config)
Initialize File Cache Engine
Called automatically by the cache frontend.
array
$config optional array of setting for the engine
bool
True if the engine has been successfully initialized, false if not
set(mixed $key, mixed $value, mixed $ttl)
Write data for key into cache
string
$key Identifier for the data
mixed
$value Data to be cached
\DateInterval|int|null
$ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
bool
True on success and false on failure.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
setMultiple(mixed $values, mixed $ttl)
Persists a set of key => value pairs in the cache, with an optional TTL.
iterable
$values A list of key => value pairs for a multiple-set operation.
\DateInterval|int|null
$ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
bool
True on success and false on failure.
Cake\Cache\InvalidArgumentException
warning(string $message)
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
string
$message The warning message.
Instance of SplFileObject class
\SplFileObject|null
Runtime config
array
Whether the config property has already been configured with defaults
bool
The default config used unless overridden by runtime configuration
duration
Specify how long items in this cache configuration last.groups
List of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.lock
Used by FileCache. Should files be locked before writing to them?mask
The mask used for created filespath
Path to where cachefiles should be saved. Defaults to system's temp dir.prefix
Prepended to all entries. Good for when you need to share a keyspace with either another cache config or another application. cache::gc from ever being called automatically.serialize
Should cache objects be serialized first.array
Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
string
True unless FileEngine::__active(); fails
bool
© 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.Engine.FileEngine.html