Class FileEngine
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()
Property Summary
-
$_File protected
SplFileObject|nullInstance of SplFileObject class
-
$_config protected
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayThe default config used unless overridden by runtime configuration
-
$_groupPrefix protected
stringContains the compiled string with all groups prefixes to be prepended to every key in this cache engine
-
$_init protected
boolTrue unless FileEngine::__active(); fails
Method Summary
-
_active() protected
Determine if cache directory is writable
-
_clearDirectory() protected
Used to clear a directory of matching files.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_key() protected
Generates a safe key, taking account of the configured key prefix
-
_setKey() protected
Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
-
add() public
Add a key to the cache if it does not already exist.
-
clear() public
Delete all values from the cache
-
clearGroup() public
Recursively deletes all files under any directory named as $group
-
config() public deprecated
Gets/Sets the config.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
decrement() public
Not implemented
-
delete() public
Delete a key from the cache
-
deleteMany() public
Deletes keys from the cache
-
gc() public
Garbage collection. Permanently remove all expired and deleted data
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
groups() public
Does whatever initialization for each group is required and returns the
group valuefor each of them, this is the token representing each group in the cache key -
increment() public
Not implemented
-
init() public
Initialize File Cache Engine
-
key() public
Generates a safe key for use with cache engine storage engines.
-
read() public
Read a key from the cache
-
readMany() public
Read multiple keys from the cache
-
setConfig() public
Sets the config.
-
warning() protected
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
-
write() public
Write data for key into cache
-
writeMany() public
Write data for many keys into cache
Method Detail
_clearDirectory() ¶ protected
_clearDirectory(string $path, int $now, int $threshold): voidUsed to clear a directory of matching files.
Parameters
-
string$path The path to search.
-
int$now The current timestamp
-
int$threshold Any file not modified after this value will be deleted.
Returns
void_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrites a config key.
Parameters
-
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.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_key() ¶ protected
_key(string $key): stringGenerates a safe key, taking account of the configured key prefix
Parameters
-
string$key the key passed over
Returns
stringKey
Throws
InvalidArgumentExceptionIf key's value is empty
_setKey() ¶ protected
_setKey(string $key, bool $createKey = false): boolSets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.
Parameters
-
string$key The key
-
bool$createKey optional Whether the key should be created if it doesn't exists, or not
Returns
booltrue if the cache key could be set, false otherwise
add() ¶ public
add(string $key, mixed $value): boolAdd a key to the cache if it does not already exist.
Defaults to a non-atomic implementation. Subclasses should prefer atomic implementations.
Parameters
-
string$key Identifier for the data.
-
mixed$value Data to be cached.
Returns
boolTrue if the data was successfully cached, false on failure.
clear() ¶ public
clear(bool $check): boolDelete all values from the cache
Parameters
-
bool$check Optional - only delete expired cache items
Returns
boolTrue if the cache was successfully cleared, false otherwise
clearGroup() ¶ public
clearGroup(string $group): boolRecursively deletes all files under any directory named as $group
Parameters
-
string$group The group to clear.
Returns
boolsuccess
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedGets/Sets the config.
Usage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/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.
Returns
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $key, mixed|null $value = null): $thisMerge 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']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisdecrement() ¶ public
decrement(string $key, int $offset = 1): voidNot implemented
Parameters
-
string$key The key to decrement
-
int$offset optional The number to offset
Returns
voidThrows
LogicExceptiondelete() ¶ public
delete(string $key): boolDelete a key from the cache
Parameters
-
string$key Identifier for the data
Returns
boolTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed
deleteMany() ¶ public
deleteMany(array $keys): arrayDeletes keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arrayFor each provided cache key (given back as the array key) true if the value was successfully deleted, false if it didn't exist or couldn't be removed
gc() ¶ public
gc(int|null $expires = null): boolGarbage collection. Permanently remove all expired and deleted data
Permanently remove all expired and deleted data
Parameters
-
int|null$expires optional [optional] An expires timestamp, invalidating all data before.
Returns
boolTrue if garbage collection was successful, false on failure
getConfig() ¶ public
getConfig(string|null $key = null, mixed|null $default = null): mixed|nullReturns the config.
Usage
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');Parameters
-
string|null$key optional The key to get or null for the whole config.
-
mixed|null$default optional The return value when the key does not exist.
Returns
mixed|nullConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() ¶ public
getConfigOrFail(string|null $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string|null$key The key to get.
Returns
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptiongroups() ¶ public
groups(): 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
Returns
string[]increment() ¶ public
increment(string $key, int $offset = 1): voidNot implemented
Parameters
-
string$key The key to increment
-
int$offset optional The number to offset
Returns
voidThrows
LogicExceptioninit() ¶ public
init(array $config = []): boolInitialize File Cache Engine
Called automatically by the cache frontend.
Parameters
-
array$config optional array of setting for the engine
Returns
boolTrue if the engine has been successfully initialized, false if not
key() ¶ public
key(string $key): mixedGenerates a safe key for use with cache engine storage engines.
Parameters
-
string$key the key passed over
Returns
mixedstring $key or false
read() ¶ public
read(string $key): mixedRead a key from the cache
Parameters
-
string$key Identifier for the data
Returns
mixedThe cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it
readMany() ¶ public
readMany(array $keys): arrayRead multiple keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arrayFor each cache key (given as the array key) the cache data associated or false if the data doesn't exist, has expired, or if there was an error fetching it
setConfig() ¶ public
setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
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']);Parameters
-
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.
Returns
$thisThrows
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
warning() ¶ protected
warning(string $message): voidCache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
Parameters
-
string$message The warning message.
Returns
voidwrite() ¶ public
write(string $key, mixed $data): boolWrite data for key into cache
Parameters
-
string$key Identifier for the data
-
mixed$data Data to be cached
Returns
boolTrue if the data was successfully cached, false on failure
writeMany() ¶ public
writeMany(array $data): arrayWrite data for many keys into cache
Parameters
-
array$data An array of data to be stored in the cache
Returns
arrayof bools for each key provided, true if the data was successfully cached, false on failure
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
The default config used unless overridden by runtime configuration
durationSpecify how long items in this cache configuration last.groupsList of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.isWindowsAutomatically populated with whether the host is windows or notlockUsed by FileCache. Should files be locked before writing to them?maskThe mask used for created filespathPath to where cachefiles should be saved. Defaults to system's temp dir.prefixPrepended to all entries. Good for when you need to share a keyspace with either another cache config or another application.probabilityProbability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.serializeShould cache objects be serialized first.
Type
array$_groupPrefix ¶ protected
Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine
Type
string