PHP Class Request, someline-starter

This makes PHP code quality analyzer tools very happy.
See also: http://php.net/manual/en/reserved.variables.request.php
Afficher le fichier Open project: someline/someline-starter Class Usage Examples

Méthodes publiques

Méthode Description
accepts ( string | array $contentTypes ) : boolean Determines whether the current requests accepts a given content type.
acceptsHtml ( ) : boolean Determines whether a request accepts HTML.
acceptsJson ( ) : boolean Determines whether a request accepts JSON.
ajax ( ) : boolean Determine if the request is the result of an AJAX call.
all ( ) : array Get all of the input and files for the request.
allFiles ( ) : array Get an array of all of the files on the request.
bearerToken ( ) : string | null Get the bearer token from the request headers.
capture ( ) : static Create a new Illuminate HTTP request from server variables.
cookie ( string $key = null, string | array | null $default = null ) : string | array Retrieve a cookie from the request.
create ( string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Request Creates a Request based on a given URI and configuration.
createFromBase ( Request $request ) : Illuminate\Http\Request Create an Illuminate request from a Symfony instance.
createFromGlobals ( ) : Request Creates a new request with values from PHP's super globals.
decodedPath ( ) : string Get the current encoded path info for the request.
duplicate ( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null ) : Request Clones a request and overrides some of its parameters.
enableHttpMethodParameterOverride ( ) Enables support for the _method request parameter to determine the intended HTTP method.
except ( array | mixed $keys ) : array Get all of the input except for a specified array of items.
exists ( string | array $key ) : boolean Determine if the request contains a given input item key.
file ( string $key = null, mixed $default = null ) : Illuminate\Http\UploadedFile | array | null Retrieve a file from the request.
fingerprint ( ) : string Get a unique fingerprint for the request / route / IP address.
flash ( string $filter = null, array $keys = [] ) : void Flash the input for the current request to the session.
flashExcept ( array | mixed $keys ) : void Flash only some of the input to the session.
flashOnly ( array | mixed $keys ) : void Flash only some of the input to the session.
flush ( ) : void Flush all of the old input from the session.
format ( string $default = 'html' ) : string Get the data format expected in the response.
fullUrl ( ) : string Get the full URL for the request.
fullUrlIs ( ) : boolean Determine if the current request URL and query string matches a pattern.
fullUrlWithQuery ( array $query ) : string Get the full URL for the request with the added query string parameters.
get ( string $key, mixed $default = null ) : mixed Gets a "parameter" value from any bag.
getAcceptableContentTypes ( ) : array Gets a list of content types acceptable by the client browser.
getBasePath ( ) : string Returns the root path from which this request is executed.
getBaseUrl ( ) : string Returns the root URL from which this request is executed.
getCharsets ( ) : array Gets a list of charsets acceptable by the client browser.
getClientIp ( ) : string Returns the client IP address.
getClientIps ( ) : array Returns the client IP addresses.
getContent ( boolean $asResource = false ) : string | resource Returns the request body content.
getContentType ( ) : string | null Gets the format associated with the request.
getDefaultLocale ( ) : string Get the default locale.
getETags ( ) : array Gets the Etags.
getEncodings ( ) : array Gets a list of encodings acceptable by the client browser.
getFormat ( string $mimeType ) : string | null Gets the format associated with the mime type.
getHost ( ) : string Returns the host name.
getHttpHost ( ) : string Returns the HTTP host being requested.
getHttpMethodParameterOverride ( ) : boolean Checks whether support for the _method request parameter is enabled.
getLanguages ( ) : array Gets a list of languages acceptable by the client browser.
getLocale ( ) : string Get the locale.
getMethod ( ) : string Gets the request "intended" method.
getMimeType ( string $format ) : string Gets the mime type associated with the format.
getPassword ( ) : string | null Returns the password.
getPathInfo ( ) : string Returns the path being requested relative to the executed script.
getPort ( ) : string Returns the port on which the request is made.
getPreferredLanguage ( array $locales = null ) : string | null Returns the preferred language.
getQueryString ( ) : string | null Generates the normalized query string for the Request.
getRealMethod ( ) : string Gets the "real" request method.
getRelativeUriForPath ( string $path ) : string Returns the path as relative reference from the current Request path.
getRequestFormat ( string $default = 'html' ) : string Gets the request format.
getRequestUri ( ) : string Returns the requested URI (path and query string).
getRouteResolver ( ) : Closure Get the route resolver callback.
getScheme ( ) : string Gets the request's scheme.
getSchemeAndHttpHost ( ) : string Gets the scheme and HTTP host.
getScriptName ( ) : string Returns current script name.
getSession ( ) : Symfony\Component\HttpFoundation\SessionInterface | null Gets the Session.
getTrustedHeaderName ( string $key ) : string Gets the trusted proxy header name.
getTrustedHosts ( ) : array Gets the list of trusted host patterns.
getTrustedProxies ( ) : array Gets the list of trusted proxies.
getUri ( ) : string Generates a normalized URI (URL) for the Request.
getUriForPath ( string $path ) : string Generates a normalized URI for the given path.
getUser ( ) : string | null Returns the user.
getUserInfo ( ) : string Gets the user info.
getUserResolver ( ) : Closure Get the user resolver callback.
has ( string | array $key ) : boolean Determine if the request contains a non-empty value for an input item.
hasCookie ( string $key ) : boolean Determine if a cookie is set on the request.
hasFile ( string $key ) : boolean Determine if the uploaded data contains a file.
hasHeader ( string $key ) : boolean Determine if a header is set on the request.
hasMacro ( string $name ) : boolean Checks if macro is registered.
hasPreviousSession ( ) : boolean Whether the request contains a Session which was started in one of the previous requests.
hasSession ( ) : boolean Whether the request contains a Session object.
header ( string $key = null, string | array | null $default = null ) : string | array Retrieve a header from the request.
initialize ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string | resource $content = null ) Sets the parameters for this request.
input ( string $key = null, string | array | null $default = null ) : string | array Retrieve an input item from the request.
instance ( ) Return the Request instance.
intersect ( array | mixed $keys ) : array Intersect an array of items with the input data.
ip ( ) : string Returns the client IP address.
ips ( ) : array Returns the client IP addresses.
is ( ) : boolean Determine if the current request URI matches a pattern.
isJson ( ) : boolean Determine if the request is sending JSON.
isMethod ( string $method ) : boolean Checks if the request method is of specified type.
isMethodSafe ( ) : boolean Checks whether the method is safe or not.
isNoCache ( ) : boolean
isSecure ( ) : boolean Checks whether the request is secure or not.
isXmlHttpRequest ( ) : boolean Returns true if the request is a XMLHttpRequest.
json ( string $key = null, mixed $default = null ) : mixed Get the JSON payload for the request.
macro ( string $name, callable $macro ) : void Register a custom macro.
matchesType ( string $actual, string $type ) : boolean Determine if the given content types match.
merge ( array $input ) : void Merge new input into the current request's input array.
method ( ) : string Get the request method.
normalizeQueryString ( string $qs ) : string Normalizes a query string.
offsetExists ( string $offset ) : boolean Determine if the given offset exists.
offsetGet ( string $offset ) : mixed Get the value at the given offset.
offsetSet ( string $offset, mixed $value ) : void Set the value at the given offset.
offsetUnset ( string $offset ) : void Remove the value at the given offset.
old ( string $key = null, string | array | null $default = null ) : string | array Retrieve an old input item.
only ( array | mixed $keys ) : array Get a subset of the items from the input data.
overrideGlobals ( ) Overrides the PHP global variables according to this request instance.
path ( ) : string Get the current path info for the request.
pjax ( ) : boolean Determine if the request is the result of an PJAX call.
prefers ( string | array $contentTypes ) : string | null Return the most suitable content type from the given array based on content negotiation.
query ( string $key = null, string | array | null $default = null ) : string | array Retrieve a query string item from the request.
replace ( array $input ) : void Replace the input for the current request.
root ( ) : string Get the root URL for the application.
route ( string | null $param = null ) : Illuminate\Routing\Route | object | string Get the route handling the request.
secure ( ) : boolean Determine if the request is over HTTPS.
segment ( integer $index, string | null $default = null ) : string | null Get a segment from the URI (1 based index).
segments ( ) : array Get all of the segments for the request path.
server ( string $key = null, string | array | null $default = null ) : string | array Retrieve a server variable from the request.
session ( ) : Illuminate\Session\Store Get the session associated with the request.
setDefaultLocale ( string $locale ) Sets the default locale.
setFactory ( callable | null $callable ) Sets a callable able to create a Request instance.
setFormat ( string $format, string | array $mimeTypes ) Associates a format with mime types.
setLocale ( string $locale ) Sets the locale.
setMethod ( string $method ) Sets the request method.
setRequestFormat ( string $format ) Sets the request format.
setRouteResolver ( Closure $callback ) Set the route resolver callback.
setSession ( Symfony\Component\HttpFoundation\SessionInterface $session ) Sets the Session.
setTrustedHeaderName ( string $key, string $value ) Sets the name for trusted headers.
setTrustedHosts ( array $hostPatterns ) Sets a list of trusted host patterns.
setTrustedProxies ( array $proxies ) Sets a list of trusted proxies.
setUserResolver ( Closure $callback ) Set the user resolver callback.
toArray ( ) : array Get all of the input and files for the request.
url ( ) : string Get the URL (no query string) for the request.
user ( string | null $guard = null ) : mixed Get the user making the request.
wantsJson ( ) : boolean Determine if the current request is asking for JSON in return.

