类 ArrayEngine
用于缓存的数组存储引擎。
实际上不是一个持久性缓存引擎。所有数据仅在单个进程持续期间存储在内存中。虽然在生产环境中没有用，但在测试或控制台工具中，您可能不希望与缓存服务器交互的开销，但需要缓存提供的节省工作量的属性，此引擎很有用。
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
布尔值配置属性是否已使用默认值进行配置
-
$_defaultConfig protected
array<string, mixed>默认缓存配置在大多数缓存适配器中被覆盖。这些是所有适配器共有的键。如果覆盖，则不使用此属性。
-
$_groupPrefix protected
字符串包含已编译的字符串，其中包含所有组前缀，这些前缀将附加到此缓存引擎中的每个键之前
-
$data protected
array<string, array>缓存数据。
方法摘要
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
_key() protected
生成用于缓存后端使用的键。
-
add() public
如果缓存中不存在，则添加一个键。
-
clear() public
从缓存中删除所有键。这将清除使用 APC 的每个缓存配置。
-
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
返回每个配置组的
group value如果未找到组初始值，则相应地初始化组。 -
has() public
确定缓存中是否存在项。
-
increment() public
增加缓存的整数键的值
-
init() public
初始化缓存引擎
-
set() public
将键的数据写入缓存
-
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 要缓存的数据。
返回值
布尔值clearGroup() ¶ 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 要设置的值。
返回值
$thisdecrement() ¶ public
decrement(string $key, int $offset = 1): int|false减少缓存的整数键的值
参数
-
string$key 数据的标识符
-
int$offset optional 要减去多少
返回值
int|falsedeleteMultiple() ¶ public
deleteMultiple(iterable<string> $keys): bool删除多个缓存项作为列表
这是一个尽力而为的尝试。如果删除项会导致错误，则会忽略它，并且会尝试删除所有项。
参数
-
iterable<string>$keys 要删除的字符串键列表。
返回值
布尔值抛出
Cake\Cache\Exception\InvalidArgumentException如果 $keys 不是数组或 Traversable，或者如果任何 $keys 不是合法值。
duration() ¶ protected
duration(DateInterval|int|null $ttl): int将 TTL 值的各种表达式转换为以秒为单位的持续时间
参数
-
DateInterval|int|null$ttl 此项的 TTL 值。如果发送 null，则将使用驱动程序的默认持续时间。
返回值
intensureValidKey() ¶ 受保护
ensureValidKey(mixed $key): void确保给定缓存键的有效性。
参数
-
混合$key 要检查的键。
返回值
空抛出
Cake\Cache\Exception\InvalidArgumentException当键无效时。
ensureValidType() ¶ 受保护
ensureValidType(iterable $iterable, string $check = self::CHECK_VALUE): void确保参数类型和缓存键的有效性。
参数
-
可迭代$iterable 要检查的可迭代对象。
-
字符串$check 可选 是否检查键或值。
返回值
空抛出
Cake\Cache\Exception\InvalidArgumentExceptionget() ¶ 公共
get(string $key, mixed $default = null): mixed从缓存中读取一个键
参数
-
string$key 数据的标识符
-
混合$default 可选 如果键不存在，则返回的默认值。
返回值
混合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');参数
-
字符串|空$key 可选 要获取的键，或整个配置的 null。
-
混合$default 可选 键不存在时的返回值。
返回值
混合getConfigOrFail() ¶ 公共
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，不能为 null。
参数
-
string$key 要获取的键。
返回值
混合抛出
InvalidArgumentExceptiongetMultiple() ¶ 公共
getMultiple(iterable<string> $keys, mixed $default = null): iterable<string, mixed>通过其唯一键获取多个缓存项。
参数
-
iterable<string>$keys 可以在单个操作中获取的键列表。
-
混合$default 可选 对不存在的键返回的默认值。
返回值
可迭代<字符串, 混合>抛出
Cake\Cache\Exception\InvalidArgumentException如果 $keys 不是数组或 Traversable，或者如果任何 $keys 不是合法值。
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|falseinit() ¶ 公共
init(array<string, mixed> $config = []): bool初始化缓存引擎
由缓存前端自动调用。在使用之前将运行时配置与默认值合并。
参数
-
数组<字符串, 混合>$config 可选 引擎的参数关联数组
返回值
布尔值set() ¶ 公共
set(string $key, mixed $value, DateInterval|int|null $ttl = null): bool将键的数据写入缓存
参数
-
string$key 数据的标识符
-
mixed$value 要缓存的数据
-
DateInterval|整数|空$ttl 可选 可选。此项目的 TTL 值。如果未发送值，并且驱动程序支持 TTL，则库可能会为其设置默认值，或让驱动程序处理该值。
返回值
布尔值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 要设置的值。
-
布尔$merge 可选 是否递归合并或覆盖现有配置，默认为 true。
返回值
$this抛出
Cake\Core\Exception\CakeException尝试设置无效键时。
setMultiple() ¶ 公共
setMultiple(iterable $values, DateInterval|int|null $ttl = null): bool在缓存中持久化一组键=>值对，并带有可选的 TTL。
参数
-
可迭代$values 用于多集操作的键 => 值对列表。
-
DateInterval|整数|空$ttl 可选 可选。此项目的 TTL 值。如果未发送值，并且驱动程序支持 TTL，则库可能会为其设置默认值，或让驱动程序处理该值。
返回值
布尔值抛出
Cake\Cache\Exception\InvalidArgumentException如果 $values 不是数组或可遍历对象，或者任何 $values 不是合法值。
warning() ¶ 受保护
warning(string $message): void如果在操作期间遇到故障，缓存引擎可能会触发警告，如果选项 warnOnWriteFailures 设置为 true。
参数
-
字符串$message 警告消息。
返回值
空属性详细信息
$_defaultConfig ¶ 受保护
默认缓存配置在大多数缓存适配器中被覆盖。这些是所有适配器共有的键。如果覆盖，则不使用此属性。
持续时间指定此缓存配置中的项持续多长时间。组与存储在此配置中的每个键关联的组或“标签”列表。便于从缓存中删除整个组。前缀附加到所有条目的前缀。当您需要与另一个缓存配置或另一个应用程序共享键空间时，这很有用。warnOnWriteFailures一些引擎，如 ApcuEngine，可能会在写入失败时发出警告。
类型
array<string, mixed>