CakePHP
  • Documentation
    • Book
    • API
    • Videos
    • Reporting Security Issues
    • Privacy Policy
    • Logos & Trademarks
  • Business Solutions
  • Swag
  • Road Trip
  • Team
  • Community
    • Community
    • Get Involved
    • Issues (Github)
    • Bakery
    • Featured Resources
    • Training
    • Meetups
    • My CakePHP
    • CakeFest
    • Newsletter
    • Linkedin
    • YouTube
    • Facebook
    • Twitter
    • Mastodon
    • Help & Support
    • Forum
    • Stack Overflow
    • IRC
    • Slack
    • Paid Support
CakePHP

C CakePHP 3.10 Red Velvet API

  • Project:
    • CakePHP
      • CakePHP
      • Authentication
      • Authorization
      • Chronos
      • Elastic Search
      • Queue
  • Version:
    • 3.10
      • 5.2
      • 5.1
      • 5.0
      • 4.6
      • 4.5
      • 4.4
      • 4.3
      • 4.2
      • 4.1
      • 4.0
      • 3.10
      • 3.9
      • 3.8
      • 3.7
      • 3.6
      • 3.5
      • 3.4
      • 3.3
      • 3.2
      • 3.1
      • 3.0
      • 2.10
      • 2.9
      • 2.8
      • 2.7
      • 2.6
      • 2.5
      • 2.4
      • 2.3
      • 2.2
      • 2.1
      • 2.0
      • 1.3
      • 1.2

Namespaces

  • Global
  • Cake
    • Auth
    • Cache
      • Engine
    • Collection
    • Command
    • Console
    • Controller
    • Core
    • Database
    • Datasource
    • Error
    • Event
    • Filesystem
    • Form
    • Http
    • I18n
    • Log
    • Mailer
    • Network
    • ORM
    • Routing
    • Shell
    • TestSuite
    • Utility
    • Validation
    • View

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

Namespace: Cake\Cache\Engine

Property Summary

  • $_File protected
    SplFileObject|null

    Instance of SplFileObject class

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    The default config used unless overridden by runtime configuration

  • $_groupPrefix protected
    string

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

  • $_init protected
    bool

    True 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 value for 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

_active() ¶ protected

_active(): bool

Determine if cache directory is writable

Returns
bool

_clearDirectory() ¶ protected

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

Used 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): void

Deletes a single config key.

Parameters
string $key

Key to delete.

Returns
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters
string|null $key

Key to read.

Returns
mixed

_configWrite() ¶ protected

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

Writes 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
void
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config

_key() ¶ protected

_key(string $key): string

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

Parameters
string $key

the key passed over

Returns
string
Throws
InvalidArgumentException
If key's value is empty

_setKey() ¶ protected

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

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

bool $createKey optional

Whether the key should be created if it doesn't exists, or not

Returns
bool

add() ¶ public

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

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
bool

clear() ¶ public

clear(bool $check): bool

Delete all values from the cache

Parameters
bool $check

Optional - only delete expired cache items

Returns
bool

clearGroup() ¶ public

clearGroup(string $group): bool

Recursively deletes all files under any directory named as $group

Parameters
string $group

The group to clear.

Returns
bool

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $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 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
mixed
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

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 optional

The value to set.

Returns
$this

decrement() ¶ public

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

Not implemented

Parameters
string $key

The key to decrement

int $offset optional

The number to offset

Returns
void
Throws
LogicException

delete() ¶ public

delete(string $key): bool

Delete a key from the cache

Parameters
string $key

Identifier for the data

Returns
bool

deleteMany() ¶ public

deleteMany(array $keys): array

Deletes keys from the cache

Parameters
array $keys

An array of identifiers for the data

Returns
array

gc() ¶ public

gc(int|null $expires = null): bool

Garbage 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
bool

getConfig() ¶ public

getConfig(string|null $key = null, mixed|null $default = null): mixed|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

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|null

getConfigOrFail() ¶ public

getConfigOrFail(string|null $key): mixed

Returns 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
mixed
Throws
InvalidArgumentException

groups() ¶ 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): void

Not implemented

Parameters
string $key

The key to increment

int $offset optional

The number to offset

Returns
void
Throws
LogicException

init() ¶ public

init(array $config = []): bool

Initialize File Cache Engine

Called automatically by the cache frontend.

Parameters
array $config optional

array of setting for the engine

Returns
bool

key() ¶ public

key(string $key): mixed

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

Parameters
string $key

the key passed over

Returns
mixed

read() ¶ public

read(string $key): mixed

Read a key from the cache

Parameters
string $key

Identifier for the data

Returns
mixed

readMany() ¶ public

readMany(array $keys): array

Read multiple keys from the cache

Parameters
array $keys

An array of identifiers for the data

Returns
array

setConfig() ¶ public

setConfig(string|array $key, mixed|null $value = null, bool $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 optional

The value to set.

bool $merge optional

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.

warning() ¶ protected

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.

Returns
void

write() ¶ public

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

Write data for key into cache

Parameters
string $key

Identifier for the data

mixed $data

Data to be cached

Returns
bool

writeMany() ¶ public

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

Property Detail

$_File ¶ protected

Instance of SplFileObject class

Type
SplFileObject|null

$_config ¶ protected

Runtime config

Type
array

$_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

  • 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 ¶ protected

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

Type
string

$_init ¶ protected

True unless FileEngine::__active(); fails

Type
bool
OpenHub
Pingping
Linode
  • Business Solutions
  • Showcase
  • Documentation
  • Book
  • API
  • Videos
  • Reporting Security Issues
  • Privacy Policy
  • Logos & Trademarks
  • Community
  • Get Involved
  • Issues (Github)
  • Bakery
  • Featured Resources
  • Training
  • Meetups
  • My CakePHP
  • CakeFest
  • Newsletter
  • Linkedin
  • YouTube
  • Facebook
  • Twitter
  • Mastodon
  • Help & Support
  • Forum
  • Stack Overflow
  • IRC
  • Slack
  • Paid Support

Generated using CakePHP API Docs