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
SplFileObjectInstance 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 is cache directory is writable
-
_clearDirectory() protected
Used to clear a directory of matching files.
-
_configDelete() protected
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_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
Usage
-
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
-
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
-
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): voidDelete 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): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
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): mixedGenerates a safe key, taking account of the configured key prefix
Parameters
-
string$key the key passed over
Returns
mixedThrows
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
booladd() ¶ 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
boolclear() ¶ public
clear(bool $check): boolDelete all values from the cache
Parameters
-
bool$check Optional - only delete expired cache items
Returns
boolclearGroup() ¶ public
clearGroup(string $group): boolRecursively deletes all files under any directory named as $group
Parameters
-
string$group The group to clear.
Returns
boolconfig() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
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
mixedThrows
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->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$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
booldeleteMany() ¶ public
deleteMany(array $keys): arrayDeletes keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arraygc() ¶ 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
boolgroups() ¶ public
groups(): arrayDoes 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
arrayincrement() ¶ 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
boolkey() ¶ public
key(string $key): mixedGenerates a safe key for use with cache engine storage engines.
Parameters
-
string$key the key passed over
Returns
mixedread() ¶ public
read(string $key): mixedRead a key from the cache
Parameters
-
string$key Identifier for the data
Returns
mixedreadMany() ¶ public
readMany(array $keys): arrayRead multiple keys from the cache
Parameters
-
array$keys An array of identifiers for the data
Returns
arraywrite() ¶ 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
boolwriteMany() ¶ 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
arrayProperty 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