trait InteractsWithInput (View source)

Traits

Methods

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

from  Dumpable
$this
dump(mixed $keys = [])

Dump the items.

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

Get all of the input and files for the request.

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

Retrieve data from the instance.

bool
exists(string|array $key)

Determine if the data contains a given key.

bool
has(string|array $key)

Determine if the data contains a given key.

bool
hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

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

Apply the callback if the instance contains the given key.

bool
filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

bool
isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

bool
anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

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

Apply the callback if the instance contains a non-empty value for the given key.

bool
missing(string|array $key)

Determine if the instance is missing a given key.

$this|mixed
whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

bool
isEmptyString(string $key)

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

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

Retrieve data from the instnce as a Stringable instance.

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data as a boolean value.

int
integer(string $key, int $default = 0)

Retrieve data as an integer value.

float
float(string $key, float $default = 0.0)

Retrieve data as a float value.

Carbon|null
date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

TEnum|null
enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

TEnum[]
enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

bool
isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

array
only(array|mixed $keys)

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

array
except(array|mixed $keys)

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

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.

array
keys()

Get the keys for all of the input and files.

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

Retrieve an input item from the request.

fluent(array|string|null $key = null)

Retrieve input from the request as a Fluent object instance.

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|null $key, string|array|null $default)

Retrieve a parameter item from a given source.

Details

never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

$this dump(mixed $keys = [])

Dump the items.

Parameters

mixed $keys

Return Value

$this

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

protected mixed data(string $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string $key
mixed $default

Return Value

mixed

bool exists(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool has(string|array $key)

Determine if the data contains a given key.

Parameters

string|array $key

Return Value

bool

bool hasAny(string|array $keys)

Determine if the instance contains any of the given keys.

Parameters

string|array $keys

Return Value

bool

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

Apply the callback if the instance contains the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

bool filled(string|array $key)

Determine if the instance contains a non-empty value for the given key.

Parameters

string|array $key

Return Value

bool

bool isNotFilled(string|array $key)

Determine if the instance contains an empty value for the given key.

Parameters

string|array $key

Return Value

bool

bool anyFilled(string|array $keys)

Determine if the instance contains a non-empty value for any of the given keys.

Parameters

string|array $keys

Return Value

bool

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

Apply the callback if the instance contains a non-empty value for the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

bool missing(string|array $key)

Determine if the instance is missing a given key.

Parameters

string|array $key

Return Value

bool

$this|mixed whenMissing(string $key, callable $callback, callable|null $default = null)

Apply the callback if the instance is missing the given key.

Parameters

string $key
callable $callback
callable|null $default

Return Value

$this|mixed

protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

Stringable str(string $key, mixed $default = null)

Retrieve data from the instnce as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

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

Retrieve data 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

int integer(string $key, int $default = 0)

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

float float(string $key, float $default = 0.0)

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

Carbon|null date(string $key, string|null $format = null, string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

string $key
string|null $format
string|null $tz

Return Value

Carbon|null

Exceptions

InvalidFormatException

TEnum|null enum(string $key, TEnum> $enumClass)

Retrieve data from the instance as an enum.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum|null

TEnum[] enums(string $key, TEnum> $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
TEnum> $enumClass

Return Value

TEnum[]

protected bool isBackedEnum(class-string $enumClass)

Determine if the given enum class is backed.

Parameters

class-string $enumClass

Return Value

bool

Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

array only(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

array except(array|mixed $keys)

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

Parameters

array|mixed $keys

Return Value

array

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

array keys()

Get the keys for all of the input and files.

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

Fluent fluent(array|string|null $key = null)

Retrieve input from the request as a Fluent object instance.

Parameters

array|string|null $key

Return Value

Fluent

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|null $key, string|array|null $default)

Retrieve a parameter item from a given source.

Parameters

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

Return Value

string|array|null