Method Details

accepts() public static méthode

Determines whether the current requests accepts a given content type.
public static accepts ( string | array $contentTypes ) : boolean
$contentTypes string | array
Résultat boolean

acceptsHtml() public static méthode

Determines whether a request accepts HTML.
public static acceptsHtml ( ) : boolean
Résultat boolean

acceptsJson() public static méthode

Determines whether a request accepts JSON.
public static acceptsJson ( ) : boolean
Résultat boolean

ajax() public static méthode

Determine if the request is the result of an AJAX call.
public static ajax ( ) : boolean
Résultat boolean

all() public static méthode

Get all of the input and files for the request.
public static all ( ) : array
Résultat array

allFiles() public static méthode

Get an array of all of the files on the request.
public static allFiles ( ) : array
Résultat array

bearerToken() public static méthode

Get the bearer token from the request headers.
public static bearerToken ( ) : string | null
Résultat string | null

capture() public static méthode

Create a new Illuminate HTTP request from server variables.
public static capture ( ) : static
Résultat static

create() public static méthode

The information contained in the URI always take precedence over the other information (server and parameters).
public static create ( string $uri, string $method = 'GET', array $parameters = [], array $cookies = [], array $files = [], array $server = [], string $content = null ) : Request
$uri string The URI
$method string The HTTP method
$parameters array The query (GET) or request (POST) parameters
$cookies array The request cookies ($_COOKIE)
$files array The request files ($_FILES)
$server array The server parameters ($_SERVER)
$content string The raw body data
Résultat Request A Request instance

