Spec-Zone.ru › Laravel 9

CallQueuedClosure

class CallQueuedClosure implements ShouldQueue (View source)

Трейты

Batchable
Dispatchable
InteractsWithQueue
Queueable
SerializesModels
SerializesAndRestoresModelIdentifiers

Свойства

string $batchId

Идентификатор пакетной обработки (применимо).

from Batchable
Job|null $job

Экземпляр базовой очереди задач.

from InteractsWithQueue
string|null $connection

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

from Queueable
string|null $queue

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

from Queueable
string|null $chainConnection

Имя подключения, к которому должна быть отправлена цепочка задач.

from Queueable
string|null $chainQueue

Имя очереди, в которую должна быть отправлена цепочка задач.

from Queueable
array|null $chainCatchCallbacks

Обработчики, которые должны выполняться при ошибке в цепочке.

from Queueable
DateTimeInterface|DateInterval|array|int|null $delay

Количество секунд, которое должно пройти до запуска задачи.

from Queueable
bool|null $afterCommit

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

from Queueable
array $middleware

Средства обработки, через которые должна быть запущена задача.

from Queueable
array $chained

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

from Queueable
SerializableClosure $closure

Экземпляр сериализуемого замыкания.

array $failureCallbacks

Обработчики, которые должны выполняться при ошибке.

bool $deleteWhenMissingModels

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

Методы

Пачка|null batch()

Получить экземпляр пачки для задачи, если применимо.

из Batchable
bool batching()

Определить, активна ли пачка и выполняется ли она.

из Batchable
$this withBatchId(string $batchId)

Установить идентификатор пачки для задачи.

из Batchable
withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

Указать, что задача должна использовать фальшивую пачку.

из Batchable
static PendingDispatch dispatch(mixed ...$arguments)

Отправить задачу с заданными аргументами.

из Dispatchable
static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)

Отправить задачу с заданными аргументами, если заданное условие истинно.

из Dispatchable
static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

Отправить задачу с заданными аргументами, если заданное условие ложно.

из Dispatchable
static mixed dispatchSync(mixed ...$arguments)

Отправить команду соответствующему обработчику в текущем процессе.

из Dispatchable
static mixed dispatchNow(...$arguments) устарело

Отправить команду соответствующему обработчику в текущем процессе.

из Dispatchable
static mixed dispatchAfterResponse(mixed ...$arguments)

Отправить команду соответствующему обработчику после текущего процесса.

из Dispatchable
static PendingChain withChain(array $chain)

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

из Dispatchable
int attempts()

Получить количество попыток выполнения задачи.

из InteractsWithQueue
void delete()

Удалить задачу из очереди.

из InteractsWithQueue
void fail(Throwable|string|null $exception = null)

Отметить задачу как не удавшуюся в очереди.

из InteractsWithQueue
void release(int $delay = 0)

Возвратить задачу в очередь через (n) секунд.

из InteractsWithQueue
$this setJob(Job $job)

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

из InteractsWithQueue
$this onConnection(string|null $connection)

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

из Queueable
$this onQueue(string|null $queue)

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

из Queueable
$this allOnConnection(string|null $connection)

Установить желаемое соединение для цепочки.

из Queueable
$this allOnQueue(string|null $queue)

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

из Queueable
$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

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

из Queueable
$this afterCommit()

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

из Queueable
$this beforeCommit()

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

из Queueable
$this through(array|object $middleware)

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

из Queueable
$this chain(array $chain)

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

из Queueable
$this prependToChain(mixed $job)

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

из Queueable
$this appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

из Queueable
string serializeJob(mixed $job)

Сериализовать задачу для очереди.

из Queueable
void dispatchNextJobInChain()

Передать следующее задание в цепочке.

from Queueable
void invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики ошибок заданий в цепочке.

from Queueable
mixed getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленного для сериализации.

from SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

Получить восстановленное значение свойства после десериализации.

from SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

Восстановить экземпляр очереди коллекций.

from SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

Восстановить модель из экземпляра идентификатора модели.

from SerializesAndRestoresModelIdentifiers
Builder getQueryForModelRestoration(Model $model, array|int $ids)

Получить запрос для восстановления модели.

from SerializesAndRestoresModelIdentifiers
array __serialize()

Подготовить значения экземпляра для сериализации.

from SerializesModels
void __unserialize(array $values)

Восстановить модель после сериализации.

from SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

Получить значение свойства для заданного свойства.

from SerializesModels
void __construct(SerializableClosure $closure)

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

static CallQueuedClosure create(Closure $job)

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

void handle(Container $container)

Выполнить задание.

$this onFailure(callable $callback)

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

void failed(Throwable $e)

Обработать ошибку задания.

string displayName()

Получить отображаемое имя для задания в очереди.

Details

Batch|null batch()

Получить экземпляр пакета для задания, если применимо.

Return Value

Batch|null

bool batching()

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

Return Value

bool

$this withBatchId(string $batchId)

Установить идентификатор пакета для задания.

Parameters

string $batchId

Return Value

$this

withFakeBatch(string $id = '', string $name = '', int $totalJobs = 0, int $pendingJobs = 0, int $failedJobs = 0, array $failedJobIds = [], array $options = [], CarbonImmutable $createdAt = null, CarbonImmutable|null $cancelledAt = null, CarbonImmutable|null $finishedAt = null)

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

