类 NullEngine

空缓存引擎，所有操作看似有效，但实际上什么也不做。

这在 Cache::disable() 被调用时内部使用。

命名空间: Cake\Cache\Engine

常量

字符串

CHECK_KEY ¶
```
'key'
```
字符串

CHECK_VALUE ¶
```
'value'
```

属性概述

$_config protected

array<string, mixed>

运行时配置
$_configInitialized protected

布尔值

配置属性是否已使用默认值进行配置
$_defaultConfig protected

array<string, mixed>

默认缓存配置在大多数缓存适配器中被覆盖。这些是所有适配器通用的键。如果被覆盖，则不使用此属性。
$_groupPrefix protected

字符串

包含已编译的字符串，其中包含所有组前缀，这些前缀将被追加到此缓存引擎中的每个键之前

方法概述

_configDelete() protected

删除单个配置键。
_configRead() protected

读取配置键。
_configWrite() protected

写入配置键。
_key() protected

生成用于缓存后端使用的键。
add() public

如果缓存中不存在，则将键添加到缓存。
clear() public

从缓存中删除所有键
clearGroup() public

清除属于某个组的所有值。由实现引擎决定是否实际删除键或仅模拟它以达到相同的结果。
configShallow() public

将提供的配置与现有配置合并。与config()（对嵌套键进行递归合并）不同，此方法进行简单的合并。
decrement() public

减少键下的数字并返回减少后的值
delete() public

从缓存中删除键
deleteMultiple() public

作为列表删除多个缓存项
duration() protected

将 TTL 值的各种表达式转换为以秒为单位的持续时间
ensureValidKey() protected

确保给定缓存键的有效性。
ensureValidType() protected

确保参数类型和缓存键的有效性。
get() public

从缓存中获取给定键的值。
getConfig() public

返回配置。
getConfigOrFail() public

返回此特定键的配置。
getMultiple() public

通过它们的唯一键获取多个缓存项。
groups() public

执行每个组所需的任何初始化并返回每个组的组值，这是缓存键中表示每个组的标记
has() public

确定缓存中是否存在项。
increment() public

增加键下的数字并返回增加后的值
init() public

初始化缓存引擎
set() public

将数据持久化到缓存中，通过给定键进行唯一引用，并具有可选的到期 TTL 时间。
setConfig() public

设置配置。
setMultiple() public

将一组键 => 值对持久化到缓存中，并具有可选的 TTL。
warning() protected

如果在操作期间遇到故障，缓存引擎可能会触发警告，如果选项 warnOnWriteFailures 设置为 true。

方法详情

_configDelete() ¶ protected

_configDelete(string $key): void

删除单个配置键。

参数

字符串 $key: 要删除的键。

空

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

_configRead() ¶ protected

_configRead(string|null $key): mixed

读取配置键。

参数

字符串|空 $key: 要读取的键。

混合

_configWrite() ¶ protected

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

写入配置键。

参数

数组<字符串, 混合>|字符串 $key: 要写入的键。
混合 $value: 要写入的值。
字符串|布尔值 $merge 可选: 如果要递归合并，则为 True，如果要简单合并，则为“shallow”，如果要覆盖，则为 False，默认为 False。

空

抛出

Cake\Core\Exception\CakeException
如果尝试覆盖现有配置

_key() ¶ protected

_key(string $key): string

生成用于缓存后端使用的键。

如果请求的键有效，则应用组前缀值和引擎前缀。键中的空格将被替换。

参数

字符串 $key: 传递的键

字符串

抛出

Cake\Cache\Exception\InvalidArgumentException
如果键的值无效。

add() ¶ public

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

如果缓存中不存在，则将键添加到缓存。

默认为非原子实现。子类应该优先考虑原子实现。

参数

字符串 $key: 数据的标识符。
混合 $value: 要缓存的数据。

布尔值

clear() ¶ public

clear(): bool

从缓存中删除所有键

布尔值

clearGroup() ¶ public

clearGroup(string $group): bool

清除属于某个组的所有值。由实现引擎决定是否实际删除键或仅模拟它以达到相同的结果。

每个实现都需要决定是实际删除键还是仅增加组生成值以达到相同的结果。

参数

字符串 $group

布尔值

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

将提供的配置与现有配置合并。与config()（对嵌套键进行递归合并）不同，此方法进行简单的合并。

设置特定值

$this->configShallow('key', $value);

设置嵌套值

$this->configShallow('some.nested.key', $value);

同时更新多个配置设置

$this->configShallow(['one' => 'value', 'another' => 'value']);

参数

数组<字符串, 混合>|字符串 $key: 要设置的键，或完整的配置数组。
混合|空 $value 可选: 要设置的值。

$this

decrement() ¶ public

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

减少键下的数字并返回减少后的值

参数

字符串 $key
整数 $offset 可选

整数|false

delete() ¶ public

delete(string $key): bool

从缓存中删除键

参数

字符串 $key

布尔值

deleteMultiple() ¶ public

deleteMultiple(iterable<string> $keys): bool

作为列表删除多个缓存项

这是一个尽力而为的尝试。如果删除某个项会导致错误，则会忽略该错误，并且会尝试删除所有项。

参数

iterable<string> $keys

布尔值

duration() ¶ protected

duration(DateInterval|int|null $ttl): int

将 TTL 值的各种表达式转换为以秒为单位的持续时间

参数

DateInterval|int|null $ttl: 此项的 TTL 值。如果发送 null，将使用驱动程序的默认持续时间。

int

ensureValidKey() ¶ protected

ensureValidKey(mixed $key): void

确保给定缓存键的有效性。

参数

mixed $key: 要检查的键。

空

抛出

Cake\Cache\Exception\InvalidArgumentException
当键无效时。

ensureValidType() ¶ protected

ensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void