createFromBase() public static méthode

Create an Illuminate request from a Symfony instance.
public static createFromBase ( Request $request ) : Illuminate\Http\Request
$request Symfony\Component\HttpFoundation\Request
Résultat Illuminate\Http\Request

createFromGlobals() public static méthode

Creates a new request with values from PHP's super globals.
public static createFromGlobals ( ) : Request
Résultat Request A new request

decodedPath() public static méthode

Get the current encoded path info for the request.
public static decodedPath ( ) : string
Résultat string

duplicate() public static méthode

Clones a request and overrides some of its parameters.
public static duplicate ( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null ) : Request
$query array The GET parameters
$request array The POST parameters
$attributes array The request attributes (parameters parsed from the PATH_INFO, ...)
$cookies array The COOKIE parameters
$files array The FILES parameters
$server array The SERVER parameters
Résultat Request The duplicated request

enableHttpMethodParameterOverride() public static méthode

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.
public static enableHttpMethodParameterOverride ( )

except() public static méthode

Get all of the input except for a specified array of items.
public static except ( array | mixed $keys ) : array
$keys array | mixed
Résultat array

exists() public static méthode

Determine if the request contains a given input item key.
public static exists ( string | array $key ) : boolean
$key string | array
Résultat boolean

file() public static méthode

Retrieve a file from the request.
public static file ( string $key = null, mixed $default = null ) : Illuminate\Http\UploadedFile | array | null
$key string
$default mixed
Résultat Illuminate\Http\UploadedFile | array | null

