Class RequestHandlerComponent

Properties summary

• $__acceptTypes public
  array

  Content-types accepted by the client. If extension parsing is enabled in the Router, and an extension is detected, the corresponding content-type will be used as the overriding primary content-type accepted.

• $__renderType public
  string
  The template to use when rendering the given content type.
• $__requestContent public
  array

  Friendly content-type mappings used to set response types and determine request types. Can be modified with RequestHandler::setContent()

• $__responseTypeSet public
  string

  Holds the content-type of the response that is set when using RequestHandler::respondAs()

• $__typesInitialized public
  boolean
  Flag set when MIME types have been initialized
• $ajaxLayout public
  string
  The layout that will be switched to for Ajax requests
• $enabled public
  boolean
  Determines whether or not callbacks will be fired on this component
• $ext public
  string
  Contains the file extension parsed out by the Router
• $mobileUA public
  array
  List of regular expressions for matching mobile device's user agent string
• $params public
  array
  Holds the copy of Controller::$params

Method Summary

• __construct() public

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

• __initializeTypes() public

  Initializes MIME types

• _header() public

  Wrapper for header() so calls can be easily tested.

• accepts() public

  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.

• beforeRedirect() public

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

• getAjaxVersion() public

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

• getClientIP() public

  Gets remote client IP

• getReferer() public

  Gets the server name from which this request was referred

• initialize() public

  Initializes the component, gets a reference to Controller::$parameters, and checks to see if a file extension has been parsed by the Router. If yes, the corresponding content-type is pushed onto the list of accepted content-types as the first item.

• isAjax() public

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

• isAtom() public

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

• isDelete() public

  Returns true if the current call a DELETE request

• isFlash() public

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

• isGet() public

  Returns true if the current call a GET request

• isMobile() public deprecated

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

• isPost() public

  Returns true if the current call a POST request

• isPut() public

  Returns true if the current call a PUT request

• isRss() public

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

• isSSL() public

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

• isWap() public

  Returns true if the client accepts WAP content

• isXml() public

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

• mapType() public

  Maps a content-type back to an alias

• prefers() public

  Determines which content-types the client prefers. If no parameters are given, the 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.

• renderAs() public

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

• requestedWith() public

  Determines the content type of the data the client has sent (i.e. in a POST request)

• respondAs() public

  Sets the response header based on type map index name. If DEBUG is greater than 2, the header is not set.

• responseType() public

  Returns the current response type (Content-type header), or null if none has been set

• setContent() public

  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.

• startup() public

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

Method Detail

Methods inherited from Object

Properties detail

array()

null

array(
    'javascript'    => 'text/javascript',
    'js'            => 'text/javascript',
    'json'          => 'application/json',
    'css'           => 'text/css',
    'html'          => array('text/html', '*/*'),
    'text'          => 'text/plain',
    'txt'           => 'text/plain',
    'csv'           => array('text/csv', 'application/vnd.ms-excel', 'text/plain'),
    'form'          => 'application/x-www-form-urlencoded',
    'file'          => 'multipart/form-data',
    'xhtml'         => array('application/xhtml+xml', 'application/xhtml', 'text/xhtml'),
    'xhtml-mobile'  => 'application/vnd.wap.xhtml+xml',
    'xml'           => array('application/xml', 'text/xml'),
    'rss'           => 'application/rss+xml',
    'atom'          => 'application/atom+xml',
    'amf'           => 'application/x-amf',
    'wap'           => array(
        'text/vnd.wap.wml',
        'text/vnd.wap.wmlscript',
        'image/vnd.wap.wbmp'
    ),
    'wml'           => 'text/vnd.wap.wml',
    'wmlscript'     => 'text/vnd.wap.wmlscript',
    'wbmp'          => 'image/vnd.wap.wbmp',
    'pdf'           => 'application/pdf',
    'zip'           => 'application/x-zip',
    'tar'           => 'application/x-tar'
)

null

false

'ajax'

true

null

array(
    'Android',
    'AvantGo',
    'BlackBerry',
    'DoCoMo',
    'iPod',
    'iPhone',
    'iPad',
    'J2ME',
    'MIDP',
    'NetFront',
    'Nokia',
    'Opera Mini',
    'Opera Mobi',
    'PalmOS',
    'PalmSource',
    'portalmmm',
    'Plucker',
    'ReqwirelessWeb',
    'SonyEricsson',
    'Symbian',
    'UP\.Browser',
    'webOS',
    'Windows CE',
    'Windows Phone OS',
    'Xiino'
)

array()