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|nullInstance of SplFileObject class
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>The default config used unless overridden by runtime configuration
stringContains the compiled string with all group prefixes to be prepended to every key in this cache engine
boolTrue unless FileEngine::__active(); fails
Determine if cache directory is writable
Used to clear a directory of matching files.
Deletes a single config key.
Reads a config key.
Writes a config key.
Generates a key for cache backend usage.
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
Add a key to the cache if it does not already exist.
Delete all values from the cache
Recursively deletes all files under any directory named as $group
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Not implemented
Delete a key from the cache
Deletes multiple cache items as a list
Convert the various expressions of a TTL value into duration in seconds
Ensure the validity of the given cache key.
Ensure the validity of the argument type and cache keys.
Read a key from the cache
Returns the config.
Returns the config for this specific key.
Obtains multiple cache items by their unique keys.
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
Determines whether an item is present in the cache.
Not implemented
Initialize File Cache Engine
Write data for key into cache
Sets the config.
Persists a set of key => value pairs in the cache, with an optional TTL.
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
_active(): bool
Determine if cache directory is writable
bool_clearDirectory(string $path): void
Used to clear a directory of matching files.
string $path The path to search.
void_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string $key Key to write to.
mixed $value Value to write.
string|bool $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
voidCake\Core\Exception\CakeException_key(string $key): string
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 string_setKey(string $key, bool $createKey = false): bool
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
booladd(string $key, mixed $value): bool
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.
boolclear(): bool
Delete all values from the cache
boolclearGroup(string $group): bool
Recursively deletes all files under any directory named as $group
Each implementation needs to decide whether actually delete the keys or just augment a group generation value to achieve the same result.
string $group The group to clear.
boolconfigShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisdecrement(string $key, int $offset = 1): int|false
Not implemented
string $key The key to decrement
int $offset optional The number to offset
int|falseLogicExceptiondelete(string $key): bool
Delete a key from the cache
string $key Identifier for the data
booldeleteMultiple(iterable $keys): bool
Deletes multiple cache items as a list
This is a best effort attempt. If deleting an item would create an error it will be ignored, and all items will be attempted.
iterable $keys A list of string-based keys to be deleted.
boolCake\Cache\InvalidArgumentExceptionduration(DateInterval|int|null $ttl): int
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.
intensureValidKey(string $key): void
Ensure the validity of the given cache key.
string $key Key to check.
voidCake\Cache\InvalidArgumentExceptionensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void
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.
voidCake\Cache\InvalidArgumentExceptionget(string $key, mixed $default = null): mixed
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.
mixedgetConfig(string|null $key = null, mixed $default = null): mixed
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.
mixedgetConfigOrFail(string $key): mixed
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.
mixedInvalidArgumentExceptiongetMultiple(iterable $keys, mixed $default = null): iterable
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.
iterableCake\Cache\InvalidArgumentExceptiongroups(): array<string>
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
array<string>has(string $key): bool
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.
boolCake\Cache\InvalidArgumentExceptionincrement(string $key, int $offset = 1): int|false
Not implemented
string $key The key to increment
int $offset optional The number to offset
int|falseLogicExceptioninit(array<string, mixed> $config = []): bool
Initialize File Cache Engine
Called automatically by the cache frontend.
array<string, mixed> $config optional array of setting for the engine
boolset(string $key, mixed $value, null|intDateInterval $ttl = null): bool
Write data for key into cache
string $key Identifier for the data
mixed $value Data to be cached
null|intDateInterval $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.
boolsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
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']);
array<string, mixed>|string $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.
$thisCake\Core\Exception\CakeExceptionsetMultiple(iterable $values, null|intDateInterval $ttl = null): bool
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.
null|intDateInterval $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.
boolCake\Cache\InvalidArgumentExceptionwarning(string $message): void
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
string $message The warning message.
voidInstance of SplFileObject class
SplFileObject|nullRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolThe 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<string, mixed>Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
stringTrue 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.4/class-Cake.Cache.Engine.FileEngine.html