RequestHandlerComponent (class)
Class RequestHandlerComponent
Request object for handling alternative HTTP requests
Alternative HTTP requests can come from wireless units like mobile phones, palmtop computers, and the like. These units have no use for AJAX requests, and this Component can tell how Cake should respond to the different needs of a handheld computer and a desktop machine.
- Cake\Controller\Component implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait, Cake\Log\LogTrait
-
Cake\Controller\Component\RequestHandlerComponent
Link: http://book.cakephp.org/3.0/en/controllers/components/request-handling.html
Located at Controller/Component/RequestHandlerComponent.php
Method Detail
__constructsource public
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )
Constructor. Parses the accepted content types accepted by the client using HTTP_ACCEPT
Parameters
-
Cake\Controller\ComponentRegistry
$registry
- ComponentRegistry object.
- array
$config
optional [] - Array of config.
Overrides
Cake\Controller\Component::__construct()
_setExtensionsource protected
_setExtension( Cake\Network\Request $request , Cake\Network\Response $response )
Set the extension based on the accept headers. 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.
Parameters
-
Cake\Network\Request
$request
- The request instance.
-
Cake\Network\Response
$response
- The response instance.
acceptssource public
accepts( string|array $type null )
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\Network\Request::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.
Parameters
- string|array
$type
optional null - Can be null (or no parameter), a string type name, or an array of types
Returns
mixed
If 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.
addInputTypesource public
addInputType( string $type , array $handler )
Add a new mapped input type. Mapped input types are automatically converted by RequestHandlerComponent during the startup() callback.
Deprecated
3.1.0 Use config('addInputType', ...) instead.Parameters
- string
$type
- The type alias being converted, ie. json
- array
$handler
- The handler array for the type. The first index should be the handling callback, all other arguments should be additional parameters for the handler.
Throws
Cake\Core\Exception\Exception
\Cake\Core\Exception\Exception
beforeRedirectsource public
beforeRedirect( Cake\Event\Event $event , string|array $url , Cake\Network\Response $response )
Handles (fakes) redirects for AJAX requests using requestAction()
Parameters
-
Cake\Event\Event
$event
- The Controller.beforeRedirect event.
- string|array
$url
- A string or array containing the redirect location
-
Cake\Network\Response
$response
- The response object.
Returns
Cake\Network\Response|null
The response object if the redirect is caught.
beforeRendersource public
beforeRender( Cake\Event\Event $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.
- If Router::extensions() is enabled, the layout and template type are switched based on the parsed extension or Accept-Type header. For example, if
controller/action.xml
is requested, the view path becomesapp/View/Controller/xml/action.ctp
. Also ifcontroller/action
is requested withAccept-Type: application/xml
in the headers the view path will becomeapp/View/Controller/xml/action.ctp
. Layout and template types will only switch to mime-types recognized by Cake\Network\Response. If you need to declare additional mime-types, you can do so using Cake\Network\Response::type() in your controller's beforeFilter() method. - If a helper with the same name as the extension exists, it is added to the controller.
- If the extension is of a type that RequestHandler understands, it will set that Content-type in the response header.
Parameters
-
Cake\Event\Event
$event
- The Controller.beforeRender event.
Returns
boolean
false if the render process should be aborted
convertXmlsource public
convertXml( string $xml )
Helper method to parse xml input data, due to lack of anonymous functions this lives here.
Parameters
- string
$xml
- XML string.
Returns
array
Xml array data
implementedEventssource public
implementedEvents( )
Events supported by this component.
Returns
array
array
Overrides
Cake\Controller\Component::implementedEvents()
initializesource public
initialize( array $config )
Checks to see if a specific content type has been requested and sets RequestHandler::$ext accordingly. Checks the following in order: 1. The '_ext' value parsed by the Router. 2. A specific AJAX type request indicated by the presence of a header. 3. The Accept header. With the exception of an AJAX request indicated using the second header based method above, the type must have been configured in Cake\Routing\Router
.
Parameters
- array
$config
- The config data.
See
Router::extensions()Overrides
Cake\Controller\Component::initialize()
isAtomsource public
isAtom( )
Returns true if the current call accepts an Atom response, false otherwise
Returns
boolean
True if client accepts an RSS response
isMobilesource public
isMobile( )
Returns true if user agent string matches a mobile web browser, or if the client accepts WAP content.
Returns
boolean
True if user agent is a mobile web browser
isRsssource public
isRss( )
Returns true if the current call accepts an RSS response, false otherwise
Returns
boolean
True if client accepts an RSS response
isXmlsource public
isXml( )
Returns true if the current call accepts an XML response, false otherwise
Returns
boolean
True if client accepts an XML response
mapAliassource public
mapAlias( string|array $alias )
Maps a content type alias back to its mime-type(s)
Parameters
- string|array
$alias
- String alias to convert back into a content type. Or an array of aliases to map.
Returns
string|null|array
Null 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.
preferssource public
prefers( string|array $type null )
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.
Parameters
- string|array
$type
optional null - An optional array of 'friendly' content-type names, i.e. 'html', 'xml', 'js', etc.
Returns
mixed
If $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.
renderAssource public
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.
Usage:
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'];
Parameters
-
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
See
Cake\Controller\Component\RequestHandlerComponent::respondAs()
requestedWithsource public
requestedWith( string|array $type null )
Determines the content type of the data the client has sent (i.e. in a POST request)
Parameters
- string|array
$type
optional null - Can be null (or no parameter), a string type name, or an array of types
Returns
mixed
If 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.
respondAssource public
respondAs( string|array $type , array $options [] )
Sets the response header based on type map index name. This wraps several methods available on Cake\Network\Response. It also allows you to use Content-Type aliases.
Parameters
- string|array
$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.
Returns
boolean
Returns 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.
responseTypesource public
responseType( )
Returns the current response type (Content-type header), or null if not alias exists
Returns
mixed
A string content type alias, or raw content type if no alias map exists, otherwise null
startupsource public
startup( Cake\Event\Event $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.
Parameters
-
Cake\Event\Event
$event
- The startup event that was fired.
viewClassMapsource public
viewClassMap( array|string|null $type null , array|null $viewClass null )
Getter/setter for viewClassMap
Deprecated
3.1.0 Use config('viewClassMap', ...) instead.Parameters
- array|string|null
$type
optional null - The type string or array with format
['type' => 'viewClass']
to map one or more - array|null
$viewClass
optional null - The viewClass to be used for the type without
View
appended
Returns
array|string
Returns viewClass when only string $type is set, else array with viewClassMap
Methods inherited from Cake\Controller\Component
__debugInfosource public
__debugInfo( )
Returns an array that can be used to describe the internal state of this object.
Returns
array
array
__getsource public
__get( string $name )
Magic method for lazy loading $components.
Parameters
- string
$name
- Name of component to get.
Returns
mixed
A Component object or null.
Methods used from Cake\Core\InstanceConfigTrait
_configDeletesource protected
_configDelete( string $key )
Delete a single config key
Parameters
- string
$key
- Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configReadsource protected
_configRead( string|null $key )
Read a config variable
Parameters
- string|null
$key
- Key to read.
Returns
mixed
mixed
_configWritesource protected
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
Parameters
- string|array
$key
- Key to write to.
- mixed
$value
- Value to write.
- boolean|string
$merge
optional false - True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
configsource public
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Parameters
- string|array|null
$key
optional null - The key to get/set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
- boolean
$merge
optional true - Whether to recursively merge or overwrite existing config, defaults to true.
Returns
mixed
Config value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallowsource public
configShallow( string|array $key , mixed|null $value null )
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->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Parameters
- string|array
$key
- The key to set, or a complete array of configs.
- mixed|null
$value
optional null - The value to set.
Returns
mixed
$this The object itself.
Methods used from Cake\Log\LogTrait
logsource public
log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Parameters
- mixed
$msg
- Log message.
- integer|string
$level
optional LogLevel::ERROR - Error level.
- string|array
$context
optional [] - Additional log data relevant to this message.
Returns
boolean
Success of log write.
Properties summary
Properties inherited from Cake\Controller\Component
$_componentMapsource
protected array
A component lookup table used to lazy load component objects.
[]
$_registrysource
protected Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
Properties used from Cake\Core\InstanceConfigTrait
$_configInitializedsource
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 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.
http://api.cakephp.org/3.1/class-Cake.Controller.Component.RequestHandlerComponent.html