类 CacheEngine

CakePHP 缓存的存储引擎

抽象
命名空间: Cake\Cache

常量

字符串

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

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

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

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

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

从缓存中删除一个键
deleteMultiple() public

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

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

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

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

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

返回配置。
getConfigOrFail() public

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

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

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

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

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

初始化缓存引擎
set() abstract public

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

设置配置。
setMultiple() public

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

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

方法详情

_configDelete() ¶ protected

_configDelete(string $key): void

删除单个配置键。

参数

string $key: 要删除的键。

返回值

空

抛出

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

_configRead() ¶ protected

_configRead(string|null $key): mixed

读取配置键。

参数

string|null $key: 要读取的键。

返回值

混合

_configWrite() ¶ protected

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

写入配置键。

参数

array<string, mixed>|string $key: 要写入的键。
mixed $value: 要写入的值。
string|bool $merge optional: True 表示递归合并，'shallow' 表示简单合并，false 表示覆盖，默认为 false。

返回值

空

抛出

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

_key() ¶ protected

_key(string $key): string

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

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

参数

string $key: 传递的键

返回值

字符串

抛出

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

add() ¶ public

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

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

默认为非原子实现。子类应该优先使用原子实现。

参数

string $key: 数据的标识符。
mixed $value: 要缓存的数据。

返回值

布尔值

clear() ¶ abstract public

clear(): bool

从缓存中删除所有键

返回值

布尔值

clearGroup() ¶ abstract public

clearGroup(string $group): bool

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

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

参数

string $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']);

参数

array<string, mixed>|string $key: 要设置的键，或完整的配置数组。
mixed|null $value optional: 要设置的值。

返回值

$this

decrement() ¶ abstract public

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

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

参数

string $key: 数据的标识符
int $offset optional: 减去多少

返回值

int|false

delete() ¶ 抽象公共

delete(string $key): bool

从缓存中删除一个键

参数

string $key: 数据的标识符

返回值

布尔值

deleteMultiple() ¶ 公共

deleteMultiple(iterable<string> $keys): bool

删除多个缓存项作为列表

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

参数

iterable<string> $keys: 要删除的字符串键列表。

返回值

布尔值

抛出

Cake\Cache\Exception\InvalidArgumentException
如果 $keys 不是数组或 Traversable，或者 $keys 中的任何一个都不是合法值。

duration() ¶ 受保护

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

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

参数

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

返回值

int

ensureValidKey() ¶ 受保护

ensureValidKey(mixed $key): void

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

参数

mixed $key: 要检查的键。

返回值

空

抛出

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

ensureValidType() ¶ 受保护

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

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

参数

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

返回值

空

抛出

Cake\Cache\Exception\InvalidArgumentException

get() ¶ 抽象公共

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

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

参数

string $key: 此项目在缓存中的唯一键。
mixed $default 可选: 如果键不存在，则返回的默认值。

返回值

混合

抛出

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

getConfig() ¶ 公共

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 可选: 要获取的键，或获取整个配置的 null。
mixed $default 可选: 当键不存在时的返回值。

返回值

混合

getConfigOrFail() ¶ 公共

getConfigOrFail(string $key): mixed

返回此特定键的配置。

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

参数

string $key: 要获取的键。

返回值

混合

抛出

InvalidArgumentException

getMultiple() ¶ 公共

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

通过其唯一键获取多个缓存项。

参数

iterable<string> $keys: 可以在一次操作中获取的键列表。
mixed $default 可选: 对不存在的键返回的默认值。

返回值

iterable<string, mixed>

抛出

Cake\Cache\Exception\InvalidArgumentException
如果 $keys 不是数组或 Traversable，或者 $keys 中的任何一个都不是合法值。

groups() ¶ 公共

groups(): list<string>

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

返回值

list<string>

has() ¶ 公共

has(string $key): bool

确定缓存中是否存在某个项。

注意：建议仅将 has() 用于缓存预热类型的目的，不要在您的实时应用程序操作中使用它来进行 get/set，因为此方法容易出现竞争条件，您的 has() 会返回 true，并且在之后，另一个脚本可能会删除它，使您的应用程序状态过时。

参数

string $key: 缓存项目键。

返回值

布尔值

抛出

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

increment() ¶ 抽象公共

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

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

参数

string $key: 数据的标识符
int $offset optional: 要添加的多少

返回值

int|false

init() ¶ 公共

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

初始化缓存引擎

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

参数

array<string, mixed> $config 可选: 引擎的参数关联数组

返回值

布尔值

set() ¶ 抽象公共

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

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

参数

string $key: 要存储的项目的键。
mixed $value: 要存储的项目的 value，必须可序列化。
DateInterval|int|null $ttl 可选: 可选。此项目的 TTL 值。如果未发送任何值，并且驱动程序支持 TTL，则库可能会为其设置一个默认值，或让驱动程序处理它。

返回值

布尔值

抛出

Cake\Cache\Exception\InvalidArgumentException

setConfig() ¶ 公共

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']);

参数

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

返回值

$this

抛出

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

setMultiple() ¶ 公共

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

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

参数

iterable $values: 用于多集操作的键值对列表。
DateInterval|int|null $ttl 可选: 可选。此项目的 TTL 值。如果未发送任何值，并且驱动程序支持 TTL，则库可能会为其设置一个默认值，或让驱动程序处理它。

返回值

布尔值

抛出

Cake\Cache\Exception\InvalidArgumentException
如果 $values 不是数组或 Traversable，或者 $values 中的任何一个都不是合法值。

warning() ¶ 受保护

warning(string $message): void

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

参数

string $message: 警告消息。

返回值

空

属性详细信息

`$_config` ¶ 受保护

运行时配置

类型

array<string, mixed>

`$_configInitialized` ¶ 受保护

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

类型

布尔值

`$_defaultConfig` ¶ 受保护

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

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

类型

array<string, mixed>

`$_groupPrefix` ¶ 受保护

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

类型

字符串

命名空间

类 CacheEngine

常量

属性摘要

方法摘要

_configDelete() protected

_configRead() protected

_configWrite() protected

_key() protected

add() public

clear() abstract public

clearGroup() abstract public

configShallow() public

decrement() abstract public

delete() abstract public

deleteMultiple() public

duration() protected

ensureValidKey() protected

ensureValidType() protected

get() abstract public

getConfig() public

getConfigOrFail() public

getMultiple() public

groups() public

has() public

increment() abstract public

init() public

set() abstract public

setConfig() public

setMultiple() public

warning() protected

方法详情

_configDelete() ¶ protected

参数

返回值

抛出

_configRead() ¶ protected

参数

返回值

_configWrite() ¶ protected

参数

返回值

抛出

_key() ¶ protected

参数

返回值

抛出

add() ¶ public

参数

返回值

clear() ¶ abstract public

返回值

clearGroup() ¶ abstract public

参数

返回值

configShallow() ¶ public

参数

返回值

decrement() ¶ abstract public

参数

返回值

delete() ¶ 抽象 公共

参数

返回值

deleteMultiple() ¶ 公共

参数

返回值

抛出

duration() ¶ 受保护

参数

返回值

ensureValidKey() ¶ 受保护

参数

返回值

抛出

ensureValidType() ¶ 受保护

参数

返回值

抛出

get() ¶ 抽象 公共

delete() ¶ 抽象公共

get() ¶ 抽象公共

increment() ¶ 抽象公共

set() ¶ 抽象公共

`$_config` ¶ 受保护

`$_configInitialized` ¶ 受保护

`$_defaultConfig` ¶ 受保护

`$_groupPrefix` ¶ 受保护