HttpRequestService

Type: Class
Namespace: Craft
Inherits: Craft\HttpRequestService » CHttpRequest (opens new window) » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements: IApplicationComponent
Since: 1.0

HttpRequestService provides APIs for getting information about the current HTTP request.

An instance of HttpRequestService is globally accessible in Craft via {@link WebApp::request craft()->request}.

# Public Properties

Property	Description
$behaviors (opens new window)	array (opens new window) – The behaviors that should be attached to this component.
$csrfCookie (opens new window)	array (opens new window) – The property values (in name-value pairs) used to initialize the CSRF cookie.
$csrfTokenName (opens new window)	string (opens new window) – The name of the token used to prevent CSRF.
$enableCookieValidation (opens new window)	boolean (opens new window) – Whether cookies should be validated to ensure they are not tampered.
$enableCsrfValidation (opens new window)	boolean (opens new window) – Whether to enable CSRF (Cross-Site Request Forgery) validation.
$jsonAsArray (opens new window)	boolean (opens new window) – Whether the parsing of JSON REST requests should return associative arrays for object data.

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__get() (opens new window)	Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window)	Checks if a property value is null.
__set() (opens new window)	Sets value of a component property.
__unset() (opens new window)	Sets a component property to be null.
asa() (opens new window)	Returns the named behavior object.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attachEventHandler() (opens new window)	Attaches an event handler to an event.
canGetProperty() (opens new window)	Determines whether a property can be read.
canSetProperty() (opens new window)	Determines whether a property can be set.
close()	Attempts to closes the connection with the HTTP client, without ending PHP script execution.
compareAcceptTypes() (opens new window)	Compare function for determining the preference of accepted MIME type array maps See {@link parseAcceptHeader()} for the format of $a and $b
decodePathInfo()	Decodes the path info.
deleteCookie()	Deletes a cookie by its name.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
detachEventHandler() (opens new window)	Detaches an existing event handler.
disableBehavior() (opens new window)	Disables an attached behavior.
disableBehaviors() (opens new window)	Disables all behaviors attached to this component.
enableBehavior() (opens new window)	Enables an attached behavior.
enableBehaviors() (opens new window)	Enables all behaviors attached to this component.
evaluateExpression() (opens new window)	Evaluates a PHP expression or callback under the context of this component.
getAcceptTypes() (opens new window)	Returns user browser accept types, null if not present.
getActionSegments()	Returns an array of the action path segments, if this is an {@link isActionRequest() action request}.
getBaseUrl() (opens new window)	Returns the relative URL for the application.
getBrowser() (opens new window)	Returns information about the capabilities of user browser.
getBrowserLanguages()	Returns a list of languages the user has selected in their browser’s settings, canonicalized using {@link LocaleData::getCanonicalID}.
getClientOs()	Returns whether the client is running "Windows", "Mac", "Linux" or "Other", based on the browser's UserAgent string.
getContentType() (opens new window)	Returns request content-type The Content-Type header field indicates the MIME type of the data contained in {@link getRawBody()} or, in the case of the HEAD method, the media type that would have been sent had the request been a GET.
getCookie()	Returns a cookie by its name.
getCookies()	Returns the cookie collection. The result can be used like an associative array. Adding {@link HttpCookie} objects to the collection will send the cookies to the client; and removing the objects from the collection will delete those cookies on the client.
getCsrfToken()	Gets the current CSRF token from the CSRF token cookie, (re)creating the cookie if it is missing or invalid.
getDelete() (opens new window)	Returns the named DELETE parameter value.
getEventHandlers() (opens new window)	Returns the list of attached event handlers for an event.
getHostInfo() (opens new window)	Returns the schema and host part of the application URL.
getHostName()	Returns the host name, without “http://” or “https://”.
getHttpVersion() (opens new window)	Returns the version of the HTTP protocol used by client.
getIpAddress()	Retrieves the best guess of the client’s actual IP address taking into account numerous HTTP proxy headers due to variations in how different ISPs handle IP addresses in headers between hops.
getIsAjaxRequest() (opens new window)	Returns whether this is an AJAX (XMLHttpRequest) request.
getIsDeleteRequest() (opens new window)	Returns whether this is a DELETE request.
getIsFlashRequest() (opens new window)	Returns whether this is an Adobe Flash or Adobe Flex request.
getIsGetRequest()	Returns whether this is a GET request.
getIsInitialized() (opens new window)	Checks if this application component has been initialized.
getIsPatchRequest() (opens new window)	Returns whether this is a PATCH request.
getIsPostRequest() (opens new window)	Returns whether this is a POST request.
getIsPutRequest() (opens new window)	Returns whether this is a PUT request.
getIsSecureConnection() (opens new window)	Return if the request is sent via secure channel (https).
getMimeType()	Returns the MIME type that is going to be included in the response via the Content-Type header.
getNormalizedPath()	Returns the path Craft should use to route this request, including the CP trigger (opens new window) if it is in there.
getPageNum()	Returns the current page number.
getParam()	Returns a parameter from either the query string or POST data.
getPatch() (opens new window)	Returns the named PATCH parameter value.
getPath()	Returns the request’s Craft path.
getPathInfo() (opens new window)	Returns the path info of the currently requested URL.
getPort() (opens new window)	Returns the port to use for insecure requests.
getPost()	Returns a POST parameter, or all of them.
getPreferredAcceptType() (opens new window)	Returns the user preferred accept MIME type.
getPreferredAcceptTypes() (opens new window)	Returns an array of user accepted MIME types in order of preference.
getPreferredLanguage() (opens new window)	Returns the user-preferred language that should be used by this application.
getPreferredLanguages() (opens new window)	Returns an array of user accepted languages in order of preference.
getPut() (opens new window)	Returns the named PUT parameter value.
getQuery()	Returns a query string parameter, or all of them.
getQueryString() (opens new window)	Returns part of the request URL that is after the question mark.
getQueryStringWithoutPath()	Returns the request’s query string, without the p= parameter.
getRawBody() (opens new window)	Returns the raw HTTP request body.
getRequestType() (opens new window)	Returns the request type, such as GET, POST, HEAD, PUT, PATCH, DELETE.
getRequestUri() (opens new window)	Returns the request URI portion for the currently requested URL.
getRequiredParam()	Returns a parameter from either the query string or POST data, or bails on the request with a 400 error if that parameter doesn’t exist anywhere.
getRequiredPost()	Returns a POST parameter, or bails on the request with a 400 error if that parameter doesn’t exist.
getRequiredQuery()	Returns a query string parameter, or bails on the request with a 400 error if that parameter doesn’t exist.
getRestParams() (opens new window)	Returns request parameters. Typically PUT, PATCH or DELETE.
getScriptFile() (opens new window)	Returns entry script file path.
getScriptName()	Returns the script name used to access Craft (e.g. “index.php”).
getScriptUrl() (opens new window)	Returns the relative URL of the entry script.
getSecurePort() (opens new window)	Returns the port to use for secure requests.
getSegment()	Returns a specific segment from the Craft path.
getSegments()	Returns an array of the Craft path’s segments.
getServerName() (opens new window)	Returns the server name.
getServerPort() (opens new window)	Returns the server port number.
getToken()	Returns the request’s token, if there is one.
getUrl() (opens new window)	Returns the currently requested URL.
getUrlReferrer() (opens new window)	Returns the URL referrer, null if not present
getUserAgent() (opens new window)	Returns the user agent, null if not present.
getUserHost() (opens new window)	Returns the user host name, null if it cannot be determined.
getUserHostAddress()	Alias of {@link getIpAddress()}.
getValidatedPost()	Returns a POST parameter. If the validateUnsafeRequestParams config setting has been set to `true`, and this is a front-end request, then the POST parameter’s value will be validated with {@link SecurityService::validateData()} before being returned, ensuring that the value had not been tampered with by the user.
hasEvent() (opens new window)	Determines whether an event is defined.
hasEventHandler() (opens new window)	Checks whether the named event has attached handlers.
hasProperty() (opens new window)	Determines whether a property is defined.
init()	Initializes the application component.
isActionRequest()	Returns whether the current request should be routed to a specific controller action before normal request routing takes over.
isAjaxRequest()	Alias of {@link getIsAjaxRequest()}.
isCpRequest()	Returns whether the current request should be routed to the Control Panel.
isDeleteRequest()	Alias of {@link getIsDeleteRequest()}.
isDeleteViaPostRequest()	Alias of {@link getIsDeleteViaPostRequest()}.
isFlashRequest()	Alias of {@link getIsFlashRequest()}.
isGetRequest()	Alias of {@link getIsGetRequest()}.
isLivePreview()	Returns whether this is a Live Preview request.
isMobileBrowser()	Returns whether the request is coming from a mobile browser.
isPostRequest()	Alias of {@link getIsPostRequest()}.
isPutRequest()	Alias of {@link getIsPutRequest()}.
isPutViaPostRequest()	Alias of {@link getIsPutViaPostRequest()}.
isResourceRequest()	Returns whether the current request should be routed to a resource.
isSecureConnection()	Alias of {@link getIsSecureConnection()}.
isSingleActionRequest()	Returns whether the current request is solely an action request.
isSiteRequest()	Returns whether the current request should be routed to the front-end site.
parseAcceptHeader() (opens new window)	Parses an HTTP Accept header, returning an array map with all parts of each entry.
raiseEvent() (opens new window)	Raises an event.
redirect() (opens new window)	Redirects the browser to the specified URL.
regenCsrfCookie()
sendFile()	Sends a file to the user.
setBaseUrl() (opens new window)	Sets the relative URL for the application.
setHostInfo() (opens new window)	Sets the schema and host part of the application URL.
setPort() (opens new window)	Sets the port to use for insecure requests.
setScriptUrl() (opens new window)	Sets the relative URL for the application entry script.
setSecurePort() (opens new window)	Sets the port to use for secure requests.
stripSlashes() (opens new window)	Strips slashes from input data.
validateCsrfToken()	Performs the CSRF validation. This is the event handler responding to {@link CApplication::onBeginRequest}.
xSendFile() (opens new window)	Sends existing file to a browser as a download using x-sendfile.