fingerprint() public static méthode

Get a unique fingerprint for the request / route / IP address.
public static fingerprint ( ) : string
Résultat string

flash() public static méthode

Flash the input for the current request to the session.
public static flash ( string $filter = null, array $keys = [] ) : void
$filter string
$keys array
Résultat void

flashExcept() public static méthode

Flash only some of the input to the session.
public static flashExcept ( array | mixed $keys ) : void
$keys array | mixed
Résultat void

flashOnly() public static méthode

Flash only some of the input to the session.
public static flashOnly ( array | mixed $keys ) : void
$keys array | mixed
Résultat void

flush() public static méthode

Flush all of the old input from the session.
public static flush ( ) : void
Résultat void

format() public static méthode

Get the data format expected in the response.
public static format ( string $default = 'html' ) : string
$default string
Résultat string

fullUrl() public static méthode

Get the full URL for the request.
public static fullUrl ( ) : string
Résultat string

fullUrlIs() public static méthode

Determine if the current request URL and query string matches a pattern.
public static fullUrlIs ( ) : boolean
Résultat boolean

fullUrlWithQuery() public static méthode

Get the full URL for the request with the added query string parameters.
public static fullUrlWithQuery ( array $query ) : string
$query array
Résultat string

get() public static méthode

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
public static get ( string $key, mixed $default = null ) : mixed
$key string the key
$default mixed the default value if the parameter key does not exist
Résultat mixed

getAcceptableContentTypes() public static méthode

Gets a list of content types acceptable by the client browser.
public static getAcceptableContentTypes ( ) : array
Résultat array List of content types in preferable order

getBasePath() public static méthode

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'
public static getBasePath ( ) : string
Résultat string The raw path (i.e. not urldecoded)

getBaseUrl() public static méthode

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.
public static getBaseUrl ( ) : string
Résultat string The raw URL (i.e. not urldecoded)

getCharsets() public static méthode

Gets a list of charsets acceptable by the client browser.
public static getCharsets ( ) : array
Résultat array List of charsets in preferable order

getClientIp() public static méthode

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.
See also: getClientIps()
See also: http://en.wikipedia.org/wiki/X-Forwarded-For
public static getClientIp ( ) : string
Résultat string The client IP address

getClientIps() public static méthode

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.
See also: getClientIp()
public static getClientIps ( ) : array
Résultat array The client IP addresses

getContent() public static méthode

Returns the request body content.
public static getContent ( boolean $asResource = false ) : string | resource
$asResource boolean If true, a resource will be returned
Résultat string | resource The request body content or a resource to read the body stream

getContentType() public static méthode

Gets the format associated with the request.
public static getContentType ( ) : string | null
Résultat string | null The format (null if no content type is present)

getDefaultLocale() public static méthode

Get the default locale.
public static getDefaultLocale ( ) : string
Résultat string

getETags() public static méthode

Gets the Etags.
public static getETags ( ) : array
Résultat array The entity tags

getEncodings() public static méthode

Gets a list of encodings acceptable by the client browser.
public static getEncodings ( ) : array
Résultat array List of encodings in preferable order

getFormat() public static méthode

Gets the format associated with the mime type.
public static getFormat ( string $mimeType ) : string | null
$mimeType string The associated mime type
Résultat string | null The format (null if not found)

getHost() public static méthode

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 "setTrustedHeaderName()" with the "client-host" key.
public static getHost ( ) : string
Résultat string

getHttpHost() public static méthode

The port name will be appended to the host if it's non-standard.
public static getHttpHost ( ) : string
Résultat string

getHttpMethodParameterOverride() public static méthode

Checks whether support for the _method request parameter is enabled.
public static getHttpMethodParameterOverride ( ) : boolean
Résultat boolean True when the _method request parameter is enabled, false otherwise

getLanguages() public static méthode

Gets a list of languages acceptable by the client browser.
public static getLanguages ( ) : array
Résultat array Languages ordered in the user browser preferences

getLocale() public static méthode

Get the locale.
public static getLocale ( ) : string
Résultat string

getMethod() public static méthode

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.
See also: getRealMethod()
public static getMethod ( ) : string
Résultat string The request method

getMimeType() public static méthode

