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 CakeRequest::accepts() this method deals entirely with mapped content types.

Usage:

$this->RequestHandler->accepts(array('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.

Add a new mapped input type. Mapped input types are automatically converted by RequestHandlerComponent during the startup() callback.

Handles (fakes) redirects for Ajax requests using requestAction()

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.

Constructor. Parses the accepted content types accepted by the client using HTTP_ACCEPT

Helper method to parse xml input data, due to lack of anonymous functions this lives here.

Gets Prototype version if call is Ajax, otherwise empty string. The Prototype library sets a special "Prototype version" HTTP header.

Gets remote client IP

Gets the server name from which this request was referred

Checks to see if a file extension has been parsed by the Router, or if the HTTP_ACCEPT_TYPE has matches only one content type with the supported extensions. If there is only one matching type between the supported content types & extensions, and the requested mime-types, RequestHandler::$ext is set to that value.

Returns true if the current HTTP request is Ajax, false otherwise

Returns true if the current call accepts an Atom response, false otherwise

Returns true if the current call a DELETE request

Returns true if the current HTTP request is coming from a Flash-based client

Returns true if the current call a GET request

Returns true if user agent string matches a mobile web browser, or if the client accepts WAP content.

Returns true if the current call a POST request

Returns true if the current call a PUT request

Returns true if the current call accepts an RSS response, false otherwise

Returns true if the current request is over HTTPS, false otherwise.

Returns true if the client accepts WAP content

Returns true if the current call accepts an XML response, false otherwise

Maps a content type alias back to its mime-type(s)

Maps a content-type back to an alias

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.

Sets the layout and template paths for the content type defined by $type.

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', array('attachment' => 'myfile.xml');

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 CakeResponse. It also allows you to use Content-Type aliases.

Returns the current response type (Content-type header), or null if not alias exists

Adds/sets the Content-type(s) for the given name. This method allows content-types to be mapped to friendly aliases (or extensions), which allows RequestHandler to automatically respond to requests of that type in the startup method.

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.

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.

The startup method of the RequestHandler enables several automatic behaviors related to the detection of certain properties of the HTTP request, including:

• Disabling layout rendering for Ajax requests (based on the HTTP_X_REQUESTED_WITH header)
• If Router::parseExtensions() 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 becomes app/View/Controller/xml/action.ctp. Also if controller/action is requested with Accept-Type: application/xml in the headers the view path will become app/View/Controller/xml/action.ctp. Layout and template types will only switch to mime-types recognized by CakeResponse. If you need to declare additional mime-types, you can do so using CakeResponse::type() in your controllers 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.
• 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.