ValidatedInput

class ValidatedInput implements ValidatedData (View source)

Свойства

protected array

$input

Базовое входное значение.

Методы

void

__construct(array $input)

Создать новый контейнер валидированных входных данных.

bool

exists(string|array $key)

Определить, содержит ли валидированный ввод один или несколько ключей.

bool

has(mixed $keys)

Определить, содержит ли валидированный ввод один или несколько ключей.

bool

hasAny(string|array $keys)

Определить, содержит ли валидированный ввод любой из заданных ключей.

$this|mixed

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

Применить обратный вызов, если валидированный ввод содержит заданный ключ входного элемента.

bool

filled(string|array $key)

Определить, содержит ли валидированный ввод непустое значение для входного элемента.

bool

isNotFilled(string|array $key)

Определить, содержит ли валидированный ввод пустое значение для входного элемента.

bool

anyFilled(string|array $keys)

Определить, содержит ли валидированный ввод непустое значение для любого из заданных входных элементов.

$this|mixed

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

Применить обратный вызов, если валидированный ввод содержит непустое значение для заданного ключа входного элемента.

bool

isEmptyString(string $key)

Определить, является ли заданный входной элемент пустой строкой.

bool

missing(mixed $keys)

Определить, отсутствует ли в валидированном вводе один или несколько ключей.

$this|mixed

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

Применить обратный вызов, если в валидированном вводе отсутствует заданный ключ входного элемента.

array

keys()

Получить ключи всех входных данных.

mixed

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

Получить элемент входных данных из валидированного ввода.

Stringable

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

Получить входные данные из валидированного ввода как экземпляр Stringable.

Stringable

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

Получить входные данные из валидированного ввода как экземпляр Stringable.

bool

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

Получить входные данные как булево значение.

int

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

Получить входные данные как целое число.

float

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

Получить входные данные как число с плавающей точкой.

Carbon|null

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

Получить входные данные из валидированного ввода как экземпляр Carbon.

TEnum|null

enum(string $key, TEnum> $enumClass)

Получить входные данные из валидированного ввода как перечисление.

array

only(mixed $keys)

Получить подмножество, содержащее предоставленные ключи со значениями из входных данных.

array

except(mixed $keys)

Получить все входные данные, за исключением указанного массива элементов.

ValidatedInput

merge(array $items)

Объединить валидированный ввод с заданным массивом дополнительных данных.

Collection

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

Получить ввод как коллекцию.

array

all()

Получить исходный массив входных данных.

never

dd(mixed ...$keys)

Вывести элементы валидированного ввода и завершить выполнение скрипта.

$this

dump(mixed $keys = [])

Вывести элементы.

toArray()

Получить экземпляр в виде массива.

mixed

__get(string $name)

Динамический доступ к данным ввода.

mixed

__set(string $name, mixed $value)

Динамическая установка данных ввода.

bool

__isset($name)

Определить, установлен ли элемент ввода.

void

__unset(string $name)

Удалить элемент ввода.

bool

offsetExists(mixed $key)

Определить, существует ли элемент по заданному смещению.

mixed

offsetGet(mixed $key)

Получить элемент по заданному смещению.

void

offsetSet(mixed $key, mixed $value)

Установить элемент по заданному смещению.

void

offsetUnset(string $key)

Удалить элемент по заданному смещению.

Traversable

getIterator()

Получить итератор для входных данных.

Подробности

void __construct(array $input)

Создать новый контейнер валидированных входных данных.

Параметры

array

$input

Возвращаемое значение

void

bool exists(string|array $key)

Определить, содержит ли валидированный ввод один или несколько ключей.

Параметры

string|array

$key

Возвращаемое значение

bool

bool has(mixed $keys)

Определить, содержит ли валидированный ввод один или несколько ключей.

Параметры

mixed

$keys

Возвращаемое значение

bool

END_OF_DOCUMENT_MARKER

bool hasAny(string|array $keys)

Определить, содержит ли валидированный ввод любые из заданных ключей.

Parameters

string|array

$keys

Return Value

bool

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

Применить обратный вызов, если валидированный ввод содержит заданный ключ элемента ввода.

Parameters

string	$key
callable	$callback
callable	$default

Return Value

$this|mixed

bool filled(string|array $key)

Определить, содержит ли валидированный ввод непустое значение для элемента ввода.

Parameters

string|array

$key

Return Value

bool

bool isNotFilled(string|array $key)

Определить, содержит ли валидированный ввод пустое значение для элемента ввода.

Parameters

