InteractsWithInput

trait InteractsWithInput (View source)

Methods

string|array|null server(string|null $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|null header(string|null $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 given input item key.
bool hasAny(string|array $keys)

Determine if the request contains any of the given inputs.
$this|mixed whenHas(string $key, callable $callback)

Apply the callback if the request contains the given input item key.
bool filled(string|array $key)

Determine if the request contains a non-empty value for an input item.
bool isNotFilled(string|array $key)

Determine if the request contains an empty value for an input item.
bool anyFilled(string|array $keys)

Determine if the request contains a non-empty value for any of the given inputs.
$this|mixed whenFilled(string $key, callable $callback)

Apply the callback if the request contains a non-empty value for the given input item key.
bool missing(string|array $key)

Determine if the request is missing a given input item key.
bool isEmptyString(string $key)

Determine if the given input key is an empty string for "has".
array keys()

Get the keys for all of the input and files.
array all(array|mixed|null $keys = null)

Get all of the input and files for the request.
mixed input(string|null $key = null, mixed $default = null)

Retrieve an input item from the request.
bool boolean(string|null $key = null, bool $default = false)

Retrieve input as a boolean value.
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.
string|array|null query(string|null $key = null, string|array|null $default = null)

Retrieve a query string item from the request.
string|array|null post(string|null $key = null, string|array|null $default = null)

Retrieve a request payload item from the request.
bool hasCookie(string $key)

Determine if a cookie is set on the request.
string|array|null cookie(string|null $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.
array convertUploadedFiles(array $files)

Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.
bool hasFile(string $key)

Determine if the uploaded data contains a file.
bool isValidFile(mixed $file)

Check that the given file is a valid file instance.
UploadedFile|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.
string|array|null retrieveItem(string $source, string $key, string|array|null $default)

Retrieve a parameter item from a given source.

Details

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

Retrieve a server variable from the request.

Parameters

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

Return Value

string|array|null

bool hasHeader(string $key)

Determine if a header is set on the request.

Parameters

string $key

Return Value

bool

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

Retrieve a header from the request.

Parameters

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

Return Value

string|array|null

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 given input item key.

Parameters

string|array $key

Return Value

bool

bool hasAny(string|array $keys)

Determine if the request contains any of the given inputs.

Parameters

string|array $keys

Return Value

bool

$this|mixed whenHas(string $key, callable $callback)

Apply the callback if the request contains the given input item key.

Parameters

string $key
callable $callback

Return Value

$this|mixed

bool filled(string|array $key)

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

Parameters

string|array $key

Return Value

bool

bool isNotFilled(string|array $key)

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

Parameters

string|array $key

Return Value

bool

bool anyFilled(string|array $keys)

Determine if the request contains a non-empty value for any of the given inputs.

Parameters

string|array $keys

Return Value

bool

$this|mixed whenFilled(string $key, callable $callback)

Apply the callback if the request contains a non-empty value for the given input item key.

Parameters

string $key
callable $callback

Return Value

$this|mixed

bool missing(string|array $key)

Determine if the request is missing a given input item key.

Parameters

string|array $key

Return Value

bool

protected bool isEmptyString(string $key)

Determine if the given input key is an empty string for "has".

Parameters

string $key

Return Value

bool

array keys()

Get the keys for all of the input and files.

Return Value

array

array all(array|mixed|null $keys = null)

Get all of the input and files for the request.

Parameters

array|mixed|null $keys

Return Value

array

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

Retrieve an input item from the request.

Parameters

string|null $key
mixed $default

Return Value

mixed

bool boolean(string|null $key = null, bool $default = false)

Retrieve input as a boolean value.

Returns true when value is "1", "true", "on", and "yes". Otherwise, returns false.

Parameters

string|null $key
bool $default

Return Value

bool

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

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

Retrieve a query string item from the request.

Parameters

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

Return Value

string|array|null

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

Retrieve a request payload item from the request.

Parameters

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

Return Value

string|array|null

bool hasCookie(string $key)

Determine if a cookie is set on the request.

Parameters

string $key

Return Value

bool

Retrieve a cookie from the request.

Parameters

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

Return Value

string|array|null

array allFiles()

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

Return Value

array

protected array convertUploadedFiles(array $files)

Convert the given array of Symfony UploadedFiles to custom Laravel UploadedFiles.

Parameters

array $files

Return Value

array

bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string $key

Return Value

bool

protected bool isValidFile(mixed $file)

Check that the given file is a valid file instance.

Parameters

mixed $file

Return Value

bool

UploadedFile|UploadedFile[]|array|null file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.

Parameters

string|null $key
mixed $default

Return Value

UploadedFile|UploadedFile[]|array|null

protected string|array|null retrieveItem(string $source, string $key, string|array|null $default)

Retrieve a parameter item from a given source.

Parameters

string $source
string $key
string|array|null $default

Return Value

string|array|null

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