W3cubDocs

/Laravel 5.4

InteractsWithInput

trait InteractsWithInput (View source)

Methods

string|array

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

Retrieve a server variable from the request.

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|null

bearerToken()

Get the bearer token from the request headers.

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 containing the provided keys with values 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.

bool

hasFile(string $key)

Determine if the uploaded data contains a file.

UploadedFile|array|null

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

Retrieve a file from the request.

Details

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

bool hasHeader(string $key)

Determine if a header is set on the request.

Parameters

string

$key

Return Value

bool

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

string|null bearerToken()

Get the bearer token from the request headers.

Return Value

string|null

bool exists(string|array $key)

Determine if the request contains a given input item key.

Parameters

string|array

$key

Return Value

bool

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

array all()

Get all of the input and files for the request.

Return Value

array

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

array only(array|mixed $keys)

Get a subset containing the provided keys with values from the input data.

Parameters

array|mixed

$keys

Return Value

array

array except(array|mixed $keys)

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

Parameters

array|mixed

$keys

Return Value

array

array intersect(array|mixed $keys)

Intersect an array of items with the input data.

Parameters

array|mixed

$keys

Return Value

array

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

bool hasCookie(string $key)

Determine if a cookie is set on the request.

Parameters

string

$key

Return Value

bool

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

array allFiles()

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

Return Value

array

bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string

$key

Return Value

bool

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

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Http/Concerns/InteractsWithInput.html