string|array

$key

Return Value

bool

bool anyFilled(string|array $keys)

Определить, содержит ли валидированный ввод непустое значение для любого из заданных элементов ввода.

Parameters

string|array

$keys

Return Value

bool

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

Применить обратный вызов, если валидированный ввод содержит непустое значение для заданного ключа элемента ввода.

Parameters

string	$key
callable	$callback
callable	$default

Return Value

$this|mixed

protected bool isEmptyString(string $key)

Определить, является ли заданный элемент ввода пустой строкой.

Parameters

string

$key

Return Value

bool

bool missing(mixed $keys)

Определить, отсутствуют ли один или несколько ключей в валидированном вводе.

Parameters

mixed

$keys

Return Value

bool

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

Применить обратный вызов, если заданный ключ элемента ввода отсутствует в валидированном вводе.

Parameters

string	$key
callable	$callback
callable	$default

Return Value

$this|mixed

array keys()

Получить ключи всех элементов ввода.

Return Value

array

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

Получить элемент ввода из валидированного ввода.

Parameters

string\|null	$key
mixed	$default

Return Value

mixed

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

Получить данные ввода в качестве экземпляра Stringable.

Parameters

string	$key
mixed	$default

Return Value

Stringable

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

Получить данные ввода в качестве экземпляра Stringable.

Parameters

string	$key
mixed	$default

Return Value

Stringable

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

Получить данные ввода в качестве булевого значения.

Возвращает true, если значение равно "1", "true", "on", или "yes". В противном случае возвращает false.

Parameters

string\|null	$key
bool	$default

Return Value

bool

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

Получить данные ввода в качестве целого числа.

Parameters

string	$key
int	$default

Return Value

int

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

Получить данные ввода в качестве числа с плавающей точкой.

Parameters

string	$key
float	$default

Return Value

float

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

Получить данные ввода в качестве экземпляра Carbon.

Parameters

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

Return Value

Carbon|null

Exceptions

InvalidFormatException

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

Получить данные ввода в качестве перечисления.

Parameters

string	$key
TEnum>	$enumClass

Return Value

TEnum|null

array only(mixed $keys)

Получить подмножество, содержащее предоставленные ключи со значениями из данных ввода.

Parameters

mixed

$keys

Return Value

array

array except(mixed $keys)

Получить все данные ввода, за исключением указанного массива элементов.

Parameters

mixed

$keys

Return Value

array

ValidatedInput merge(array $items)

Объединить валидированные данные со следующим массивом дополнительной информации.

Параметры

массив

$items

Возвращаемое значение

ValidatedInput

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

Получить данные в виде коллекции.

Параметры

массив|строка|null

$key

Возвращаемое значение

Collection

массив all()

Получить исходный массив данных.

Возвращаемое значение

массив

никогда dd(mixed ...$keys)

Вывести валидированные данные и завершить сценарий.

Параметры

смешанный тип

...$keys

Возвращаемое значение

никогда

$this dump(mixed $keys = [])

Вывести данные.

Параметры

смешанный тип

$keys

Возвращаемое значение

$this

toArray()

Получить экземпляр в виде массива.

смешанный тип __get(string $name)

Динамический доступ к данным входных данных.

Параметры

строка

$name

Возвращаемое значение

смешанный тип

смешанный тип __set(string $name, mixed $value)

Динамическое задание данных входных данных.

Параметры

строка	$name
смешанный тип	$value

Возвращаемое значение

смешанный тип

булево __isset($name)

Определить, установлено ли значение входного элемента.

Параметры

$name

Возвращаемое значение

булево

пустое значение __unset(string $name)

Удалить входной элемент.

Параметры

строка

$name

Возвращаемое значение

пустое значение

булево offsetExists(mixed $key)

Определить, существует ли элемент по указанному индексу.

Параметры

смешанный тип

$key

Возвращаемое значение

булево

смешанный тип offsetGet(mixed $key)

Получить элемент по указанному индексу.

Параметры

смешанный тип

$key

Возвращаемое значение

смешанный тип

пустое значение offsetSet(mixed $key, mixed $value)

Установить элемент по указанному индексу.

Параметры

смешанный тип	$key
смешанный тип	$value

Возвращаемое значение

пустое значение

пустое значение offsetUnset(string $key)

Удалить элемент по указанному индексу.

Параметры

строка

$key

Возвращаемое значение

пустое значение

Traversable getIterator()

Получить итератор для входных данных.

Возвращаемое значение

Traversable

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Support/ValidatedInput.html