Gets the mime type associated with the format.
public static getMimeType ( string $format ) : string
$format string The format
Résultat string The associated mime type (null if not found)

getPassword() public static méthode

Returns the password.
public static getPassword ( ) : string | null
Résultat string | null

getPathInfo() public static méthode

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'
public static getPathInfo ( ) : string
Résultat string The raw path (i.e. not urldecoded)

getPort() public static méthode

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.
public static getPort ( ) : string
Résultat string

getPreferredLanguage() public static méthode

Returns the preferred language.
public static getPreferredLanguage ( array $locales = null ) : string | null
$locales array An array of ordered available locales
Résultat string | null The preferred locale

getQueryString() public static méthode

It builds a normalized query string, where keys/value pairs are alphabetized and have consistent escaping.
public static getQueryString ( ) : string | null
Résultat string | null A normalized query string for the Request

getRealMethod() public static méthode

Gets the "real" request method.
See also: getMethod()
public static getRealMethod ( ) : string
Résultat string The request method

getRelativeUriForPath() public static méthode

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"
public static getRelativeUriForPath ( string $path ) : string
$path string The target path
Résultat string The relative target path

getRequestFormat() public static méthode

Here is the process to determine the format: * format defined by the user (with setRequestFormat()) * _format request attribute * $default
public static getRequestFormat ( string $default = 'html' ) : string
$default string The default format
Résultat string The request format

getRequestUri() public static méthode

Returns the requested URI (path and query string).
public static getRequestUri ( ) : string
Résultat string The raw URI (i.e. not URI decoded)

getRouteResolver() public static méthode

Get the route resolver callback.
public static getRouteResolver ( ) : Closure
Résultat Closure

getScheme() public static méthode

Gets the request's scheme.
public static getScheme ( ) : string
Résultat string

getSchemeAndHttpHost() public static méthode

If the URL was called with basic authentication, the user and the password are not added to the generated string.
public static getSchemeAndHttpHost ( ) : string
Résultat string The scheme and HTTP host

getScriptName() public static méthode

Returns current script name.
public static getScriptName ( ) : string
Résultat string

getSession() public static méthode

Gets the Session.
public static getSession ( ) : Symfony\Component\HttpFoundation\SessionInterface | null
Résultat Symfony\Component\HttpFoundation\SessionInterface | null The session

getTrustedHeaderName() public static méthode

Gets the trusted proxy header name.
public static getTrustedHeaderName ( string $key ) : string
$key string The header key
Résultat string The header name

getTrustedHosts() public static méthode

Gets the list of trusted host patterns.
public static getTrustedHosts ( ) : array
Résultat array An array of trusted host patterns

getTrustedProxies() public static méthode

Gets the list of trusted proxies.
public static getTrustedProxies ( ) : array
Résultat array An array of trusted proxies

getUri() public static méthode

Generates a normalized URI (URL) for the Request.
See also: getQueryString()
public static getUri ( ) : string
Résultat string A normalized URI (URL) for the Request

getUriForPath() public static méthode

Generates a normalized URI for the given path.
public static getUriForPath ( string $path ) : string
$path string A path to use instead of the current one
Résultat string The normalized URI for the path

getUser() public static méthode

Returns the user.
public static getUser ( ) : string | null
Résultat string | null

getUserInfo() public static méthode

Gets the user info.
public static getUserInfo ( ) : string
Résultat string A user name and, optionally, scheme-specific information about how to gain authorization to access the server

getUserResolver() public static méthode

Get the user resolver callback.
public static getUserResolver ( ) : Closure
Résultat Closure

has() public static méthode

Determine if the request contains a non-empty value for an input item.
public static has ( string | array $key ) : boolean
$key string | array
Résultat boolean

hasCookie() public static méthode

Determine if a cookie is set on the request.
public static hasCookie ( string $key ) : boolean
$key string
Résultat boolean

hasFile() public static méthode

Determine if the uploaded data contains a file.
public static hasFile ( string $key ) : boolean
$key string
Résultat boolean

hasHeader() public static méthode

Determine if a header is set on the request.
public static hasHeader ( string $key ) : boolean
$key string
Résultat boolean

hasMacro() public static méthode

