Class ApcuEngine

APCu storage engine for cache

Namespace: Cake\Cache\Engine

Properties summary

  • $_compiledGroupNames protected
    string[]

    Contains the compiled group names (prefixed with the global configuration prefix)

  • $_config protected
    array

    Runtime config

  • $_configInitialized protected
    bool

    Whether the config property has already been configured with defaults

  • $_defaultConfig protected
    array

    The default cache configuration is overridden in most cache adapters. These are the keys that are common to all adapters. If overridden, this property is not used.

  • $_groupPrefix protected
    string

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

Method Summary

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

  • add() public

    Write data for key into cache if it doesn't exist already.

  • clear() public

    Delete all keys from the cache. This will clear every cache config using APC.

  • clearGroup() public

    Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.

  • config() public

    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

    Decrements the value of an integer cached key

  • delete() public

    Delete a key from the cache

  • deleteMany() public

    Deletes keys from the cache

  • gc() public

    Garbage collection

  • getConfig() public

    Returns the config.

  • getConfigOrFail() public

    Returns the config for this specific key.

  • groups() public

    Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.

  • increment() public

    Increments the value of an integer cached key

  • init() public

    Initialize the 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

_configDelete() protected 

_configDelete(mixed $key)

Deletes a single config key.

Parameters

string $key

Key to delete.

Throws

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

_configRead() protected 

_configRead(mixed $key)

Reads a config key.

Parameters

string|null $key

Key to read.

Returns

mixed

_configWrite() protected 

_configWrite(mixed $key, mixed $value, mixed $merge)

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.

Throws

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

_key() protected 

_key(mixed $key)

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

Parameters

string $key

the key passed over

Returns

string

Key

Throws

InvalidArgumentException
If key's value is empty

add() public 

add(mixed $key, mixed $value)

Write data for key into cache if it doesn't exist already.

If it already exists, it fails and returns false.

Parameters

string $key

Identifier for the data.

mixed $value

Data to be cached.

Returns

bool

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

Links

https://secure.php.net/manual/en/function.apcu-add.php

clear() public 

clear(mixed $check)

Delete all keys from the cache. This will clear every cache config using APC.

Parameters

bool $check

If true, nothing will be cleared, as entries are removed from APC as they expired. This flag is really only used by FileEngine.

Returns

bool

True Returns true.

Links

https://secure.php.net/manual/en/function.apcu-cache-info.php

https://secure.php.net/manual/en/function.apcu-delete.php

clearGroup() public 

clearGroup(mixed $group)

Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.

Parameters

string $group

The group to clear.

Returns

bool

success

Links

https://secure.php.net/manual/en/function.apcu-inc.php

config() public 

config(mixed $key, mixed $value, mixed $merge)

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

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

configShallow(mixed $key, mixed $value)

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(mixed $key, mixed $offset)

Decrements the value of an integer cached key

Parameters

string $key

Identifier for the data

int $offset optional

How much to subtract

Returns

int|false

New decremented value, false otherwise

Links

https://secure.php.net/manual/en/function.apcu-dec.php

delete() public 

delete(mixed $key)

Delete a key from the cache

Parameters

string $key

Identifier for the data

Returns

bool

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

Links

https://secure.php.net/manual/en/function.apcu-delete.php

deleteMany() public 

deleteMany(mixed $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

gc() public 

gc(mixed $expires)

Garbage collection

Permanently remove all expired and deleted data

Parameters

int|null $expires optional

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

getConfig() public 

getConfig(mixed $key, mixed $default)

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

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

getConfigOrFail() public 

getConfigOrFail(mixed $key)

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

Configuration data at the named key

Throws

InvalidArgumentException

groups() public 

groups()

Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.

Returns

string[]

Links

https://secure.php.net/manual/en/function.apcu-fetch.php

https://secure.php.net/manual/en/function.apcu-store.php

increment() public 

increment(mixed $key, mixed $offset)

Increments the value of an integer cached key

Parameters

string $key

Identifier for the data

int $offset optional

How much to increment

Returns

int|false

New incremented value, false otherwise

Links

https://secure.php.net/manual/en/function.apcu-inc.php

init() public 

init(array $config)

Initialize the Cache Engine

Called automatically by the cache frontend

Parameters

array $config optional

array of setting for the engine

Returns

bool

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

key() public 

key(mixed $key)

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

Parameters

string $key

the key passed over

Returns

string|false

string key or false

read() public 

read(mixed $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

Links

https://secure.php.net/manual/en/function.apcu-fetch.php

readMany() public 

readMany(mixed $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

setConfig() public 

setConfig(mixed $key, mixed $value, mixed $merge)

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(mixed $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.

write() public 

write(mixed $key, mixed $value)

Write data for key into cache

Parameters

string $key

Identifier for the data

mixed $value

Data to be cached

Returns

bool

True if the data was successfully cached, false on failure

Links

https://secure.php.net/manual/en/function.apcu-store.php

writeMany() public 

writeMany(mixed $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

Property Detail

$_compiledGroupNames protected

Contains the compiled group names (prefixed with the global configuration prefix)

Type

string[]

$_config protected

Runtime config

Type

array

$_configInitialized protected

Whether the config property has already been configured with defaults

Type

bool

$_defaultConfig protected

The default cache configuration is overridden in most cache adapters. These are the keys that are common to all adapters. If overridden, this property is not used.

  • 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.
  • prefix Prefix appended 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.
  • warnOnWriteFailures Some engines, such as ApcuEngine, may raise warnings on write failures.

Type

array

$_groupPrefix protected

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

Type

string

© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.9/class-Cake.Cache.Engine.ApcuEngine.html