APCu storage engine for cache
string 'key'
string 'value'
array<string>Contains the compiled group names (prefixed with the global configuration prefix)
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>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.
stringContains the compiled string with all group prefixes to be prepended to every key in this cache engine
Deletes a single config key.
Reads a config key.
Writes a config key.
Generates a key for cache backend usage.
Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
Delete all keys from the cache. This will clear every cache config using APC.
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Decrements the value of an integer cached key
Delete a key from the cache
Deletes multiple cache items as a list
Convert the various expressions of a TTL value into duration in seconds
Ensure the validity of the given cache key.
Ensure the validity of the argument type and cache keys.
Read a key from the cache
Returns the config.
Returns the config for this specific key.
Obtains multiple cache items by their unique keys.
Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
Determines whether an item is present in the cache.
Increments the value of an integer cached key
Initialize the Cache Engine
Write data for key into cache
Sets the config.
Persists a set of key => value pairs in the cache, with an optional TTL.
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
array<string, mixed>|string $key Key to write to.
mixed $value Value to write.
string|bool $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
voidCake\Core\Exception\CakeException_key(string $key): string
Generates a key for cache backend usage.
If the requested key is valid, the group prefix value and engine prefix are applied. Whitespace in keys will be replaced.
string $key the key passed over
stringCake\Cache\InvalidArgumentExceptionadd(string $key, mixed $value): bool
Write data for key into cache if it doesn't exist already. If it already exists, it fails and returns false.
Defaults to a non-atomic implementation. Subclasses should prefer atomic implementations.
string $key Identifier for the data.
mixed $value Data to be cached.
boolclear(): bool
Delete all keys from the cache. This will clear every cache config using APC.
boolclearGroup(string $group): bool
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Each implementation needs to decide whether actually delete the keys or just augment a group generation value to achieve the same result.
string $group The group to clear.
boolconfigShallow(array<string, mixed>|string $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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisdecrement(string $key, int $offset = 1): int|false
Decrements the value of an integer cached key
string $key Identifier for the data
int $offset optional How much to subtract
int|falsedelete(string $key): bool
Delete a key from the cache
string $key Identifier for the data
booldeleteMultiple(iterable $keys): bool
Deletes multiple cache items as a list
This is a best effort attempt. If deleting an item would create an error it will be ignored, and all items will be attempted.
iterable $keys A list of string-based keys to be deleted.
boolCake\Cache\InvalidArgumentExceptionduration(DateInterval|int|null $ttl): int
Convert the various expressions of a TTL value into duration in seconds
DateInterval|int|null $ttl The TTL value of this item. If null is sent, the driver's default duration will be used.
intensureValidKey(string $key): void
Ensure the validity of the given cache key.
string $key Key to check.
voidCake\Cache\InvalidArgumentExceptionensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void
Ensure the validity of the argument type and cache keys.
iterable $iterable The iterable to check.
string $check optional Whether to check keys or values.
voidCake\Cache\InvalidArgumentExceptionget(string $key, mixed $default = null): mixed
Read a key from the cache
string $key Identifier for the data
mixed $default optional Default value in case the cache misses.
mixedgetConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
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'); string|null $key optional The key to get or null for the whole config.
mixed $default optional The return value when the key does not exist.
mixedgetConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedInvalidArgumentExceptiongetMultiple(iterable $keys, mixed $default = null): iterable
Obtains multiple cache items by their unique keys.
iterable $keys A list of keys that can obtained in a single operation.
mixed $default optional Default value to return for keys that do not exist.
iterableCake\Cache\InvalidArgumentExceptiongroups(): array<string>
Returns the group value for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
array<string>has(string $key): bool
Determines whether an item is present in the cache.
NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.
string $key The cache item key.
boolCake\Cache\InvalidArgumentExceptionincrement(string $key, int $offset = 1): int|false
Increments the value of an integer cached key
string $key Identifier for the data
int $offset optional How much to increment
int|falseinit(array<string, mixed> $config = []): bool
Initialize the Cache Engine
Called automatically by the cache frontend
array<string, mixed> $config optional array of setting for the engine
boolset(string $key, mixed $value, null|intDateInterval $ttl = null): bool
Write data for key into cache
string $key Identifier for the data
mixed $value Data to be cached
null|intDateInterval $ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
boolsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
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']);
array<string, mixed>|string $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.
$thisCake\Core\Exception\CakeExceptionsetMultiple(iterable $values, null|intDateInterval $ttl = null): bool
Persists a set of key => value pairs in the cache, with an optional TTL.
iterable $values A list of key => value pairs for a multiple-set operation.
null|intDateInterval $ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
boolCake\Cache\InvalidArgumentExceptionwarning(string $message): void
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
string $message The warning message.
voidContains the compiled group names (prefixed with the global configuration prefix)
array<string>Runtime config
array<string, mixed>Whether the config property has already been configured with defaults
boolThe 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.warnOnWriteFailures Some engines, such as ApcuEngine, may raise warnings on write failures.array<string, mixed>Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
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/4.4/class-Cake.Cache.Engine.ApcuEngine.html