Class CheckHttpCacheComponent
Use HTTP caching headers to see if rendering can be skipped.
Checks if the response can be considered different according to the request headers, and caching headers in the response. If the response was not modified, then the controller and view render process is skipped. And the client will get a response with an empty body and a "304 Not Modified" header.
To use this component your controller actions must set either the Last-Modified
or Etag header. Without one of these headers being set this component
will have no effect.
Property Summary
-
$_componentMap protected
array<string, array>A component lookup table used to lazy load component objects.
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default config
-
$_registry protected
Cake\Controller\ComponentRegistryComponent registry class used to lazy load components.
-
$components protected
arrayOther Components this component uses.
Method Summary
-
__construct() public
Constructor
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__get() public
Magic method for lazy loading $components.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
beforeRender() public
Before Render hook
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getController() public
Get the controller this component is bound to.
-
implementedEvents() public
Get the Controller callbacks this Component is interested in.
-
initialize() public
Constructor hook method.
-
log() public
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])Constructor
Parameters
-
Cake\Controller\ComponentRegistry$registry A component registry this component can use to lazy load its components.
-
array<string, mixed>$config optional Array of configuration settings.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Returns an array that can be used to describe the internal state of this object.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): Cake\Controller\Component|nullMagic method for lazy loading $components.
Parameters
-
string$name Name of component to get.
Returns
Cake\Controller\Component|null_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
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.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
beforeRender() ¶ public
beforeRender(Cake\Event\EventInterface $event): voidBefore Render hook
Parameters
-
Cake\Event\EventInterface$event The Controller.beforeRender event.
Returns
voidconfigShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge 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']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisgetConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns the config.
Usage
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');Parameters
-
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.
Returns
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptiongetController() ¶ public
getController(): Cake\Controller\ControllerGet the controller this component is bound to.
Returns
Cake\Controller\ControllerimplementedEvents() ¶ public
implementedEvents(): array<string, mixed>Get the Controller callbacks this Component is interested in.
Uses Conventions to map controller events to standard component callback method names. By defining one of the callback methods a component is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want components to listen to non-standard events.
Returns
array<string, mixed>initialize() ¶ public
initialize(array<string, mixed> $config): voidConstructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
-
array<string, mixed>$config The configuration settings provided to this component.
Returns
voidlog() ¶ public
log(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): boolConvenience method to write a message to Log. See Log::write() for more information on writing to logs.
Parameters
-
string$message Log message.
-
string|int$level optional Error level.
-
array|string$context optional Additional log data relevant to this message.
Returns
boolsetConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
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']);Parameters
-
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.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
Property Detail
$_componentMap ¶ protected
A component lookup table used to lazy load component objects.
Type
array<string, array>$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool$_defaultConfig ¶ protected
Default config
These are merged with user-provided config when the component is used.
Type
array<string, mixed>$_registry ¶ protected
Component registry class used to lazy load components.
Type
Cake\Controller\ComponentRegistry