# `close()`

Attempts to closes the connection with the HTTP client, without ending PHP script execution. This method relies on flush() (opens new window), which may not actually work if mod_deflate or mod_gzip is installed, or if this is a Win32 server. See also http://stackoverflow.com/a/141026 View source (opens new window)

Arguments

$content (string (opens new window), null (opens new window)) – Any content that should be included in the response body.

Returns

null (opens new window)

Throws

Craft\Exception
An exception will be thrown if content has already been output.

Signature

public null close ( $content = '' )

# `decodePathInfo()`

Decodes the path info. Replacement for Yii's {@link \CHttpRequest::decodePathInfo()}.

HttpRequestService

# Public Properties

# Public Methods

# close()

Arguments

Returns

Throws

Signature

# decodePathInfo()

Arguments

Returns

Signature

# deleteCookie()

Arguments

Returns

Signature

# getActionSegments()

Returns

Signature

# getBrowserLanguages()

Returns

Signature

# getClientOs()

Returns

Signature

# getCookie()

Arguments

Returns

Signature

# getCookies()

Returns

Signature

# getCsrfToken()

Returns

Throws

Signature

# getHostName()

Returns

Signature

# getIpAddress()

Returns

Signature

# getIsGetRequest()

Returns

Signature

# getMimeType()

