PendingBatch

класс PendingBatch (Просмотреть исходный код)

Трейты

Свойства

protected Контейнер	$container	Экземпляр контейнера IoC.
строка	$name	Имя пакета.
Коллекция	$jobs	Задачи, относящиеся к пакету.
массив	$options	Параметры пакета.

Методы

$this\|TWhenReturnType	when($value = null, callable\|null $callback = null, callable\|null $default = null) Примените обратный вызов, если заданное «значение» является (или разрешается в) истинным.	из Conditionable
$this\|TUnlessReturnType	unless($value = null, callable\|null $callback = null, callable\|null $default = null) Примените обратный вызов, если заданное «значение» является (или разрешается в) ложным.	из Conditionable
void	__construct(Container $container, Collection $jobs) Создайте новый экземпляр ожидаемой партии.
$this	add(iterable\|object\|array $jobs) Добавьте задачи в пакет.
$this	before(callable $callback) Добавьте обратный вызов, который будет выполнен при сохранении пакета.
array	beforeCallbacks() Получить зарегистрированные обратные вызовы «before» для ожидаемой партии.
$this	progress(callable $callback) Добавьте обратный вызов, который будет выполнен после успешного выполнения задачи в пакете.
array	progressCallbacks() Получить зарегистрированные обратные вызовы «progress» для ожидаемой партии.
$this	then(callable $callback) Добавьте обратный вызов, который будет выполнен после успешного выполнения всех задач в пакете.
array	thenCallbacks() Получить зарегистрированные обратные вызовы «then» для ожидаемой партии.
$this	catch(callable $callback) Добавьте обратный вызов, который будет выполнен после первой завершившейся ошибкой задачи в пакете.
array	catchCallbacks() Получить зарегистрированные обратные вызовы «catch» для ожидаемой партии.
$this	finally(callable $callback) Добавьте обратный вызов, который будет выполнен после завершения выполнения пакета.
array	finallyCallbacks() Получить зарегистрированные обратные вызовы «finally» для ожидаемой партии.
$this	allowFailures(bool $allowFailures = true) Укажите, что пакет не должен отменяться при сбое задачи внутри пакета.
bool	allowsFailures() Определить, разрешает ли ожидаемая партия сбои задач без отмены пакета.
$this	name(string $name) Установите имя для пакета.
$this	onConnection(string $connection) Укажите соединение очереди, на котором должны выполняться задачи пакета.
string\|null	connection() Получить соединение, используемое ожидаемой партией.
$this	onQueue(string $queue) Укажите очередь, на которой должны выполняться задачи пакета.
string\|null	queue() Получить очередь, используемую ожидаемой партией.

$this	withOption(string $key, mixed $value) Добавить дополнительные данные в массив опций пакета.
Пакет	dispatch() Отправить пакет.
Пакет	dispatchAfterResponse() Отправить пакет после отправки ответа в браузер.
void	dispatchExistingBatch(Пакет $batch) Отправить существующий пакет.
Пакет\|null	dispatchIf(bool\|Closure $boolean) Отправить пакет, если заданное условие истинно.
Пакет\|null	dispatchUnless(bool\|Closure $boolean) Отправить пакет, если заданное условие ложно.
Пакет	store(BatchRepository $repository) Сохранить пакет с помощью заданного репозитория.

Подробности

$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Применить обратный вызов, если заданное «значение» истинно.

Параметры

	$value
callable\|null	$callback
callable\|null	$default

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

$this|TWhenReturnType

$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

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

Параметры

	$value
callable\|null	$callback
callable\|null	$default

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

$this|TUnlessReturnType

void __construct(Контейнер $container, Коллекция $jobs)

Создать новый ожидающий экземпляр пакета.

Параметры

Контейнер	$container
Коллекция	$jobs

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

void

$this add(iterable|object|array $jobs)

Добавить задачи в пакет.

Параметры

iterable|object|array

$jobs

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

$this

$this before(callable $callback)

Добавить обратный вызов, который будет выполнен при сохранении пакета.

Параметры

callable

$callback

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

$this

END_OF_DOCUMENT_MARKER

array beforeCallbacks()

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

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

array

$this progress(callable $callback)

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

Параметры

callable

$callback

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

$this

array progressCallbacks()

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

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

array

$this then(callable $callback)

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

Параметры

callable

$callback

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

$this

array thenCallbacks()

Получить зарегистрированные "then" колбэки для текущей очереди заданий.

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

array

$this catch(callable $callback)

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

Параметры

callable

$callback

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

$this

array catchCallbacks()

Получить зарегистрированные "catch" колбэки для текущей очереди заданий.

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

array

$this finally(callable $callback)

Добавить колбэк, который будет выполнен после завершения очереди заданий.

Параметры

callable

$callback

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

$this

array finallyCallbacks()

Получить зарегистрированные "finally" колбэки для текущей очереди заданий.

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

array

$this allowFailures(bool $allowFailures = true)

Указать, что очередь заданий не должна отменяться при ошибках заданий внутри очереди.

Параметры

bool

$allowFailures

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

$this

bool allowsFailures()

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

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

bool

$this name(string $name)

Установить имя для очереди заданий.

Параметры

string

$name

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

$this

$this onConnection(string $connection)

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

Параметры

string

$connection

Значение возврата

$this

string|null connection()

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

Значение возврата

string|null

$this onQueue(string $queue)

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

Параметры

string

$queue

Значение возврата

$this

string|null queue()

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

Значение возврата

string|null

$this withOption(string $key, mixed $value)

Добавить дополнительные данные в массив опций пакета.

Параметры

string	$key
mixed	$value

Значение возврата

$this

Batch dispatch()

Запустить пакет.

Значение возврата

Batch

Исключения

Throwable

Batch dispatchAfterResponse()

Запустить пакет после отправки ответа в браузер.

Значение возврата

Batch

protected void dispatchExistingBatch(Batch $batch)

Запустить существующий пакет.

Параметры

Batch

$batch

Значение возврата

void

Исключения

Throwable

Batch|null dispatchIf(bool|Closure $boolean)

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

Параметры

bool|Closure

$boolean

Значение возврата

Batch|null

Batch|null dispatchUnless(bool|Closure $boolean)

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

Параметры

bool|Closure

$boolean

Значение возврата

Batch|null

protected Batch store(BatchRepository $repository)

Сохранить пакет с использованием данного репозитория.

Параметры

BatchRepository

$repository

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

Batch

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