Checks if macro is registered.
public static hasMacro ( string $name ) : boolean
$name string
Résultat boolean

hasPreviousSession() public static méthode

Whether the request contains a Session which was started in one of the previous requests.
public static hasPreviousSession ( ) : boolean
Résultat boolean

hasSession() public static méthode

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.
public static hasSession ( ) : boolean
Résultat boolean true when the Request contains a Session object, false otherwise

header() public static méthode

Retrieve a header from the request.
public static header ( string $key = null, string | array | null $default = null ) : string | array
$key string
$default string | array | null
Résultat string | array

initialize() public static méthode

This method also re-initializes all properties.
public static initialize ( array $query = [], array $request = [], array $attributes = [], array $cookies = [], array $files = [], array $server = [], string | resource $content = null )
$query array The GET parameters
$request array The POST parameters
$attributes array The request attributes (parameters parsed from the PATH_INFO, ...)
$cookies array The COOKIE parameters
$files array The FILES parameters
$server array The SERVER parameters
$content string | resource The raw body data

input() public static méthode

Retrieve an input item from the request.
public static input ( string $key = null, string | array | null $default = null ) : string | array
$key string
$default string | array | null
Résultat string | array

instance() public static méthode

Return the Request instance.
public static instance ( )

intersect() public static méthode

Intersect an array of items with the input data.
public static intersect ( array | mixed $keys ) : array
$keys array | mixed
Résultat array

ip() public static méthode

Returns the client IP address.
public static ip ( ) : string
Résultat string

ips() public static méthode

Returns the client IP addresses.
public static ips ( ) : array
Résultat array

is() public static méthode

Determine if the current request URI matches a pattern.
public static is ( ) : boolean
Résultat boolean

isJson() public static méthode

Determine if the request is sending JSON.
public static isJson ( ) : boolean
Résultat boolean

isMethod() public static méthode

Checks if the request method is of specified type.
public static isMethod ( string $method ) : boolean
$method string Uppercase request method (GET, POST etc)
Résultat boolean

isMethodSafe() public static méthode

Checks whether the method is safe or not.
public static isMethodSafe ( ) : boolean
Résultat boolean

isNoCache() public static méthode

public static isNoCache ( ) : boolean
Résultat boolean

isSecure() public static méthode

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 "setTrustedHeaderName()" with the "client-proto" key.
public static isSecure ( ) : boolean
Résultat boolean

isXmlHttpRequest() public static méthode

It works if your JavaScript library sets an X-Requested-With HTTP header. It is known to work with common JavaScript frameworks:
See link: http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
public static isXmlHttpRequest ( ) : boolean
Résultat boolean true if the request is an XMLHttpRequest, false otherwise

json() public static méthode

Get the JSON payload for the request.
public static json ( string $key = null, mixed $default = null ) : mixed
$key string
$default mixed
Résultat mixed

macro() public static méthode

Register a custom macro.
public static macro ( string $name, callable $macro ) : void
$name string
$macro callable
Résultat void

matchesType() public static méthode

Determine if the given content types match.
public static matchesType ( string $actual, string $type ) : boolean
$actual string
$type string
Résultat boolean

merge() public static méthode

Merge new input into the current request's input array.
public static merge ( array $input ) : void
$input array
Résultat void

method() public static méthode

Get the request method.
public static method ( ) : string
Résultat string

normalizeQueryString() public static méthode

It builds a normalized query string, where keys/value pairs are alphabetized, have consistent escaping and unneeded delimiters are removed.
public static normalizeQueryString ( string $qs ) : string
$qs string Query string
Résultat string A normalized query string for the Request

offsetExists() public static méthode

Determine if the given offset exists.
public static offsetExists ( string $offset ) : boolean
$offset string
Résultat boolean

offsetGet() public static méthode

Get the value at the given offset.
public static offsetGet ( string $offset ) : mixed
$offset string
Résultat mixed

offsetSet() public static méthode

Set the value at the given offset.
public static offsetSet ( string $offset, mixed $value ) : void
$offset string
$value mixed
Résultat void

offsetUnset() public static méthode

Remove the value at the given offset.
public static offsetUnset ( string $offset ) : void
$offset string
Résultat void

old() public static méthode

