_active()source protected

_active( )

Determine if cache directory is writable

Returns

boolean

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

boolean
true if the cache key could be set, false otherwise

clear()source public

clear( boolean $check )

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

clearGroup()source public

clearGroup( string $group )

Recursively deletes all files under any directory named as $group

Parameters

string $group

The group to clear.

Returns

boolean
success

Overrides

Cake\Cache\CacheEngine::clearGroup()

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

LogicException

delete()source public

delete( string $key )

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

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

boolean
True if garbage collection was successful, false on failure

Overrides

Cake\Cache\CacheEngine::gc()

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

LogicException

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

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

Overrides

Cake\Cache\CacheEngine::init()

key()source public

key( string $key )

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

Parameters

string $key

the key passed over

Returns

mixed
string $key or false

Overrides

Cake\Cache\CacheEngine::key()

read()source public

read( string $key )

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

write()source public

write( string $key , mixed $data )

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

_key()source protected

_key( string $key )

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

Parameters

string $key

the key passed over

Returns

mixed
string $key or false

Throws

InvalidArgumentException
If key's value is empty

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

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

deleteMany()source public

deleteMany( array $keys )

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

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

array

readMany()source public

readMany( array $keys )

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

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

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

_configDelete()source protected

_configDelete( string $key )

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead()source protected

_configRead( string|null $key )

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

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

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

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

3.4.0 use setConfig()/getConfig() instead.

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

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

Throws

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

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

mixed
Configuration data at the named key or null if the key does not exist.

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

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

[
    'duration' => 3600,
    'groups' => [],
    'isWindows' => false,
    'lock' => true,
    'mask' => 0664,
    'path' => null,
    'prefix' => 'cake_',
    'probability' => 100,
    'serialize' => true
]

true