类 CheckHttpCacheComponent
使用 HTTP 缓存头检查是否可以跳过渲染。
检查响应是否可以根据请求头和响应中的缓存头被认为是不同的。如果响应没有被修改，则会跳过控制器和视图渲染过程。客户端将收到一个带有空主体和 "304 Not Modified" 头部的响应。
要使用此组件，您的控制器操作必须设置 Last-Modified 或 Etag 头。如果没有设置其中一个头，此组件将不起作用。
属性摘要
-
$_config protected
array<string, mixed>运行时配置
-
$_configInitialized protected
bool是否已使用默认值配置了 config 属性
-
$_defaultConfig protected
array<string, mixed>默认配置
-
$_registry protected
Cake\Controller\ComponentRegistry用于延迟加载组件的组件注册类。
-
$componentInstances protected
array<string,Cake\Controller\Component>加载的组件实例。
-
$components protected
array此组件使用的其他组件。
方法摘要
-
__construct() public
构造函数
-
__debugInfo() public
返回一个数组，可用于描述此对象的内部状态。
-
__get() public
用于延迟加载 $components 的魔术方法。
-
_configDelete() protected
删除单个配置键。
-
_configRead() protected
读取配置键。
-
_configWrite() protected
写入配置键。
-
beforeRender() public
渲染前钩子
-
configShallow() public
将提供的配置与现有配置合并。与
config()（对嵌套键进行递归合并）不同，此方法执行简单合并。 -
getConfig() public
返回配置。
-
getConfigOrFail() public
返回此特定键的配置。
-
getController() public
获取此组件绑定的控制器。
-
implementedEvents() public
获取此组件感兴趣的控制器回调。
-
initialize() public
构造函数钩子方法。
-
log() public
写入日志消息的便捷方法。有关写入日志的更多信息，请参阅 Log::write()。
-
setConfig() public
设置配置。
方法详细信息
__construct() ¶ public
__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])构造函数
参数
-
Cake\Controller\ComponentRegistry$registry 此组件可以用来延迟加载其组件的组件注册表。
-
array<string, mixed>$config optional 配置设置数组。
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>返回一个数组，可用于描述此对象的内部状态。
返回
array<string, mixed>__get() ¶ public
__get(string $name): Cake\Controller\Component|null用于延迟加载 $components 的魔术方法。
参数
-
string$name 要获取的组件名称。
返回
Cake\Controller\Component|null_configDelete() ¶ protected
_configDelete(string $key): void删除单个配置键。
参数
-
string$key 要删除的键。
返回
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
_configRead() ¶ protected
_configRead(string|null $key): mixed读取配置键。
参数
-
string|null$key 要读取的键。
返回
mixed_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。
返回
void抛出
Cake\Core\Exception\CakeException如果尝试覆盖现有配置
beforeRender() ¶ public
beforeRender(Cake\Event\EventInterfaceCake\Controller\Controller> $event): void渲染前钩子
参数
-
Cake\Event\EventInterfaceCake\Controller\Controller>$event Controller.beforeRender 事件。
返回
voidconfigShallow() ¶ 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 要设置的值。
返回
$thisgetConfig() ¶ 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 键不存在时的返回值。
返回
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixed返回此特定键的配置。
此键的配置值必须存在，绝不能为 null。
参数
-
string$key 要获取的键。
返回
mixed抛出
InvalidArgumentExceptiongetController() ¶ public
getController(): Cake\Controller\Controller获取此组件绑定的控制器。
返回
Cake\Controller\ControllerimplementedEvents() ¶ public
implementedEvents(): array<string, mixed>获取此组件感兴趣的控制器回调。
使用约定将控制器事件映射到标准组件回调方法名称。通过定义其中一个回调方法，假定组件对相关事件感兴趣。
如果您需要添加非约定事件侦听器，或者希望组件侦听非标准事件，请覆盖此方法。
返回
array<string, mixed>initialize() ¶ public
initialize(array<string, mixed> $config): void构造函数钩子方法。
实现此方法以避免必须覆盖构造函数并调用父类。
参数
-
array<string, mixed>$config 提供给此组件的配置设置。
返回
voidlog() ¶ public
log(Stringable|string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool写入日志消息的便捷方法。有关写入日志的更多信息，请参阅 Log::write()。
参数
-
Stringable|string$message 日志消息。
-
string|int$level optional 错误级别。
-
array|string$context optional 与此消息相关的其他日志数据。
返回
boolsetConfig() ¶ 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']);参数
-
array<string, mixed>|string$key 要设置的键或完整的配置数组。
-
mixed|null$value optional 要设置的值。
-
bool$merge 可选 是否递归合并或覆盖现有配置，默认为 true。
返回
$this抛出
Cake\Core\Exception\CakeException当尝试设置无效键时。