\Cake\Cache\EngineFileEngine

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()

Summary

Methods

Properties

Constants

init()
gc()
write()
writeMany()
read()
readMany()
increment()
decrement()
delete()
clear()
deleteMany()
add()
clearGroup()
groups()
key()
setConfig()
getConfig()
config()
configShallow()

No public properties found

No constants found

_key()
warning()
_configRead()
_configWrite()
_configDelete()
_clearDirectory()
_setKey()
_active()

$_defaultConfig
$_groupPrefix
$_config
$_configInitialized
$_File
$_init

N/A

No private methods found

No private properties found

N/A

File: vendor/cakephp/cakephp/src/Cache/Engine/FileEngine.php
Package: Default
Class hierarchy: \Cake\Cache\CacheEngine

\Cake\Cache\Engine\FileEngine

Properties

$_defaultConfig

$_defaultConfig : array

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.
isWindows Automatically populated with whether the host is windows or not
lock Used by FileCache. Should files be locked before writing to them?
mask The mask used for created files
path 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.
probability Probability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.
serialize Should cache objects be serialized first.

Type

array

$_groupPrefix

$_groupPrefix : string

Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine

Type

string

$_config

$_config : array

Runtime config

Type

array

$_configInitialized

$_configInitialized : boolean

Whether the config property has already been configured with defaults

Type

boolean

$_File

$_File : \SplFileObject|null

Instance of SplFileObject class

Type

\SplFileObject|null

$_init

$_init : boolean

True unless FileEngine::__active(); fails

Type

boolean

Methods

init()

init(array  $config = array()) : boolean

Initialize File Cache Engine

Called automatically by the cache frontend.

Parameters

array

$config

array of setting for the engine

Returns

boolean —

True if the engine has been successfully initialized, false if not

gc()

gc(integer|null  $expires = null) : boolean

Garbage collection. Permanently remove all expired and deleted data

Permanently remove all expired and deleted data

Parameters

integer|null

$expires

[optional] An expires timestamp, invalidating all data before.

Returns

boolean —

True if garbage collection was successful, false on failure

write()

write(string  $key, mixed  $data) : boolean

Write data for key into cache

Parameters

string	$key	Identifier for the data
mixed	$data	Data to be cached

Returns

boolean —

True if the data was successfully cached, false on failure

writeMany()

writeMany(array  $data) : array

Write data for many keys into cache

Parameters

array

$data

An array of data to be stored in the cache

Returns

array —

of bools for each key provided, true if the data was successfully cached, false on failure

read()

read(string  $key) : mixed

Read a key from the cache

Parameters

string

$key

Identifier for the data

Returns

mixed —

The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it

readMany()

readMany(array  $keys) : array

Read multiple keys from the cache

Parameters

array

$keys

An array of identifiers for the data

Returns

array —

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

increment()

increment(string  $key, integer  $offset = 1) : void

Not implemented

Parameters

string	$key	The key to increment
integer	$offset	The number to offset

Throws

\LogicException

decrement()

decrement(string  $key, integer  $offset = 1) : void

Not implemented

Parameters

string	$key	The key to decrement
integer	$offset	The number to offset

Throws

\LogicException

delete()

delete(string  $key) : boolean

Delete a key from the cache

Parameters

string

$key

Identifier for the data

Returns

boolean —

True if the value was successfully deleted, false if it didn't exist or couldn't be removed

clear()

clear(boolean  $check) : boolean

Delete all values from the cache

Parameters

boolean

$check

Optional - only delete expired cache items

Returns

boolean —

True if the cache was successfully cleared, false otherwise

deleteMany()

deleteMany(array  $keys) : array

Deletes keys from the cache

Parameters

array

$keys

An array of identifiers for the data

Returns

array —

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

add()

add(string  $key, mixed  $value) : boolean

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

boolean —

True if the data was successfully cached, false on failure.

clearGroup()

clearGroup(string  $group) : boolean

Recursively deletes all files under any directory named as $group

Parameters

string

$group

The group to clear.

Returns

boolean —

success

groups()

groups() : array

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

array

key()

key(string  $key) : mixed

Generates a safe key for use with cache engine storage engines.

Parameters

string

$key

the key passed over

Returns

mixed —

string $key or false

setConfig()

setConfig(string|array  $key, mixed|null  $value = null, boolean  $merge = true) : $this

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	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception: When trying to set a key that is invalid.

Returns

$this

getConfig()

getConfig(string|null  $key = null, mixed  $default = null) : mixed

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	The key to get or null for the whole config.
mixed	$default	The return value when the key does not exist.

Returns

mixed —

Config value being read.

config()

config(string|array|null  $key = null, mixed|null  $value = null, boolean  $merge = true) : mixed

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']);

Parameters

string\|array\|null	$key	The key to get/set, or a complete array of configs.
mixed\|null	$value	The value to set.
boolean	$merge	Whether to recursively merge or overwrite existing config, defaults to true.

Throws

\Cake\Core\Exception\Exception: When trying to set a key that is invalid.

Returns

mixed —

Config value being read, or the object itself on write operations.

configShallow()

configShallow(string|array  $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']);

Parameters

string\|array	$key	The key to set, or a complete array of configs.
mixed\|null	$value	The value to set.

Returns

$this

_key()

_key(string  $key) : mixed

Generates a safe key, taking account of the configured key prefix

Parameters

string

$key

the key passed over

Throws

\InvalidArgumentException: If key's value is empty

Returns

mixed —

string $key or false

warning()

warning(string  $message) : void

Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.

Parameters

string

$message

The warning message.

_configRead()

_configRead(string|null  $key) : mixed

Reads a config key.

Parameters

string|null

$key

Key to read.

Returns

mixed

_configWrite()

_configWrite(string|array  $key, mixed  $value, boolean|string  $merge = false) : void

Writes a config key.

Parameters

string\|array	$key	Key to write to.
mixed	$value	Value to write.
boolean\|string	$merge	True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.

Throws

\Cake\Core\Exception\Exception: if attempting to clobber existing config

_configDelete()

_configDelete(string  $key) : void

Deletes a single config key.

Parameters

string

$key

Key to delete.

Throws

\Cake\Core\Exception\Exception: if attempting to clobber existing config

_clearDirectory()

_clearDirectory(string  $path, integer  $now, integer  $threshold) : void

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()

_setKey(string  $key, boolean  $createKey = false) : boolean

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	Whether the key should be created if it doesn't exists, or not

Returns

boolean —

true if the cache key could be set, false otherwise

_active()

_active() : boolean

Determine if cache directory is writable

Returns

boolean