[ Index ] |
PHP Cross Reference of phpBB-3.3.14-deutsch |
[Source view] [Print] [Project Stats]
(no description)
File Size: | 2197 lines (71 kb) |
Included or required: | 0 times |
Referenced: | 0 times |
Includes or requires: | 0 files |
Request:: (83 methods):
__construct()
initialize()
createFromGlobals()
create()
setFactory()
duplicate()
__clone()
__toString()
overrideGlobals()
setTrustedProxies()
getTrustedProxies()
getTrustedHeaderSet()
setTrustedHosts()
getTrustedHosts()
setTrustedHeaderName()
getTrustedHeaderName()
normalizeQueryString()
enableHttpMethodParameterOverride()
getHttpMethodParameterOverride()
get()
getSession()
hasPreviousSession()
hasSession()
setSession()
getClientIps()
getClientIp()
getScriptName()
getPathInfo()
getBasePath()
getBaseUrl()
getScheme()
getPort()
getUser()
getPassword()
getUserInfo()
getHttpHost()
getRequestUri()
getSchemeAndHttpHost()
getUri()
getUriForPath()
getRelativeUriForPath()
getQueryString()
isSecure()
getHost()
setMethod()
getMethod()
getRealMethod()
getMimeType()
getMimeTypes()
getFormat()
setFormat()
getRequestFormat()
setRequestFormat()
getContentType()
setDefaultLocale()
getDefaultLocale()
setLocale()
getLocale()
isMethod()
isMethodSafe()
isMethodIdempotent()
isMethodCacheable()
getProtocolVersion()
getContent()
getETags()
isNoCache()
getPreferredLanguage()
getLanguages()
getCharsets()
getEncodings()
getAcceptableContentTypes()
isXmlHttpRequest()
prepareRequestUri()
prepareBaseUrl()
prepareBasePath()
preparePathInfo()
initializeFormats()
setPhpDefaultLocale()
getUrlencodedPrefix()
createRequestFromFactory()
isFromTrustedProxy()
getTrustedValues()
normalizeAndFilterClientIps()
__construct(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null) X-Ref |
param: array $query The GET parameters param: array $request The POST parameters param: array $attributes The request attributes (parameters parsed from the PATH_INFO, ...) param: array $cookies The COOKIE parameters param: array $files The FILES parameters param: array $server The SERVER parameters param: string|resource|null $content The raw body data |
initialize(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null) X-Ref |
Sets the parameters for this request. This method also re-initializes all properties. param: array $query The GET parameters param: array $request The POST parameters param: array $attributes The request attributes (parameters parsed from the PATH_INFO, ...) param: array $cookies The COOKIE parameters param: array $files The FILES parameters param: array $server The SERVER parameters param: string|resource|null $content The raw body data |
createFromGlobals() X-Ref |
Creates a new request with values from PHP's super globals. return: static |
create($uri, $method = 'GET', $parameters = [], $cookies = [], $files = [], $server = [], $content = null) X-Ref |
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). param: string $uri The URI param: string $method The HTTP method param: array $parameters The query (GET) or request (POST) parameters param: array $cookies The request cookies ($_COOKIE) param: array $files The request files ($_FILES) param: array $server The server parameters ($_SERVER) param: string|resource|null $content The raw body data return: static |
setFactory($callable) X-Ref |
Sets a callable able to create a Request instance. This is mainly useful when you need to override the Request class to keep BC with an existing system. It should not be used for any other purpose. param: callable|null $callable A PHP callable |
duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null) X-Ref |
Clones a request and overrides some of its parameters. param: array $query The GET parameters param: array $request The POST parameters param: array $attributes The request attributes (parameters parsed from the PATH_INFO, ...) param: array $cookies The COOKIE parameters param: array $files The FILES parameters param: array $server The SERVER parameters return: static |
__clone() X-Ref |
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. |
__toString() X-Ref |
Returns the request as a string. return: string The request |
overrideGlobals() X-Ref |
Overrides the PHP global variables according to this request instance. It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE. $_FILES is never overridden, see rfc1867 |
setTrustedProxies(array $proxies) X-Ref |
Sets a list of trusted proxies. You should only list the reverse proxies that you manage directly. param: array $proxies A list of trusted proxies param: int $trustedHeaderSet A bit field of Request::HEADER_*, to set which headers to trust from your proxies |
getTrustedProxies() X-Ref |
Gets the list of trusted proxies. return: array An array of trusted proxies |
getTrustedHeaderSet() X-Ref |
Gets the set of trusted headers from trusted proxies. return: int A bit field of Request::HEADER_* that defines which headers are trusted from your proxies |
setTrustedHosts(array $hostPatterns) X-Ref |
Sets a list of trusted host patterns. You should only list the hosts you manage using regexs. param: array $hostPatterns A list of trusted host patterns |
getTrustedHosts() X-Ref |
Gets the list of trusted host patterns. return: array An array of trusted host patterns |
setTrustedHeaderName($key, $value) X-Ref |
Sets the name for trusted headers. The following header keys are supported: * Request::HEADER_CLIENT_IP: defaults to X-Forwarded-For (see getClientIp()) * Request::HEADER_CLIENT_HOST: defaults to X-Forwarded-Host (see getHost()) * Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getPort()) * Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure()) * Request::HEADER_FORWARDED: defaults to Forwarded (see RFC 7239) Setting an empty value allows to disable the trusted header for the given key. param: string $key The header key param: string $value The header name |
getTrustedHeaderName($key) X-Ref |
Gets the trusted proxy header name. param: string $key The header key return: string The header name |
normalizeQueryString($qs) X-Ref |
Normalizes a query string. It builds a normalized query string, where keys/value pairs are alphabetized, have consistent escaping and unneeded delimiters are removed. param: string $qs Query string return: string A normalized query string for the Request |
enableHttpMethodParameterOverride() X-Ref |
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. If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered and used to send a "PUT" or "DELETE" request via the _method request parameter. If these methods are not protected against CSRF, this presents a possible vulnerability. The HTTP method can only be overridden when the real HTTP method is POST. |
getHttpMethodParameterOverride() X-Ref |
Checks whether support for the _method request parameter is enabled. return: bool True when the _method request parameter is enabled, false otherwise |
get($key, $default = null) X-Ref |
Gets a "parameter" value from any bag. This method is mainly useful for libraries that want to provide some flexibility. If you don't need the flexibility in controllers, it is better to explicitly get request parameters from the appropriate public property instead (attributes, query, request). Order of precedence: PATH (routing placeholders or custom attributes), GET, BODY param: string $key The key param: mixed $default The default value if the parameter key does not exist return: mixed |
getSession() X-Ref |
Gets the Session. return: SessionInterface|null The session |
hasPreviousSession() X-Ref |
Whether the request contains a Session which was started in one of the previous requests. return: bool |
hasSession() X-Ref |
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. return: bool true when the Request contains a Session object, false otherwise |
setSession(SessionInterface $session) X-Ref |
Sets the Session. param: SessionInterface $session The Session |
getClientIps() X-Ref |
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. return: array The client IP addresses |
getClientIp() X-Ref |
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 the $trustedHeaderSet argument of the Request::setTrustedProxies() method instead. return: string|null The client IP address |
getScriptName() X-Ref |
Returns current script name. return: string |
getPathInfo() X-Ref |
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' return: string The raw path (i.e. not urldecoded) |
getBasePath() X-Ref |
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' return: string The raw path (i.e. not urldecoded) |
getBaseUrl() X-Ref |
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. return: string The raw URL (i.e. not urldecoded) |
getScheme() X-Ref |
Gets the request's scheme. return: string |
getPort() X-Ref |
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 via the $trustedHeaderSet argument of the Request::setTrustedProxies() method instead. return: int|string can be a string if fetched from the server bag |
getUser() X-Ref |
Returns the user. return: string|null |
getPassword() X-Ref |
Returns the password. return: string|null |
getUserInfo() X-Ref |
Gets the user info. return: string A user name and, optionally, scheme-specific information about how to gain authorization to access the server |
getHttpHost() X-Ref |
Returns the HTTP host being requested. The port name will be appended to the host if it's non-standard. return: string |
getRequestUri() X-Ref |
Returns the requested URI (path and query string). return: string The raw URI (i.e. not URI decoded) |
getSchemeAndHttpHost() X-Ref |
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. return: string The scheme and HTTP host |
getUri() X-Ref |
Generates a normalized URI (URL) for the Request. return: string A normalized URI (URL) for the Request |
getUriForPath($path) X-Ref |
Generates a normalized URI for the given path. param: string $path A path to use instead of the current one return: string The normalized URI for the path |
getRelativeUriForPath($path) X-Ref |
Returns the path as relative reference from the current Request path. Only the URIs path component (no schema, host etc.) is relevant and must be given. Both paths must be absolute and not contain relative parts. Relative URLs from one resource to another are useful when generating self-contained downloadable document archives. Furthermore, they can be used to reduce the link size in documents. Example target paths, given a base path of "/a/b/c/d": - "/a/b/c/d" -> "" - "/a/b/c/" -> "./" - "/a/b/" -> "../" - "/a/b/c/other" -> "other" - "/a/x/y" -> "../../x/y" param: string $path The target path return: string The relative target path |
getQueryString() X-Ref |
Generates the normalized query string for the Request. It builds a normalized query string, where keys/value pairs are alphabetized and have consistent escaping. return: string|null A normalized query string for the Request |
isSecure() X-Ref |
Checks whether the request is secure or not. This method can read the client protocol 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 the $trustedHeaderSet argument of the Request::setTrustedProxies() method instead. return: bool |
getHost() X-Ref |
Returns the host name. This method can read the client host name 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 the $trustedHeaderSet argument of the Request::setTrustedProxies() method instead. return: string |
setMethod($method) X-Ref |
Sets the request method. param: string $method |
getMethod() X-Ref |
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. return: string The request method |
getRealMethod() X-Ref |
Gets the "real" request method. return: string The request method |
getMimeType($format) X-Ref |
Gets the mime type associated with the format. param: string $format The format return: string|null The associated mime type (null if not found) |
getMimeTypes($format) X-Ref |
Gets the mime types associated with the format. param: string $format The format return: array The associated mime types |
getFormat($mimeType) X-Ref |
Gets the format associated with the mime type. param: string $mimeType The associated mime type return: string|null The format (null if not found) |
setFormat($format, $mimeTypes) X-Ref |
Associates a format with mime types. param: string $format The format param: string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type) |
getRequestFormat($default = 'html') X-Ref |
Gets the request format. Here is the process to determine the format: * format defined by the user (with setRequestFormat()) * _format request attribute * $default param: string|null $default The default format return: string|null The request format |
setRequestFormat($format) X-Ref |
Sets the request format. param: string $format The request format |
getContentType() X-Ref |
Gets the format associated with the request. return: string|null The format (null if no content type is present) |
setDefaultLocale($locale) X-Ref |
Sets the default locale. param: string $locale |
getDefaultLocale() X-Ref |
Get the default locale. return: string |
setLocale($locale) X-Ref |
Sets the locale. param: string $locale |
getLocale() X-Ref |
Get the locale. return: string |
isMethod($method) X-Ref |
Checks if the request method is of specified type. param: string $method Uppercase request method (GET, POST etc) return: bool |
isMethodSafe() X-Ref |
Checks whether or not the method is safe. param: bool $andCacheable Adds the additional condition that the method should be cacheable. True by default. return: bool |
isMethodIdempotent() X-Ref |
Checks whether or not the method is idempotent. return: bool |
isMethodCacheable() X-Ref |
Checks whether the method is cacheable or not. return: bool True for GET and HEAD, false otherwise |
getProtocolVersion() X-Ref |
Returns the protocol version. If the application is behind a proxy, the protocol version used in the requests between the client and the proxy and between the proxy and the server might be different. This returns the former (from the "Via" header) if the proxy is trusted (see "setTrustedProxies()"), otherwise it returns the latter (from the "SERVER_PROTOCOL" server parameter). return: string |
getContent($asResource = false) X-Ref |
Returns the request body content. param: bool $asResource If true, a resource will be returned return: string|resource The request body content or a resource to read the body stream |
getETags() X-Ref |
Gets the Etags. return: array The entity tags |
isNoCache() X-Ref |
return: bool |
getPreferredLanguage(array $locales = null) X-Ref |
Returns the preferred language. param: array $locales An array of ordered available locales return: string|null The preferred locale |
getLanguages() X-Ref |
Gets a list of languages acceptable by the client browser. return: array Languages ordered in the user browser preferences |
getCharsets() X-Ref |
Gets a list of charsets acceptable by the client browser. return: array List of charsets in preferable order |
getEncodings() X-Ref |
Gets a list of encodings acceptable by the client browser. return: array List of encodings in preferable order |
getAcceptableContentTypes() X-Ref |
Gets a list of content types acceptable by the client browser. return: array List of content types in preferable order |
isXmlHttpRequest() X-Ref |
Returns true if the request is a XMLHttpRequest. It works if your JavaScript library sets an X-Requested-With HTTP header. It is known to work with common JavaScript frameworks: return: bool true if the request is an XMLHttpRequest, false otherwise |
prepareRequestUri() X-Ref |
No description |
prepareBaseUrl() X-Ref |
Prepares the base URL. return: string |
prepareBasePath() X-Ref |
Prepares the base path. return: string base path |
preparePathInfo() X-Ref |
Prepares the path info. return: string path info |
initializeFormats() X-Ref |
Initializes HTTP request formats. |
setPhpDefaultLocale($locale) X-Ref |
Sets the default PHP locale. param: string $locale |
getUrlencodedPrefix($string, $prefix) X-Ref |
Returns the prefix as encoded in the string when the string starts with the given prefix, false otherwise. param: string $string The urlencoded string param: string $prefix The prefix not encoded return: string|false The prefix as it is encoded in $string, or false |
createRequestFromFactory(array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], $content = null) X-Ref |
No description |
isFromTrustedProxy() X-Ref |
Indicates whether this request originated from a trusted proxy. This can be useful to determine whether or not to trust the contents of a proxy-specific header. return: bool true if the request came from a trusted proxy, false otherwise |
getTrustedValues($type, $ip = null) X-Ref |
No description |
normalizeAndFilterClientIps(array $clientIps, $ip) X-Ref |
No description |
Generated: Mon Nov 25 19:05:08 2024 | Cross-referenced by PHPXref 0.7.1 |