Parameters

string $id
string $name
int $totalJobs
int $pendingJobs
int $failedJobs
array $failedJobIds
array $options
CarbonImmutable $createdAt
CarbonImmutable|null $cancelledAt
CarbonImmutable|null $finishedAt

static PendingDispatch dispatch(mixed ...$arguments)

Передать задание с указанными аргументами.

Parameters

mixed ...$arguments

Return Value

PendingDispatch

static PendingDispatch|Fluent dispatchIf(bool|Closure $boolean, mixed ...$arguments)

Передать задание с заданными аргументами, если указанная проверка истинна.

Parameters

bool|Closure $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent
END_OF_DOCUMENT_MARKER

static PendingDispatch|Fluent dispatchUnless(bool|Closure $boolean, mixed ...$arguments)

Запустить задачу с заданными аргументами, если заданное условие ложно.

Parameters

bool|Closure $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

Запустить команду к соответствующему обработчику в текущем процессе.

Задачу с очереди Queueable будут запущены в очереди "sync".

Parameters

mixed ...$arguments

Return Value

mixed

static mixed dispatchNow(...$arguments) устаревший

устаревший

Будет удалено в будущей версии Laravel.

Запустить команду к соответствующему обработчику в текущем процессе.

Parameters

...$arguments

Return Value

mixed

static mixed dispatchAfterResponse(mixed ...$arguments)

Запустить команду к соответствующему обработчику после текущего процесса.

Parameters

mixed ...$arguments

Return Value

mixed

static PendingChain withChain(array $chain)

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

Parameters

array $chain

Return Value

PendingChain

int attempts()

Получить количество попыток выполнения задачи.

Return Value

int

void delete()

Удалить задачу из очереди.

Return Value

void

void fail(Throwable|string|null $exception = null)

Отметить задачу как невыполненную в очереди.

Parameters

Throwable|string|null $exception

Return Value

void

void release(int $delay = 0)

Вернуть задачу в очередь с задержкой (n) секунд.

Parameters

int $delay

Return Value

void

$this setJob(Job $job)

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

Parameters

Job $job

Return Value

$this

$this onConnection(string|null $connection)

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

Parameters

string|null $connection

Return Value

$this

$this onQueue(string|null $queue)

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

Parameters

string|null $queue

Return Value

$this

$this allOnConnection(string|null $connection)

Установить желаемое соединение для цепочки.

Parameters

string|null $connection

Return Value

$this

$this allOnQueue(string|null $queue)

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

Parameters

string|null $queue

Return Value

$this

$this delay(DateTimeInterface|DateInterval|array|int|null $delay)

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

Parameters

DateTimeInterface|DateInterval|array|int|null $delay

Return Value

$this

$this afterCommit()

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

Return Value

$this

$this beforeCommit()

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

Return Value

$this

$this through(array|object $middleware)

Указать, через какой middleware должна быть запущена задача.

Parameters

array|object $middleware

Return Value

$this

$this chain(array $chain)

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

Parameters

array $chain

Return Value

$this

$this prependToChain(mixed $job)

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

Parameters

mixed $job

Return Value

$this

$this appendToChain(mixed $job)

Добавить задачу в конец текущей цепочки.

Параметры

mixed $job

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

$this

protected string serializeJob(mixed $job)

Сериализовать задачу для очереди.

Параметры

mixed $job

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

string

Исключения

RuntimeException

void dispatchNextJobInChain()

Запустить следующую задачу в цепочке.

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

void

void invokeChainCatchCallbacks(Throwable $e)

Вызвать все обработчики ошибок задач цепочки.

Параметры

Throwable $e

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

void

protected mixed getSerializedPropertyValue(mixed $value)

Получить значение свойства, подготовленное для сериализации.

Параметры

mixed $value

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

mixed

protected mixed getRestoredPropertyValue(mixed $value)

Получить восстановленное значение свойства после десериализации.

Параметры

mixed $value

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

mixed

protected Collection restoreCollection(ModelIdentifier $value)

Восстановить экземпляр коллекции, предназначенной для очереди.

Параметры

ModelIdentifier $value

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

Collection

Model restoreModel(ModelIdentifier $value)

Восстановить модель из экземпляра идентификатора модели.

Параметры

ModelIdentifier $value

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

Model

protected Builder getQueryForModelRestoration(Model $model, array|int $ids)

Получить запрос для восстановления модели.

Параметры

Model $model
array|int $ids

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

Builder

array __serialize()

Подготовить значения экземпляра для сериализации.

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

array

void __unserialize(array $values)

Восстановить модель после сериализации.

Параметры

array $values

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

void

protected mixed getPropertyValue(ReflectionProperty $property)

Получить значение свойства для данного свойства.

Параметры

ReflectionProperty $property

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

mixed

void __construct(SerializableClosure $closure)

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

Параметры

SerializableClosure $closure

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

void

static CallQueuedClosure create(Closure $job)

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

Параметры

Closure $job

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

CallQueuedClosure

void handle(Container $container)

Выполнить задачу.

Параметры

Container $container

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

void

$this onFailure(callable $callback)

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

Параметры

callable $callback

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

$this

void failed(Throwable $e)

Обработать неудачу задачи.

Параметры

Throwable $e

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

void

string displayName()

Получить отображаемое имя задачи в очереди.

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

string

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

Spec-Zone.ru

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