class ApacheRequest extends Request
Request represents an HTTP request from an Apache server.
Constants
HEADER_CLIENT_IP | |
HEADER_CLIENT_HOST | |
HEADER_CLIENT_PROTO | |
HEADER_CLIENT_PORT |
Properties
ParameterBag | $attributes | Custom parameters | from Request |
ParameterBag | $request | Request body parameters ($_POST) | from Request |
ParameterBag | $query | Query string parameters ($_GET) | from Request |
ServerBag | $server | Server and execution environment parameters ($_SERVER) | from Request |
FileBag | $files | Uploaded files ($_FILES) | from Request |
ParameterBag | $cookies | Cookies ($_COOKIE) | from Request |
HeaderBag | $headers | Headers (taken from the $_SERVER) | from Request |
Methods
__construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null) Constructor. | from Request | |
initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null) Sets the parameters for this request. | from Request | |
static Request | createFromGlobals() Creates a new request with values from PHP's super globals. | from Request |
static Request | create(string $uri, string $method = 'GET', array $parameters = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null) Creates a Request based on a given URI and configuration. | from Request |
Request | duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) Clones a request and overrides some of its parameters. | from Request |
__clone() Clones the current request. | from Request | |
string | __toString() Returns the request as a string. | from Request |
overrideGlobals() Overrides the PHP global variables according to this request instance. | from Request | |
static | setTrustedProxies(array $proxies) Sets a list of trusted proxies. | from Request |
static array | getTrustedProxies() Gets the list of trusted proxies. | from Request |
static | setTrustedHosts(array $hostPatterns) Sets a list of trusted host patterns. | from Request |
static array | getTrustedHosts() Gets the list of trusted host patterns. | from Request |
static | setTrustedHeaderName(string $key, string $value) Sets the name for trusted headers. | from Request |
static string | getTrustedHeaderName(string $key) Gets the trusted proxy header name. | from Request |
static string | normalizeQueryString(string $qs) Normalizes a query string. | from Request |
static | enableHttpMethodParameterOverride() Enables support for the _method request parameter to determine the intended HTTP method. | from Request |
static Boolean | getHttpMethodParameterOverride() Checks whether support for the _method request parameter is enabled. | from Request |
mixed | get(string $key, mixed $default = null, Boolean $deep = false) Gets a "parameter" value. | from Request |
SessionInterface|null | getSession() Gets the Session. | from Request |
Boolean | hasPreviousSession() Whether the request contains a Session which was started in one of the previous requests. | from Request |
Boolean | hasSession() Whether the request contains a Session object. | from Request |
setSession(SessionInterface $session) Sets the Session. | from Request | |
array | getClientIps() Returns the client IP addresses. | from Request |
string | getClientIp() Returns the client IP address. | from Request |
string | getScriptName() Returns current script name. | from Request |
string | getPathInfo() Returns the path being requested relative to the executed script. | from Request |
string | getBasePath() Returns the root path from which this request is executed. | from Request |
string | getBaseUrl() Returns the root URL from which this request is executed. | from Request |
string | getScheme() Gets the request's scheme. | from Request |
string | getPort() Returns the port on which the request is made. | from Request |
string|null | getUser() Returns the user. | from Request |
string|null | getPassword() Returns the password. | from Request |
string | getUserInfo() Gets the user info. | from Request |
string | getHttpHost() Returns the HTTP host being requested. | from Request |
string | getRequestUri() Returns the requested URI. | from Request |
string | getSchemeAndHttpHost() Gets the scheme and HTTP host. | from Request |
string | getUri() Generates a normalized URI for the Request. | from Request |
string | getUriForPath(string $path) Generates a normalized URI for the given path. | from Request |
string|null | getQueryString() Generates the normalized query string for the Request. | from Request |
Boolean | isSecure() Checks whether the request is secure or not. | from Request |
string | getHost() Returns the host name. | from Request |
setMethod(string $method) Sets the request method. | from Request | |
string | getMethod() Gets the request "intended" method. | from Request |
string | getRealMethod() Gets the "real" request method. | from Request |
string | getMimeType(string $format) Gets the mime type associated with the format. | from Request |
string|null | getFormat(string $mimeType) Gets the format associated with the mime type. | from Request |
setFormat(string $format, string|array $mimeTypes) Associates a format with mime types. | from Request | |
string | getRequestFormat(string $default = 'html') Gets the request format. | from Request |
setRequestFormat(string $format) Sets the request format. | from Request | |
string|null | getContentType() Gets the format associated with the request. | from Request |
setDefaultLocale(string $locale) Sets the default locale. | from Request | |
setLocale(string $locale) Sets the locale. | from Request | |
string | getLocale() Get the locale. | from Request |
Boolean | isMethod(string $method) Checks if the request method is of specified type. | from Request |
Boolean | isMethodSafe() Checks whether the method is safe or not. | from Request |
string|resource | getContent(Boolean $asResource = false) Returns the request body content. | from Request |
array | getETags() Gets the Etags. | from Request |
Boolean | isNoCache() | from Request |
string|null | getPreferredLanguage(array $locales = null) Returns the preferred language. | from Request |
array | getLanguages() Gets a list of languages acceptable by the client browser. | from Request |
array | getCharsets() Gets a list of charsets acceptable by the client browser. | from Request |
array | getAcceptableContentTypes() Gets a list of content types acceptable by the client browser | from Request |
Boolean | isXmlHttpRequest() Returns true if the request is a XMLHttpRequest. | from Request |
Details
__construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null)
Constructor.
initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null)
Sets the parameters for this request.
This method also re-initializes all properties.
static Request createFromGlobals()
Creates a new request with values from PHP's super globals.
static Request create(string $uri, string $method = 'GET', array $parameters = array(), array $cookies = array(), array $files = array(), array $server = array(), string $content = null)
Creates a Request based on a given URI and configuration.
The information contained in the URI always take precedence over the other information (server and parameters).
Request duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
Clones a request and overrides some of its parameters.
__clone()
Clones the current request.
Note that the session is not cloned as duplicated requests are most of the time sub-requests of the main one.
string __toString()
Returns the request as a string.
overrideGlobals()
Overrides the PHP global variables according to this request instance.
It overrides $GET, $POST, $REQUEST, $SERVER, $COOKIE. $FILES is never override, see rfc1867
static setTrustedProxies(array $proxies)
Sets a list of trusted proxies.
You should only list the reverse proxies that you manage directly.
static array getTrustedProxies()
Gets the list of trusted proxies.
static setTrustedHosts(array $hostPatterns)
Sets a list of trusted host patterns.
You should only list the hosts you manage using regexs.
static array getTrustedHosts()
Gets the list of trusted host patterns.
static setTrustedHeaderName(string $key, string $value)
Sets the name for trusted headers.
The following header keys are supported:
- Request::HEADERCLIENTIP: defaults to X-Forwarded-For (see getClientIp())
- Request::HEADERCLIENTHOST: defaults to X-Forwarded-Host (see getClientHost())
- Request::HEADERCLIENTPORT: defaults to X-Forwarded-Port (see getClientPort())
- Request::HEADERCLIENTPROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure())
Setting an empty value allows to disable the trusted header for the given key.
static string getTrustedHeaderName(string $key)
Gets the trusted proxy header name.
static string normalizeQueryString(string $qs)
Normalizes a query string.
It builds a normalized query string, where keys/value pairs are alphabetized, have consistent escaping and unneeded delimiters are removed.
static enableHttpMethodParameterOverride()
Enables support for the _method request parameter to determine the intended HTTP method.
Be warned that enabling this feature might lead to CSRF issues in your code. Check that you are using CSRF tokens when required.
The HTTP method can only be overridden when the real HTTP method is POST.
static Boolean getHttpMethodParameterOverride()
Checks whether support for the _method request parameter is enabled.
mixed get(string $key, mixed $default = null, Boolean $deep = false)
Gets a "parameter" value.
This method is mainly useful for libraries that want to provide some flexibility.
Order of precedence: GET, PATH, POST
Avoid using this method in controllers:
- slow
- prefer to get from a "named" source
It is better to explicitly get request parameters from the appropriate public property instead (query, attributes, request).
SessionInterface|null getSession()
Gets the Session.
Boolean hasPreviousSession()
Whether the request contains a Session which was started in one of the previous requests.
Boolean hasSession()
Whether the request contains a Session object.
This method does not give any information about the state of the session object, like whether the session is started or not. It is just a way to check if this Request is associated with a Session instance.
setSession(SessionInterface $session)
Sets the Session.
array getClientIps()
Returns the client IP addresses.
In the returned array the most trusted IP address is first, and the least trusted one last. The "real" client IP address is the last one, but this is also the least trusted one. Trusted proxies are stripped.
Use this method carefully; you should use getClientIp() instead.
string getClientIp()
Returns the client IP address.
This method can read the client IP address from the "X-Forwarded-For" header when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For" header value is a comma+space separated list of IP addresses, the left-most being the original client, and each successive proxy that passed the request adding the IP address where it received the request from.
If your reverse proxy uses a different header name than "X-Forwarded-For", ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with the "client-ip" key.
string getScriptName()
Returns current script name.
string getPathInfo()
Returns the path being requested relative to the executed script.
The path info always starts with a /.
Suppose this request is instantiated from /mysite on localhost:
- http://localhost/mysite returns an empty string
- http://localhost/mysite/about returns '/about'
- http://localhost/mysite/enco%20ded returns '/enco%20ded'
- http://localhost/mysite/about?var=1 returns '/about'
string getBasePath()
Returns the root path from which this request is executed.
Suppose that an index.php file instantiates this request object:
- http://localhost/index.php returns an empty string
- http://localhost/index.php/page returns an empty string
- http://localhost/web/index.php returns '/web'
- http://localhost/we%20b/index.php returns '/we%20b'
string getBaseUrl()
Returns the root URL from which this request is executed.
The base URL never ends with a /.
This is similar to getBasePath(), except that it also includes the script filename (e.g. index.php) if one exists.
string getScheme()
Gets the request's scheme.
string getPort()
Returns the port on which the request is made.
This method can read the client port from the "X-Forwarded-Port" header when trusted proxies were set via "setTrustedProxies()".
The "X-Forwarded-Port" header must contain the client port.
If your reverse proxy uses a different header name than "X-Forwarded-Port", configure it via "setTrustedHeaderName()" with the "client-port" key.
string|null getUser()
Returns the user.
string|null getPassword()
Returns the password.
string getUserInfo()
Gets the user info.
string getHttpHost()
Returns the HTTP host being requested.
The port name will be appended to the host if it's non-standard.
string getRequestUri()
Returns the requested URI.
string getSchemeAndHttpHost()
Gets the scheme and HTTP host.
If the URL was called with basic authentication, the user and the password are not added to the generated string.
string getUri()
Generates a normalized URI for the Request.
string getUriForPath(string $path)
Generates a normalized URI for the given path.
string|null getQueryString()
Generates the normalized query string for the Request.
It builds a normalized query string, where keys/value pairs are alphabetized and have consistent escaping.
Boolean isSecure()
Checks whether the request is secure or not.
This method can read the client port from the "X-Forwarded-Proto" header when trusted proxies were set via "setTrustedProxies()".
The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
If your reverse proxy uses a different header name than "X-Forwarded-Proto" ("SSL_HTTPS" for instance), configure it via "setTrustedHeaderName()" with the "client-proto" key.
string getHost()
Returns the host name.
This method can read the client port from the "X-Forwarded-Host" header when trusted proxies were set via "setTrustedProxies()".
The "X-Forwarded-Host" header must contain the client host name.
If your reverse proxy uses a different header name than "X-Forwarded-Host", configure it via "setTrustedHeaderName()" with the "client-host" key.
setMethod(string $method)
Sets the request method.
string getMethod()
Gets the request "intended" method.
If the X-HTTP-Method-Override header is set, and if the method is a POST, then it is used to determine the "real" intended HTTP method.
The _method request parameter can also be used to determine the HTTP method, but only if enableHttpMethodParameterOverride() has been called.
The method is always an uppercased string.
string getRealMethod()
Gets the "real" request method.
string getMimeType(string $format)
Gets the mime type associated with the format.
string|null getFormat(string $mimeType)
Gets the format associated with the mime type.
setFormat(string $format, string|array $mimeTypes)
Associates a format with mime types.
string getRequestFormat(string $default = 'html')
Gets the request format.
Here is the process to determine the format:
- format defined by the user (with setRequestFormat())
- _format request parameter
- $default
setRequestFormat(string $format)
Sets the request format.
string|null getContentType()
Gets the format associated with the request.
setDefaultLocale(string $locale)
Sets the default locale.
setLocale(string $locale)
Sets the locale.
string getLocale()
Get the locale.
Boolean isMethod(string $method)
Checks if the request method is of specified type.
Boolean isMethodSafe()
Checks whether the method is safe or not.
string|resource getContent(Boolean $asResource = false)
Returns the request body content.
array getETags()
Gets the Etags.
Boolean isNoCache()
string|null getPreferredLanguage(array $locales = null)
Returns the preferred language.
array getLanguages()
Gets a list of languages acceptable by the client browser.
array getCharsets()
Gets a list of charsets acceptable by the client browser.
array getAcceptableContentTypes()
Gets a list of content types acceptable by the client browser
Boolean isXmlHttpRequest()
Returns true if the request is a XMLHttpRequest.
It works if your JavaScript library set an X-Requested-With HTTP header. It is known to work with common JavaScript frameworks:
Please login to continue.