Returns

Signature

# getNormalizedPath()

Returns

Signature

# getPageNum()

Returns

Signature

# getParam()

Arguments

Returns

Signature

# getPath()

Returns

Signature

# getPost()

Arguments

Returns

Signature

# getQuery()

Arguments

Returns

Signature

# getQueryStringWithoutPath()

Returns

Signature

# getRequiredParam()

Arguments

Returns

Throws

Signature

# getRequiredPost()

Arguments

Returns

# `close()`

# `decodePathInfo()`

# `deleteCookie()`

# `getActionSegments()`

# `getBrowserLanguages()`

# `getClientOs()`

# `getCookie()`

# `getCookies()`

# `getCsrfToken()`

# `getHostName()`

# `getIpAddress()`

# `getIsGetRequest()`

# `getMimeType()`

# `getNormalizedPath()`

# `getPageNum()`

# `getParam()`

# `getPath()`

# `getPost()`

# `getQuery()`

# `getQueryStringWithoutPath()`

# `getRequiredParam()`

# `getRequiredPost()`

# `getRequiredQuery()`

# `getScriptName()`

# `getSegment()`

# `getSegments()`

# `getToken()`

# `getUserHostAddress()`

# `getValidatedPost()`

# `init()`

# `isActionRequest()`

# `isAjaxRequest()`

# `isCpRequest()`

# `isDeleteRequest()`

# `isDeleteViaPostRequest()`

# `isFlashRequest()`

# `isGetRequest()`

# `isLivePreview()`

# `isMobileBrowser()`

# `isPostRequest()`

# `isPutRequest()`

# `isPutViaPostRequest()`

# `isResourceRequest()`

# `isSecureConnection()`