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()
- Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait
-
Cake\Cache\Engine\FileEngine
Properties summary
-
$_FileprotectedSplFileObject|nullInstance of SplFileObject class -
$_defaultConfigprotectedarrayThe default config used unless overridden by runtime configuration -
$_initprotectedbooleanTrue unless FileEngine::__active(); fails
Inherited Properties
Method Summary
-
_active() protected
Determine if cache directory is writable -
_clearDirectory() protected
Used to clear a directory of matching files. -
_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.
-
clear() public
Delete all values from the cache -
clearGroup() public
Recursively deletes all files under any directory named as $group -
decrement() public
Not implemented -
delete() public
Delete a key from the cache -
gc() public
Garbage collection. Permanently remove all expired and deleted data -
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 -
write() public
Write data for key into cache
Method Detail
_clearDirectory() protected ¶
_clearDirectory( string $path , integer $now , integer $threshold )
Used to clear a directory of matching files.
Parameters
- string $path
- The path to search.
- integer $now
- The current timestamp
- integer $threshold
- Any file not modified after this value will be deleted.
_setKey() protected ¶
_setKey( string $key , boolean $createKey = false )
Sets 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
- boolean $createKey optional false
- Whether the key should be created if it doesn't exists, or not
Returns
true if the cache key could be set, false otherwise
clear() public ¶
clear( boolean $check )
Delete all values from the cache
Parameters
- boolean $check
- Optional - only delete expired cache items
Returns
True if the cache was successfully cleared, false otherwise
clearGroup() public ¶
clearGroup( string $group )
Recursively deletes all files under any directory named as $group
Parameters
- string $group
- The group to clear.
Returns
success
Overrides
decrement() public ¶
decrement( string $key , integer $offset = 1 )
Not implemented
Parameters
- string $key
- The key to decrement
- integer $offset optional 1
- The number to offset
Throws
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was successfully deleted, false if it didn't exist or couldn't be removed
gc() public ¶
gc( integer|null $expires = null )
Garbage collection. Permanently remove all expired and deleted data
Parameters
- integer|null $expires optional null
- [optional] An expires timestamp, invalidating all data before.
Returns
True if garbage collection was successful, false on failure
Overrides
increment() public ¶
increment( string $key , integer $offset = 1 )
Not implemented
Parameters
- string $key
- The key to increment
- integer $offset optional 1
- The number to offset
Throws
init() public ¶
init( array $config = [] )
Initialize File Cache Engine
Called automatically by the cache frontend.
Parameters
- array $config optional []
- array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Overrides
key() public ¶
key( string $key )
Generates a safe key for use with cache engine storage engines.
Parameters
- string $key
- the key passed over
Returns
string $key or false
Overrides
Methods inherited from Cake\Cache\CacheEngine
_key() protected ¶
_key( string $key )
Generates a safe key, taking account of the configured key prefix
Parameters
- string $key
- the key passed over
Returns
Key
Throws
If key's value is empty
add() public ¶
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.
Parameters
- string $key
- Identifier for the data.
- mixed $value
- Data to be cached.
Returns
True if the data was successfully cached, false on failure.
deleteMany() public ¶
deleteMany( array $keys )
Deletes keys from the cache
Parameters
- array $keys
- An array of identifiers for the data
Returns
For 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
groups() public ¶
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
Returns
readMany() public ¶
readMany( array $keys )
Read multiple keys from the cache
Parameters
- array $keys
- An array of identifiers for the data
Returns
For 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
warning() protected ¶
warning( string $message )
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
Parameters
- string $message
- The warning message.
writeMany() public ¶
writeMany( array $data )
Write data for many keys into cache
Parameters
- array $data
- An array of data to be stored in the cache
Returns
of bools for each key provided, true if the data was successfully cached, false on failure
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public deprecated ¶
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Gets/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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value = null )
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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key = null , mixed $default = null )
Returns 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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Configuration data at the named key or null if the key does not exist.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Sets 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 null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
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.
[
'duration' => 3600,
'groups' => [],
'isWindows' => false,
'lock' => true,
'mask' => 0664,
'path' => null,
'prefix' => 'cake_',
'probability' => 100,
'serialize' => true
]