Request object handling for alternative HTTP requests.
This Component checks for requests for different content types like JSON, XML, XMLHttpRequest(AJAX) and configures the response object and view builder accordingly.
It can also check for HTTP caching headers like Last-Modified, If-Modified-Since etc. and return a response accordingly.
arrayA component lookup table used to lazy load component objects.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config
\Cake\Controller\ComponentRegistryComponent registry class used to lazy load components.
string|nullThe template type to use when rendering the given content type.
arrayOther Components this component uses.
string|nullContains the file extension parsed out by the Router
Constructor. Parses the accepted content types accepted by the client using HTTP_ACCEPT
Returns an array that can be used to describe the internal state of this object.
Determines which content types the client accepts. Acceptance is based on the file extension parsed by the Router (if present), and by the HTTP_ACCEPT header. Unlike Cake\Http\ServerRequest::accepts() this method deals entirely with mapped content types.
Checks if the response can be considered different according to the request headers, and the caching response headers. If it was not modified, then the render process is skipped. And the client will get a blank response with a "304 Not Modified" header.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Determines which content-types the client prefers. If no parameters are given, the single content-type that the client most likely prefers is returned. If $type is an array, the first item in the array that the client accepts is returned.
Sets either the view class if one exists or the layout and template path of the view.
Determines the content type of the data the client has sent (i.e. in a POST request)
Sets the response header based on type map index name. This wraps several methods available on Cake\Http\Response. It also allows you to use Content-Type aliases.
The startup method of the RequestHandler enables several automatic behaviors related to the detection of certain properties of the HTTP request, including:
__construct(\Cake\Controller\ComponentRegistry $registry, array $config)
Constructor. Parses the accepted content types accepted by the client using HTTP_ACCEPT
\Cake\Controller\ComponentRegistry $registry ComponentRegistry object.
array $config optional Array of config.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array__get(string $name)
Magic method for lazy loading $components.
string $name Name of component to get.
\Cake\Controller\Component|nullA Component object or null.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array $key Key to write to.
mixed $value Value to write.
bool|string $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception_setExtension(\Cake\Http\ServerRequest $request, \Cake\Http\Response $response)
Set the extension based on the Accept header or URL extension.
Compares the accepted types and configured extensions. If there is one common type, that is assigned as the ext/content type for the response. The type with the highest weight will be set. If the highest weight has more than one type matching the extensions, the order in which extensions are specified determines which type will be set.
If html is one of the preferred types, no content type will be set, this is to avoid issues with browsers that prefer HTML and several other content types.
\Cake\Http\ServerRequest $request The request instance.
\Cake\Http\Response $response The response instance.
accepts(mixed $type)
Determines which content types the client accepts. Acceptance is based on the file extension parsed by the Router (if present), and by the HTTP_ACCEPT header. Unlike Cake\Http\ServerRequest::accepts() this method deals entirely with mapped content types.
Usage:
$this->RequestHandler->accepts(['xml', 'html', 'json']);
Returns true if the client accepts any of the supplied types.
$this->RequestHandler->accepts('xml'); Returns true if the client accepts XML.
string|array|null $type optional Can be null (or no parameter), a string type name, or an array of types
mixedIf null or no parameter is passed, returns an array of content types the client accepts. If a string is passed, returns true if the client accepts it. If an array is passed, returns true if the client accepts one or more elements in the array.
beforeRender(\Cake\Event\EventInterface $event)
Checks if the response can be considered different according to the request headers, and the caching response headers. If it was not modified, then the render process is skipped. And the client will get a blank response with a "304 Not Modified" header.
Accept header. For example, if controller/action.xml is requested, the view path becomes templates/Controller/xml/action.php. Also if controller/action is requested with Accept: application/xml in the headers the view path will become templates/Controller/xml/action.php. Layout and template types will only switch to mime-types recognized by Cake\Http\Response. If you need to declare additional mime-types, you can do so using Cake\Http\Response::type() in your controller's beforeFilter() method.\Cake\Event\EventInterface $event The Controller.beforeRender event.
Cake\Http\Exception\NotFoundExceptionconfigShallow(mixed $key, mixed $value)
Merge 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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisgetConfig(?string $key, mixed $default)
Returns the config.
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'); 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.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetController()
Get the controller this component is bound to.
\Cake\Controller\ControllerThe bound controller.
implementedEvents()
Events supported by this component.
arrayinitialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array $config The configuration settings provided to this component.
log(string $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string $message Log message.
int|string $level optional Error level.
string|array $context optional Additional log data relevant to this message.
boolSuccess of log write.
mapAlias(mixed $alias)
Maps a content type alias back to its mime-type(s)
string|array $alias String alias to convert back into a content type. Or an array of aliases to map.
string|array|nullNull on an undefined alias. String value of the mapped alias type. If an alias maps to more than one content type, the first one will be returned. If an array is provided for $alias, an array of mapped types will be returned.
prefers(mixed $type)
Determines which content-types the client prefers. If no parameters are given, the single content-type that the client most likely prefers is returned. If $type is an array, the first item in the array that the client accepts is returned.
Preference is determined primarily by the file extension parsed by the Router if provided, and secondarily by the list of content-types provided in HTTP_ACCEPT.
string|array|null $type optional An optional array of 'friendly' content-type names, i.e. 'html', 'xml', 'js', etc.
string|bool|nullIf $type is null or not provided, the first content-type in the list, based on preference, is returned. If a single type is provided a boolean will be returned if that type is preferred. If an array of types are provided then the first preferred type is returned. If no type is provided the first preferred type is returned.
renderAs(\Cake\Controller\Controller $controller, string $type, array $options)
Sets either the view class if one exists or the layout and template path of the view.
The names of these are derived from the $type input parameter.
Render the response as an 'ajax' response.
$this->RequestHandler->renderAs($this, 'ajax');
Render the response as an XML file and force the result as a file download.
$this->RequestHandler->renderAs($this, 'xml', ['attachment' => 'myfile.xml'];
\Cake\Controller\Controller $controller A reference to a controller object
string $type Type of response to send (e.g: 'ajax')
array $options optional Array of options to use
requestedWith(mixed $type)
Determines the content type of the data the client has sent (i.e. in a POST request)
string|array|null $type optional Can be null (or no parameter), a string type name, or an array of types
mixedIf a single type is supplied a boolean will be returned. If no type is provided The mapped value of CONTENT_TYPE will be returned. If an array is supplied the first type in the request content type will be returned.
respondAs(mixed $type, array $options)
Sets the response header based on type map index name. This wraps several methods available on Cake\Http\Response. It also allows you to use Content-Type aliases.
string $type Friendly type name, i.e. 'html' or 'xml', or a full content-type, like 'application/x-shockwave'.
array $options optional If $type is a friendly type name that is associated with more than one type of content, $index is used to select which content-type to use.
boolReturns false if the friendly type name given in $type does not exist in the type map, or if the Content-type header has already been set by this method.
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
string|array $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.
$thisCake\Core\Exception\Exceptionstartup(\Cake\Event\EventInterface $event)
The startup method of the RequestHandler enables several automatic behaviors related to the detection of certain properties of the HTTP request, including:
If the XML data is POSTed, the data is parsed into an XML object, which is assigned to the $data property of the controller, which can then be saved to a model object.
\Cake\Event\EventInterface $event The startup event that was fired.
A component lookup table used to lazy load component objects.
arrayRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault config
These are merged with user-provided config when the component is used.
checkHttpCache - Whether to check for HTTP cache. Default true.viewClassMap - Mapping between type and view classes. If undefined JSON, XML, and AJAX will be mapped. Defining any types will omit the defaults.arrayComponent registry class used to lazy load components.
\Cake\Controller\ComponentRegistryThe template type to use when rendering the given content type.
string|nullOther Components this component uses.
arrayContains the file extension parsed out by the Router
string|null
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.1/class-Cake.Controller.Component.RequestHandlerComponent.html