Spec-Zone.ru › Laravel 8

PendingBatch

class PendingBatch (View source)

Свойства

protected Container $container

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

string $name

Имя пакета.

Collection $jobs

Задачи, принадлежащие пакету.

array $options

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

Методы

void __construct(Container $container, Collection $jobs)

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

$this add(iterable $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()

Отправить пакет.

Подробности

void __construct(Container $container, Collection $jobs)

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

Параметры

Container $container
Collection $jobs

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

void

$this add(iterable $jobs)

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

Параметры

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

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

Spec-Zone.ru

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