Retrieve an old input item.
public static old ( string $key = null, string | array | null $default = null ) : string | array
$key string
$default string | array | null
Résultat string | array

only() public static méthode

Get a subset of the items from the input data.
public static only ( array | mixed $keys ) : array
$keys array | mixed
Résultat array

overrideGlobals() public static méthode

It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE. $_FILES is never overridden, see rfc1867
public static overrideGlobals ( )

path() public static méthode

Get the current path info for the request.
public static path ( ) : string
Résultat string

pjax() public static méthode

Determine if the request is the result of an PJAX call.
public static pjax ( ) : boolean
Résultat boolean

prefers() public static méthode

Return the most suitable content type from the given array based on content negotiation.
public static prefers ( string | array $contentTypes ) : string | null
$contentTypes string | array
Résultat string | null

query() public static méthode

Retrieve a query string item from the request.
public static query ( string $key = null, string | array | null $default = null ) : string | array
$key string
$default string | array | null
Résultat string | array

replace() public static méthode

Replace the input for the current request.
public static replace ( array $input ) : void
$input array
Résultat void

root() public static méthode

Get the root URL for the application.
public static root ( ) : string
Résultat string

route() public static méthode

Get the route handling the request.
public static route ( string | null $param = null ) : Illuminate\Routing\Route | object | string
$param string | null
Résultat Illuminate\Routing\Route | object | string

secure() public static méthode

Determine if the request is over HTTPS.
public static secure ( ) : boolean
Résultat boolean

segment() public static méthode

Get a segment from the URI (1 based index).
public static segment ( integer $index, string | null $default = null ) : string | null
$index integer
$default string | null
Résultat string | null

segments() public static méthode

Get all of the segments for the request path.
public static segments ( ) : array
Résultat array

server() public static méthode

Retrieve a server variable from the request.
public static server ( string $key = null, string | array | null $default = null ) : string | array
$key string
$default string | array | null
Résultat string | array

session() public static méthode

Get the session associated with the request.
public static session ( ) : Illuminate\Session\Store
Résultat Illuminate\Session\Store

setDefaultLocale() public static méthode

Sets the default locale.
public static setDefaultLocale ( string $locale )
$locale string

setFactory() public static méthode

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.
public static setFactory ( callable | null $callable )
$callable callable | null A PHP callable

setFormat() public static méthode

Associates a format with mime types.
public static setFormat ( string $format, string | array $mimeTypes )
$format string The format
$mimeTypes string | array The associated mime types (the preferred one must be the first as it will be used as the content type)

setLocale() public static méthode

Sets the locale.
public static setLocale ( string $locale )
$locale string

setMethod() public static méthode

Sets the request method.
public static setMethod ( string $method )
$method string

setRequestFormat() public static méthode

Sets the request format.
public static setRequestFormat ( string $format )
$format string The request format

setRouteResolver() public static méthode

Set the route resolver callback.
public static setRouteResolver ( Closure $callback )
$callback Closure

setSession() public static méthode

Sets the Session.
public static setSession ( Symfony\Component\HttpFoundation\SessionInterface $session )
$session Symfony\Component\HttpFoundation\SessionInterface The Session

setTrustedHeaderName() public static méthode

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()) Setting an empty value allows to disable the trusted header for the given key.
public static setTrustedHeaderName ( string $key, string $value )
$key string The header key
$value string The header name

setTrustedHosts() public static méthode

You should only list the hosts you manage using regexs.
public static setTrustedHosts ( array $hostPatterns )
$hostPatterns array A list of trusted host patterns

setTrustedProxies() public static méthode

You should only list the reverse proxies that you manage directly.
public static setTrustedProxies ( array $proxies )
$proxies array A list of trusted proxies

setUserResolver() public static méthode

Set the user resolver callback.
public static setUserResolver ( Closure $callback )
$callback Closure

toArray() public static méthode

Get all of the input and files for the request.
public static toArray ( ) : array
Résultat array

url() public static méthode

Get the URL (no query string) for the request.
public static url ( ) : string
Résultat string

user() public static méthode

Get the user making the request.
public static user ( string | null $guard = null ) : mixed
$guard string | null
Résultat mixed

wantsJson() public static méthode

Determine if the current request is asking for JSON in return.
public static wantsJson ( ) : boolean
Résultat boolean