PendingBatch

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

Трейты

Свойства

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

Методы

$this|TWhenReturnType

when($value = null, callable $callback = null, callable $default = null)

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

из Conditionable

$this|TUnlessReturnType

unless($value = null, callable $callback = null, callable $default = null)

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

из Conditionable

void

__construct(Container $container, Collection $jobs)

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

$this

add(iterable|object|array $jobs)

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

$this

before(callable $callback)

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

array

beforeCallbacks()

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

$this

progress(callable $callback)

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

array

progressCallbacks()

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

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

Отправить существующую партию.

Batch|null

dispatchIf(bool|Closure $boolean)

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

Batch|null

dispatchUnless(bool|Closure $boolean)

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

Batch

store(BatchRepository $repository)

Сохранить партию, используя указанный репозиторий.

Подробности

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TWhenReturnType

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

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

Параметры

	$value
callable	$callback
callable	$default

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

$this|TUnlessReturnType

void __construct(Container $container, Collection $jobs)

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

Параметры

Container	$container
Collection	$jobs

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

void

END_OF_DOCUMENT_MARKER

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

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

Параметры

iterable|object|array

$jobs

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

$this

$this before(callable $callback)

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

Параметры

callable

$callback

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

$this

array beforeCallbacks()

Получить обратные вызовы «before», которые были зарегистрированы в ожидающем пакете.

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

array

$this progress(callable $callback)

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

Параметры

callable

$callback

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

$this

array progressCallbacks()

Получить обратные вызовы «progress», которые были зарегистрированы в ожидающем пакете.

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

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/10.x/Illuminate/Bus/PendingBatch.html