Illuminate\Http\Request

class Request extends Request implements Arrayable, ArrayAccess (View source)

Traits

Macroable

Methods

static void

macro( string $name, callable $macro)

from Macroable

static bool

hasMacro( string $name)

Checks if macro is registered.

from Macroable

static mixed

__callStatic( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

mixed

__call( string $method, array $parameters)

Dynamically handle calls to the class.

from Macroable

static Request

capture()

Create a new Illuminate HTTP request from server variables.

$this

instance()

Return the Request instance.

string

method()

Get the request method.

string

root()

Get the root URL for the application.

string

url()

Get the URL (no query string) for the request.

string

fullUrl()

Get the full URL for the request.

string

fullUrlWithQuery( array $query)

Get the full URL for the request with the added query string parameters.

string

path()

Get the current path info for the request.

string

decodedPath()

Get the current encoded path info for the request.

string|null

segment( int $index, string|null $default = null)

Get a segment from the URI (1 based index).

array

segments()

Get all of the segments for the request path.

bool

is()

Determine if the current request URI matches a pattern.

bool

fullUrlIs()

Determine if the current request URL and query string matches a pattern.

bool

ajax()

Determine if the request is the result of an AJAX call.

bool

pjax()

Determine if the request is the result of an PJAX call.

bool

secure()

Determine if the request is over HTTPS.

string

ip()

Returns the client IP address.

array

ips()

Returns the client IP addresses.

bool

exists( string|array $key)

Determine if the request contains a given input item key.

bool

has( string|array $key)

Determine if the request contains a non-empty value for an input item.

array

all()

Get all of the input and files for the request.

string|array

input( string $key = null, string|array|null $default = null)

Retrieve an input item from the request.

array

only( array|mixed $keys)

Get a subset of the items from the input data.

array

except( array|mixed $keys)

Get all of the input except for a specified array of items.

array

intersect( array|mixed $keys)

Intersect an array of items with the input data.

string|array

query( string $key = null, string|array|null $default = null)

Retrieve a query string item from the request.

bool

hasCookie( string $key)

Determine if a cookie is set on the request.

string|array

cookie( string $key = null, string|array|null $default = null)

Retrieve a cookie from the request.

array

allFiles()

Get an array of all of the files on the request.

UploadedFile|array|null

file( string $key = null, mixed $default = null)

Retrieve a file from the request.

bool

hasFile( string $key)

Determine if the uploaded data contains a file.

bool

hasHeader( string $key)

Determine if a header is set on the request.

string|array

header( string $key = null, string|array|null $default = null)

Retrieve a header from the request.

string|array

server( string $key = null, string|array|null $default = null)

Retrieve a server variable from the request.

string|array

old( string $key = null, string|array|null $default = null)

Retrieve an old input item.

void

flash( string $filter = null, array $keys = array())

Flash the input for the current request to the session.

void

flashOnly( array|mixed $keys)

Flash only some of the input to the session.

void

flashExcept( array|mixed $keys)

Flash only some of the input to the session.

void

flush()

Flush all of the old input from the session.

void

merge( array $input)

Merge new input into the current request's input array.

void

replace( array $input)

Replace the input for the current request.

mixed

json( string $key = null, mixed $default = null)

Get the JSON payload for the request.

static bool

matchesType( string $actual, string $type)

Determine if the given content types match.

bool

isJson()

Determine if the request is sending JSON.

bool

wantsJson()

Determine if the current request is asking for JSON in return.

bool

accepts( string|array $contentTypes)

Determines whether the current requests accepts a given content type.

string|null

prefers( string|array $contentTypes)

Return the most suitable content type from the given array based on content negotiation.

bool

acceptsJson()

Determines whether a request accepts JSON.

bool

acceptsHtml()

Determines whether a request accepts HTML.

string

format( string $default = 'html')

Get the data format expected in the response.

string|null

bearerToken()

Get the bearer token from the request headers.

static Request

createFromBase( Request $request)

Create an Illuminate request from a Symfony instance.

duplicate( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)

{@inheritdoc}

Store

session()

Get the session associated with the request.

mixed

user( string|null $guard = null)

Get the user making the request.

Route|object|string

route( string|null $param = null)

Get the route handling the request.

string

fingerprint()

Get a unique fingerprint for the request / route / IP address.

Closure

getUserResolver()

Get the user resolver callback.

$this

setUserResolver( Closure $callback)

Set the user resolver callback.

Closure

getRouteResolver()

Get the route resolver callback.

$this

setRouteResolver( Closure $callback)

Set the route resolver callback.

array

toArray()

Get all of the input and files for the request.

bool

offsetExists( string $offset)

Determine if the given offset exists.

mixed

offsetGet( string $offset)

Get the value at the given offset.

void

offsetSet( string $offset, mixed $value)

Set the value at the given offset.

void

offsetUnset( string $offset)

Remove the value at the given offset.

bool

__isset( string $key)

Check if an input element is set on the request.

mixed

__get( string $key)

Get an input element from the request.

Details

in Macroable at line line 24
`static void macro( string $name, callable $macro)`

Parameters

string	$name
callable	$macro

Return Value

void

in Macroable at line line 35
`static bool hasMacro( string $name)`

Checks if macro is registered.

Parameters

string

$name

Return Value

bool

in Macroable at line line 49
`static mixed __callStatic( string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line line 71
`mixed __call( string $method, array $parameters)`

Dynamically handle calls to the class.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

at line line 53
`static Request capture()`

Create a new Illuminate HTTP request from server variables.

Return Value

Request

at line line 65
`$this instance()`

Return the Request instance.

Return Value

$this

at line line 75
`string method()`

Get the request method.

Return Value

string

at line line 85
`string root()`

Get the root URL for the application.

Return Value

string

at line line 95
`string url()`

Get the URL (no query string) for the request.

Return Value

string

at line line 105
`string fullUrl()`

Get the full URL for the request.

Return Value

string

at line line 120
`string fullUrlWithQuery( array $query)`

Get the full URL for the request with the added query string parameters.

Parameters

array

$query

Return Value

string

at line line 132
`string path()`

Get the current path info for the request.

Return Value

string

at line line 144
`string decodedPath()`

Get the current encoded path info for the request.

Return Value

string

at line line 156
`string|null segment( int $index, string|null $default = null)`

Get a segment from the URI (1 based index).

Parameters

int	$index
string\|null	$default

Return Value

string|null

at line line 166
`array segments()`

Get all of the segments for the request path.

Return Value

array

at line line 181
`bool is()`

Determine if the current request URI matches a pattern.

Return Value

bool

at line line 198
`bool fullUrlIs()`

Determine if the current request URL and query string matches a pattern.

Return Value

bool

at line line 216
`bool ajax()`

Determine if the request is the result of an AJAX call.

Return Value

bool

at line line 226
`bool pjax()`

Determine if the request is the result of an PJAX call.

Return Value

bool

at line line 236
`bool secure()`

Determine if the request is over HTTPS.

Return Value

bool

at line line 246
`string ip()`

Returns the client IP address.

Return Value

string

at line line 256
`array ips()`

Returns the client IP addresses.

Return Value

array

at line line 267
`bool exists( string|array $key)`

Determine if the request contains a given input item key.

Parameters

string|array

$key

Return Value

bool

at line line 288
`bool has( string|array $key)`

Determine if the request contains a non-empty value for an input item.

Parameters

string|array

$key

Return Value

bool

at line line 321
`array all()`

Get all of the input and files for the request.

Return Value

array

at line line 333
`string|array input( string $key = null, string|array|null $default = null)`

Retrieve an input item from the request.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 346
`array only( array|mixed $keys)`

Get a subset of the items from the input data.

Parameters

array|mixed

$keys

Return Value

array

at line line 367
`array except( array|mixed $keys)`

Get all of the input except for a specified array of items.

Parameters

array|mixed

$keys

Return Value

array

at line line 384
`array intersect( array|mixed $keys)`

Intersect an array of items with the input data.

Parameters

array|mixed

$keys

Return Value

array

at line line 396
`string|array query( string $key = null, string|array|null $default = null)`

Retrieve a query string item from the request.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 407
`bool hasCookie( string $key)`

Determine if a cookie is set on the request.

Parameters

string

$key

Return Value

bool

at line line 419
`string|array cookie( string $key = null, string|array|null $default = null)`

Retrieve a cookie from the request.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 429
`array allFiles()`

Get an array of all of the files on the request.

Return Value

array

at line line 464
`UploadedFile|array|null file( string $key = null, mixed $default = null)`

Retrieve a file from the request.

Parameters

string	$key
mixed	$default

Return Value

UploadedFile|array|null

at line line 475
`bool hasFile( string $key)`

Determine if the uploaded data contains a file.

Parameters

string

$key

Return Value

bool

at line line 507
`bool hasHeader( string $key)`

Determine if a header is set on the request.

Parameters

string

$key

Return Value

bool

at line line 519
`string|array header( string $key = null, string|array|null $default = null)`

Retrieve a header from the request.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 531
`string|array server( string $key = null, string|array|null $default = null)`

Retrieve a server variable from the request.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 543
`string|array old( string $key = null, string|array|null $default = null)`

Retrieve an old input item.

Parameters

string	$key
string\|array\|null	$default

Return Value

string|array

at line line 555
`void flash( string $filter = null, array $keys = array())`

Flash the input for the current request to the session.

Parameters

string	$filter
array	$keys

Return Value

void

at line line 568
`void flashOnly( array|mixed $keys)`

Flash only some of the input to the session.

Parameters

array|mixed

$keys

Return Value

void

at line line 581
`void flashExcept( array|mixed $keys)`

Flash only some of the input to the session.

Parameters

array|mixed

$keys

Return Value

void

at line line 593
`void flush()`

Flush all of the old input from the session.

Return Value

void

at line line 621
`void merge( array $input)`

Merge new input into the current request's input array.

Parameters

array

$input

Return Value

void

at line line 632
`void replace( array $input)`

Replace the input for the current request.

Parameters

array

$input

Return Value

void

at line line 644
`mixed json( string $key = null, mixed $default = null)`

Get the JSON payload for the request.

Parameters

string	$key
mixed	$default

Return Value

mixed

at line line 678
`static bool matchesType( string $actual, string $type)`

Determine if the given content types match.

Parameters

string	$actual
string	$type

Return Value

bool

at line line 694
`bool isJson()`

Determine if the request is sending JSON.

Return Value

bool

at line line 704
`bool wantsJson()`

Determine if the current request is asking for JSON in return.

Return Value

bool

at line line 717
`bool accepts( string|array $contentTypes)`

Determines whether the current requests accepts a given content type.

Parameters

string|array

$contentTypes

Return Value

bool

at line line 748
`string|null prefers( string|array $contentTypes)`

Return the most suitable content type from the given array based on content negotiation.

Parameters

string|array

$contentTypes

Return Value

string|null

at line line 778
`bool acceptsJson()`

Determines whether a request accepts JSON.

Return Value

bool

at line line 788
`bool acceptsHtml()`

Determines whether a request accepts HTML.

Return Value

bool

at line line 799
`string format( string $default = 'html')`

Get the data format expected in the response.

Parameters

string

$default

Return Value

string

at line line 815
`string|null bearerToken()`

Get the bearer token from the request headers.

Return Value

string|null

at line line 830
`static Request createFromBase( Request $request)`

Create an Illuminate request from a Symfony instance.

Parameters

Request

$request

Return Value

Request

at line line 855
`duplicate( array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)`

{@inheritdoc}

Parameters

array	$query
array	$request
array	$attributes
array	$cookies
array	$files
array	$server

at line line 867
`Store session()`

Get the session associated with the request.

Return Value

Store

Exceptions

RuntimeException

at line line 882
`mixed user( string|null $guard = null)`

Get the user making the request.

Parameters

string|null

$guard

Return Value

mixed

at line line 894
`Route|object|string route( string|null $param = null)`

Get the route handling the request.

Parameters

string|null

$param

Return Value

Route|object|string

at line line 912
`string fingerprint()`

Get a unique fingerprint for the request / route / IP address.

Return Value

string

Exceptions

RuntimeException

at line line 931
`Closure getUserResolver()`

Get the user resolver callback.

Return Value

Closure

at line line 944
`$this setUserResolver( Closure $callback)`

Set the user resolver callback.

Parameters

Closure

$callback

Return Value

$this

at line line 956
`Closure getRouteResolver()`

Get the route resolver callback.

Return Value

Closure

at line line 969
`$this setRouteResolver( Closure $callback)`

Set the route resolver callback.

Parameters

Closure

$callback

Return Value

$this

at line line 981
`array toArray()`

Get all of the input and files for the request.

Return Value

array

at line line 992
`bool offsetExists( string $offset)`

Determine if the given offset exists.

Parameters

string

$offset

Return Value

bool

at line line 1003
`mixed offsetGet( string $offset)`

Get the value at the given offset.

Parameters

string

$offset

Return Value

mixed

at line line 1015
`void offsetSet( string $offset, mixed $value)`

Set the value at the given offset.

Parameters

string	$offset
mixed	$value

Return Value

void

at line line 1026
`void offsetUnset( string $offset)`

Remove the value at the given offset.

Parameters

string

$offset

Return Value

void

at line line 1037
`bool __isset( string $key)`

Check if an input element is set on the request.

Parameters

string

$key

Return Value

bool

at line line 1048
`mixed __get( string $key)`

Get an input element from the request.

Parameters

string

$key

Return Value

mixed

Request

Traits

Methods

Details

in Macroable at line line 24 static void macro( string $name, callable $macro)

Parameters

Return Value

in Macroable at line line 35 static bool hasMacro( string $name)

Parameters

Return Value

in Macroable at line line 49 static mixed __callStatic( string $method, array $parameters)

Parameters

Return Value

Exceptions

in Macroable at line line 71 mixed __call( string $method, array $parameters)

Parameters

Return Value

Exceptions

at line line 53 static Request capture()

Return Value

at line line 65 $this instance()

Return Value

at line line 75 string method()

Return Value

at line line 85 string root()

Return Value

at line line 95 string url()

Return Value

at line line 105 string fullUrl()

Return Value

at line line 120 string fullUrlWithQuery( array $query)

Parameters

Return Value

at line line 132 string path()

Return Value

at line line 144 string decodedPath()

Return Value

at line line 156 string|null segment( int $index, string|null $default = null)

Parameters

Return Value

at line line 166 array segments()

Return Value

at line line 181 bool is()

Return Value

at line line 198 bool fullUrlIs()

Return Value

at line line 216 bool ajax()

Return Value

at line line 226 bool pjax()

Return Value

at line line 236 bool secure()

Return Value

at line line 246 string ip()

Return Value

at line line 256 array ips()

Return Value

at line line 267 bool exists( string|array $key)

Parameters

Return Value

at line line 288 bool has( string|array $key)

Parameters

Return Value

at line line 321 array all()

Return Value

at line line 333 string|array input( string $key = null, string|array|null $default = null)

Parameters

Return Value

at line line 346 array only( array|mixed $keys)

Parameters

Return Value

at line line 367 array except( array|mixed $keys)

Parameters

Return Value

at line line 384 array intersect( array|mixed $keys)

Parameters

Return Value

at line line 396 string|array query( string $key = null, string|array|null $default = null)

Parameters

Return Value

at line line 407 bool hasCookie( string $key)

in Macroable at line line 24
`static void macro( string $name, callable $macro)`

in Macroable at line line 35
`static bool hasMacro( string $name)`

in Macroable at line line 49
`static mixed __callStatic( string $method, array $parameters)`

in Macroable at line line 71
`mixed __call( string $method, array $parameters)`

at line line 53
`static Request capture()`

at line line 65
`$this instance()`

at line line 75
`string method()`

at line line 85
`string root()`

at line line 95
`string url()`

at line line 105
`string fullUrl()`

at line line 120
`string fullUrlWithQuery( array $query)`

at line line 132
`string path()`

at line line 144
`string decodedPath()`

at line line 156
`string|null segment( int $index, string|null $default = null)`

at line line 166
`array segments()`

at line line 181
`bool is()`

at line line 198
`bool fullUrlIs()`

at line line 216
`bool ajax()`

at line line 226
`bool pjax()`

at line line 236
`bool secure()`

at line line 246
`string ip()`

at line line 256
`array ips()`

at line line 267
`bool exists( string|array $key)`

at line line 288
`bool has( string|array $key)`

at line line 321
`array all()`

at line line 333
`string|array input( string $key = null, string|array|null $default = null)`

at line line 346
`array only( array|mixed $keys)`

at line line 367
`array except( array|mixed $keys)`

at line line 384
`array intersect( array|mixed $keys)`

at line line 396
`string|array query( string $key = null, string|array|null $default = null)`

at line line 407
`bool hasCookie( string $key)`

at line line 419
`string|array cookie( string $key = null, string|array|null $default = null)`

at line line 429
`array allFiles()`

at line line 464
`UploadedFile|array|null file( string $key = null, mixed $default = null)`

at line line 475
`bool hasFile( string $key)`

at line line 507
`bool hasHeader( string $key)`

at line line 519
`string|array header( string $key = null, string|array|null $default = null)`

at line line 531
`string|array server( string $key = null, string|array|null $default = null)`

at line line 543
`string|array old( string $key = null, string|array|null $default = null)`

at line line 555
`void flash( string $filter = null, array $keys = array())`

at line line 568
`void flashOnly( array|mixed $keys)`

at line line 581
`void flashExcept( array|mixed $keys)`

at line line 593
`void flush()`

at line line 621
`void merge( array $input)`

at line line 632
`void replace( array $input)`

at line line 644
`mixed json( string $key = null, mixed $default = null)`

at line line 678
`static bool matchesType( string $actual, string $type)`

at line line 694
`bool isJson()`

at line line 704
`bool wantsJson()`

at line line 717
`bool accepts( string|array $contentTypes)`

at line line 748
`string|null prefers( string|array $contentTypes)`

at line line 778
`bool acceptsJson()`

at line line 788
`bool acceptsHtml()`

at line line 799
`string format( string $default = 'html')`

at line line 815
`string|null bearerToken()`

at line line 830
`static Request createFromBase( Request $request)`