确保参数类型和缓存键的有效性。

参数

iterable $iterable: 要检查的可迭代对象。
string $check optional: 是否检查键或值。

空

抛出

Cake\Cache\Exception\InvalidArgumentException

get() ¶ public

get(string $key, mixed $default = null): mixed

从缓存中获取给定键的值。

参数

字符串 $key
mixed $default optional

混合

getConfig() ¶ public

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

返回配置。

用法

读取整个配置

$this->getConfig();

读取特定值

$this->getConfig('key');

读取嵌套值

$this->getConfig('some.nested.key');

使用默认值读取

$this->getConfig('some-key', 'default-value');

参数

string|null $key optional: 要获取的键或整个配置的 null。
mixed $default optional: 键不存在时的返回值。

混合

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

返回此特定键的配置。

此键的配置值必须存在，绝不能为 null。

参数

字符串 $key: 要获取的键。

混合

抛出

InvalidArgumentException

getMultiple() ¶ public

getMultiple(iterable<string> $keys, mixed $default = null): iterable<string, mixed>

通过它们的唯一键获取多个缓存项。

参数

iterable<string> $keys
mixed $default optional

iterable<string, mixed>

groups() ¶ public

groups(): list<string>

执行每个组所需的任何初始化并返回每个组的组值，这是缓存键中表示每个组的标记

list<string>

has() ¶ public

has(string $key): bool

确定缓存中是否存在项。

注意：建议仅将 has() 用于缓存预热目的，不要在您的实时应用程序操作中用于 get/set，因为此方法容易受到竞争条件的影响，其中您的 has() 将返回 true，并且之后立即，另一个脚本可以将其删除，使您的应用程序状态过时。

参数

字符串 $key: 缓存项键。

布尔值

抛出

Cake\Cache\Exception\InvalidArgumentException
如果 $key 字符串不是合法值。

increment() ¶ public

increment(string $key, int $offset = 1): int|false

增加键下的数字并返回增加后的值

参数

字符串 $key
整数 $offset 可选

整数|false

init() ¶ public

init(array<string, mixed> $config = []): bool

初始化缓存引擎

由缓存前端自动调用。在使用之前将运行时配置与默认值合并。

参数

array<string, mixed> $config optional

布尔值

set() ¶ public

set(string $key, mixed $value, DateInterval|int|null $ttl = null): bool

将数据持久化到缓存中，通过给定键进行唯一引用，并具有可选的到期 TTL 时间。

参数

字符串 $key
混合 $value
DateInterval|int|null $ttl optional

布尔值

setConfig() ¶ public

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

设置配置。

用法

设置特定值

$this->setConfig('key', $value);

设置嵌套值

$this->setConfig('some.nested.key', $value);

同时更新多个配置设置

$this->setConfig(['one' => 'value', 'another' => 'value']);

参数

数组<字符串, 混合>|字符串 $key: 要设置的键，或完整的配置数组。
混合|空 $value 可选: 要设置的值。
bool $merge optional: 是否递归合并或覆盖现有配置，默认为 true。

$this

抛出

Cake\Core\Exception\CakeException
尝试设置无效键时。

setMultiple() ¶ public

setMultiple(iterable $values, DateInterval|int|null $ttl = null): bool

将一组键 => 值对持久化到缓存中，并具有可选的 TTL。

参数

iterable $values
DateInterval|int|null $ttl optional

布尔值

warning() ¶ protected

warning(string $message): void

如果在操作期间遇到故障，缓存引擎可能会触发警告，如果选项 warnOnWriteFailures 设置为 true。

参数

string $message: 警告消息。

空

属性详细

`$_config` ¶ protected

运行时配置

类型

array<string, mixed>

`$_configInitialized` ¶ protected

配置属性是否已使用默认值进行配置

类型

布尔值

`$_defaultConfig` ¶ protected

默认缓存配置在大多数缓存适配器中被覆盖。这些是所有适配器通用的键。如果被覆盖，则不使用此属性。

duration 指定此缓存配置中的项的持续时间。
groups 与存储在此配置中的每个键关联的组或“标签”列表。便于从缓存中删除整个组。
prefix 附加到所有条目的前缀。当您需要与其他缓存配置或其他应用程序共享键空间时很有用。
warnOnWriteFailures 一些引擎（如 ApcuEngine）可能会在写入失败时引发警告。

类型

array<string, mixed>

`$_groupPrefix` ¶ protected

包含已编译的字符串，其中包含所有组前缀，这些前缀将被追加到此缓存引擎中的每个键之前

类型

字符串

命名空间

类 NullEngine

常量

属性概述

方法概述

_configDelete() protected

_configRead() protected

_configWrite() protected

_key() protected

add() public

clear() public

clearGroup() public

configShallow() public

decrement() public

delete() public

deleteMultiple() public

duration() protected

ensureValidKey() protected

ensureValidType() protected

get() public

getConfig() public

getConfigOrFail() public

getMultiple() public

groups() public

has() public

increment() public

init() public

set() public

setConfig() public

setMultiple() public

warning() protected

方法详情

_configDelete() ¶ protected

参数

返回

抛出

_configRead() ¶ protected

参数

返回

_configWrite() ¶ protected

参数

返回

抛出

_key() ¶ protected

参数

返回

抛出

add() ¶ public

参数

返回

clear() ¶ public

返回

clearGroup() ¶ public

参数

返回

configShallow() ¶ public

参数

返回

decrement() ¶ public

参数

返回

delete() ¶ public

参数

返回

deleteMultiple() ¶ public

参数

返回

duration() ¶ protected

参数

返回

ensureValidKey() ¶ protected

参数

返回

抛出

ensureValidType() ¶ protected

参数

返回

抛出

get() ¶ public

参数

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_groupPrefix` ¶ protected