Spec-Zone.ru › Laravel 9

PendingBatch

class PendingBatch (View source)

Свойства

protected Container $container

Экземпляр контейнера IoC.

string $name

Имя пакета.

Collection $jobs

Задачи, входящие в пакет.

array $options

Параметры пакета.

Методы

void __construct(Container $container, Collection $jobs)

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

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

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

$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)

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

Batch dispatch()

Отправляет пакет.

Batch dispatchAfterResponse()

Отправляет пакет после отправки ответа в браузер.

void dispatchExistingBatch(Batch $batch)

Отправляет существующий пакет.

Подробности

void __construct(Container $container, Collection $jobs)

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

Параметры

Container $container
Collection $jobs

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

void

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

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

Параметры

iterable|object|array $jobs

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

$this

$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

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API