Helpers
in package
Универсальные функции-помощники общего назначения.
Суперсет глобальных помощников illuminate/support: управление потоком
(tap, with, value), проверки заполненности (blank, filled),
повтор с ошибками (retry) и доступ к вложенным данным (dataGet,
dataSet) — статическими методами вместо глобальных функций.
Table of Contents
Methods
- blank() : bool
- Считается ли значение «пустым» (blank).
- dataGet() : mixed
- Значение из вложенной структуры по «точечному» ключу.
- dataSet() : array<string|int, mixed>
- Установить значение во вложенной структуре по «точечному» ключу.
- filled() : bool
- Считается ли значение заполненным (обратное {@see blank()}).
- retry() : mixed
- Повторять callback до успеха или исчерпания попыток.
- tap() : T
- Выполнить callback над значением и вернуть само значение.
- value() : mixed
- Развернуть значение: вызвать, если это замыкание.
- with() : mixed
- Вернуть значение, применив к нему callback (если передан).
Methods
blank()
Считается ли значение «пустым» (blank).
public
static blank(mixed $value) : bool
Пусты: null, пустая строка (после trim), пустой массив, пустой Countable.
Parameters
- $value : mixed
-
проверяемое значение
Return values
bool —true, если значение пустое
dataGet()
Значение из вложенной структуры по «точечному» ключу.
public
static dataGet(array<string|int, mixed> $target[, int|string|null $key = null ][, mixed $default = null ]) : mixed
Делегирует Arr::get(); для массивов поддерживает «точечную» нотацию.
Parameters
- $target : array<string|int, mixed>
-
источник данных
- $key : int|string|null = null
-
ключ (поддерживает «точечную» нотацию)
- $default : mixed = null
-
значение по умолчанию
Return values
mixed —найденное значение либо $default
dataSet()
Установить значение во вложенной структуре по «точечному» ключу.
public
static dataSet(array<string|int, mixed> &$target, int|string $key, mixed $value) : array<string|int, mixed>
Parameters
- $target : array<string|int, mixed>
-
источник данных (по ссылке)
- $key : int|string
-
ключ (поддерживает «точечную» нотацию)
- $value : mixed
-
записываемое значение
Return values
array<string|int, mixed> —изменённый массив
filled()
Считается ли значение заполненным (обратное {@see blank()}).
public
static filled(mixed $value) : bool
Parameters
- $value : mixed
-
проверяемое значение
Return values
bool —true, если значение не пустое
retry()
Повторять callback до успеха или исчерпания попыток.
public
static retry(int $times, callable(int): mixed $callback[, int $sleepMs = 0 ][, callable(Throwable): bool|null $when = null ]) : mixed
Parameters
- $times : int
-
число попыток; при значении меньше 1 выполняется одна попытка
- $callback : callable(int): mixed
-
выполняемое действие (получает номер попытки)
- $sleepMs : int = 0
-
пауза между попытками в миллисекундах (неотрицательная)
- $when : callable(Throwable): bool|null = null
-
предикат: повторять ли при данной ошибке
Tags
Return values
mixed —результат успешного вызова callback
tap()
Выполнить callback над значением и вернуть само значение.
public
static tap(T $value, callable(T): mixed $callback) : T
Удобно для «сайд-эффектов» в цепочке без разрыва потока.
Parameters
- $value : T
-
значение
- $callback : callable(T): mixed
-
побочное действие над значением
Tags
Return values
T —то же значение $value
value()
Развернуть значение: вызвать, если это замыкание.
public
static value(mixed $value, mixed ...$args) : mixed
Parameters
- $value : mixed
-
значение или
callable - $args : mixed
-
аргументы для вызываемого значения
Return values
mixed —результат вызова либо само значение
with()
Вернуть значение, применив к нему callback (если передан).
public
static with(T $value[, callable(T): mixed|null $callback = null ]) : mixed
Parameters
- $value : T
-
значение
- $callback : callable(T): mixed|null = null
-
преобразование или null
Tags
Return values
mixed —результат callback либо само $value