1. trait
  2. Hypervel
  3. \
  4. Http
  5. \
  6. Concerns
  7. \
  8. InteractsWithInput

InteractsWithInput

trait InteractsWithInput

Traits

Dumpable
InteractsWithData

Methods

never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

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

Dump the items.

array
all(mixed $keys = null)

Get all of the input and files for the request.

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

Retrieve data from the instance.

bool
exists(array|string $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
has(array|string $key)

Determine if the data contains a given key.

from  InteractsWithData
bool
hasAny(array|string $keys)

Determine if the instance contains any of the given keys.

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

Apply the callback if the instance contains the given key.

from  InteractsWithData
bool
filled(array|string $key)

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

from  InteractsWithData
bool
isNotFilled(array|string $key)

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

from  InteractsWithData
bool
anyFilled(array|string $keys)

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

from  InteractsWithData
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.

from  InteractsWithData
mixed
whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

from  InteractsWithData
bool
missing(array|string $key)

Determine if the instance is missing a given key.

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

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

from  InteractsWithData
bool
isEmptyString(string $key)

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

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data from the instance as a Stringable instance.

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

Retrieve data as a boolean value.

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

Retrieve data as an integer value.

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

Retrieve data as a float value.

from  InteractsWithData
int|float
clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

from  InteractsWithData
CarbonInterface|null
date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

from  InteractsWithData
CarbonInterval|null
interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

from  InteractsWithData
mixed
enum(string $key, string $enumClass, mixed $default = null)

Retrieve data from the instance as an enum.

from  InteractsWithData
array
enums(string $key, string $enumClass)

Retrieve data from the instance as an array of enums.

from  InteractsWithData
bool
isBackedEnum(string $enumClass)

Determine if the given enum class is backed.

from  InteractsWithData
int|string|null
normalizeEnumValue(string $enumClass, mixed $value)

Normalize enum input to a strict backed value.

from  InteractsWithData
string|null
enumBackingType(string $enumClass)

Resolve and cache the enum backing type for repeated lookups.

from  InteractsWithData
array
array(array|string|null $key = null)

Retrieve data from the instance as an array.

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

Retrieve data from the instance as a collection.

from  InteractsWithData
array
only(mixed $keys)

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

from  InteractsWithData
array
except(mixed $keys)

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

from  InteractsWithData
string|array|int|float|null
server(string|null $key = null, string|array|int|float|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
fluent(array|string|null $key = null, array $default = [])

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 Hypervel 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|array|null
file(string|null $key = null, mixed $default = null)

Retrieve a file from the request.

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

Retrieve a parameter item from a given source.

Details

in Dumpable at line 12
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

at line 238
InteractsWithInput dump(mixed $keys = [])

Dump the items.

Parameters

mixed $keys

Return Value

InteractsWithInput

at line 73
array all(mixed $keys = null)

Get all of the input and files for the request.

Parameters

mixed $keys

Return Value

array

at line 214
protected mixed data(string|null $key = null, mixed $default = null)

Retrieve data from the instance.

Parameters

string|null $key
mixed $default

Return Value

mixed

in InteractsWithData at line 40
bool exists(array|string $key)

Determine if the data contains a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 48
bool has(array|string $key)

Determine if the data contains a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 66
bool hasAny(array|string $keys)

Determine if the instance contains any of the given keys.

Parameters

array|string $keys

Return Value

bool

in InteractsWithData at line 80
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

mixed

in InteractsWithData at line 96
bool filled(array|string $key)

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

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 112
bool isNotFilled(array|string $key)

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

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 128
bool anyFilled(array|string $keys)

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

Parameters

array|string $keys

Return Value

bool

in InteractsWithData at line 146
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

mixed

in InteractsWithData at line 168
mixed whenEnum(string $key, string $enumClass, callable $callback, callable|null $default = null)

Apply the callback if the instance contains a valid enum value for the given key.

Parameters

string $key
string $enumClass
callable $callback
callable|null $default

Return Value

mixed

in InteractsWithData at line 188
bool missing(array|string $key)

Determine if the instance is missing a given key.

Parameters

array|string $key

Return Value

bool

in InteractsWithData at line 198
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

mixed

in InteractsWithData at line 214
protected bool isEmptyString(string $key)

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

Parameters

string $key

Return Value

bool

in InteractsWithData at line 224
Stringable str(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 232
Stringable string(string $key, mixed $default = null)

Retrieve data from the instance as a Stringable instance.

Parameters

string $key
mixed $default

Return Value

Stringable

in InteractsWithData at line 242
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

in InteractsWithData at line 250
int integer(string $key, int $default = 0)

Retrieve data as an integer value.

Parameters

string $key
int $default

Return Value

int

in InteractsWithData at line 258
float float(string $key, float $default = 0.0)

Retrieve data as a float value.

Parameters

string $key
float $default

Return Value

float

in InteractsWithData at line 266
int|float clamp(string $key, int|float $min, int|float $max, int|float $default = 0)

Retrieve data clamped between min and max values.

Parameters

string $key
int|float $min
int|float $max
int|float $default

Return Value

int|float

in InteractsWithData at line 283
CarbonInterface|null date(string $key, string|null $format = null, UnitEnum|string|null $tz = null)

Retrieve data from the instance as a Carbon instance.

Parameters

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

Return Value

CarbonInterface|null

Exceptions

InvalidFormatException

in InteractsWithData at line 301
CarbonInterval|null interval(string $key, Unit|string|null $unit = null)

Retrieve data from the instance as a CarbonInterval instance.

Parameters

string $key
Unit|string|null $unit

Return Value

CarbonInterval|null

in InteractsWithData at line 327
mixed enum(string $key, string $enumClass, mixed $default = null)

Retrieve data from the instance as an enum.

Parameters

string $key
string $enumClass
mixed $default

Return Value

mixed

in InteractsWithData at line 350
array enums(string $key, string $enumClass)

Retrieve data from the instance as an array of enums.

Parameters

string $key
string $enumClass

Return Value

array

in InteractsWithData at line 369
protected bool isBackedEnum(string $enumClass)

Determine if the given enum class is backed.

Parameters

string $enumClass

Return Value

bool

in InteractsWithData at line 377
protected int|string|null normalizeEnumValue(string $enumClass, mixed $value)

Normalize enum input to a strict backed value.

Parameters

string $enumClass
mixed $value

Return Value

int|string|null

in InteractsWithData at line 422
protected string|null enumBackingType(string $enumClass)

Resolve and cache the enum backing type for repeated lookups.

Parameters

string $enumClass

Return Value

string|null

in InteractsWithData at line 433
array array(array|string|null $key = null)

Retrieve data from the instance as an array.

Parameters

array|string|null $key

Return Value

array

in InteractsWithData at line 441
Collection collect(array|string|null $key = null)

Retrieve data from the instance as a collection.

Parameters

array|string|null $key

Return Value

Collection

in InteractsWithData at line 451
array only(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

in InteractsWithData at line 475
array except(mixed $keys)

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

Parameters

mixed $keys

Return Value

array

at line 23
string|array|int|float|null server(string|null $key = null, string|array|int|float|null $default = null)

Retrieve a server variable from the request.

Parameters

string|null $key
string|array|int|float|null $default

Return Value

string|array|int|float|null

at line 31
bool hasHeader(string $key)

Determine if a header is set on the request.

Parameters

string $key

Return Value

bool

at line 39
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

at line 47
string|null bearerToken()

Get the bearer token from the request headers.

Return Value

string|null

at line 65
array keys()

Get the keys for all of the input and files.

Return Value

array

at line 93
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

at line 105
Fluent fluent(array|string|null $key = null, array $default = [])

Retrieve input from the request as a Fluent object instance.

Parameters

array|string|null $key
array $default

Return Value

Fluent

at line 115
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

at line 123
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

at line 131
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

at line 149
array allFiles()

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

Return Value

array

at line 162
protected array convertUploadedFiles(array $files)

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

Parameters

array $files

Return Value

array

at line 178
bool hasFile(string $key)

Determine if the uploaded data contains a file.

Parameters

string $key

Return Value

bool

at line 196
protected bool isValidFile(mixed $file)

Check that the given file is a valid file instance.

Parameters

mixed $file

Return Value

bool

at line 206
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|array|null

at line 222
protected string|array|int|float|null retrieveItem(string $source, string|null $key, string|array|int|float|null $default)

Retrieve a parameter item from a given source.

Parameters

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

Return Value

string|array|int|float|null