Spec-Zone.ru › Laravel 10

CallQueuedClosure

class CallQueuedClosure implements ShouldQueue (View source)

Свойства

Batchable
Dispatchable
InteractsWithQueue
Queueable
SerializesModels
InteractsWithTime
SerializesAndRestoresModelIdentifiers

Свойства

string $batchId

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

 из Batchable
Job|null $job

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

 из InteractsWithQueue
string|null $connection

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

 из Queueable
string|null $queue

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

 из Queueable
string|null $chainConnection

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

 из Queueable
string|null $chainQueue

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

 из Queueable
array|null $chainCatchCallbacks

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

 из Queueable
DateTimeInterface|DateInterval|array|int|null $delay

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

 из Queueable
bool|null $afterCommit

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

 из Queueable
array $middleware

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

 из Queueable
array $chained

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

 из 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|null $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 dispatchAfterResponse(mixed ...$arguments)

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

 из Dispatchable
static PendingChain withChain(array $chain)

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

 из Dispatchable
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты и времени.

 из InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате Unix.

 из InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение — интервал, преобразовать его в экземпляр DateTime.

 из InteractsWithTime
int currentTime()

Получить текущее системное время в формате Unix Timestamp.

 из InteractsWithTime
int attempts()

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

 из InteractsWithQueue
void delete()

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

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

Отметить задание как завершенное с ошибкой в очереди.

 из InteractsWithQueue
void release(DateTimeInterface|DateInterval|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()

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

 из Queueable
void invokeChainCatchCallbacks(Throwable $e)

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

 из Queueable
mixed getSerializedPropertyValue(mixed $value, bool $withRelations = true)

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

 из SerializesAndRestoresModelIdentifiers
mixed getRestoredPropertyValue(mixed $value)

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

 из SerializesAndRestoresModelIdentifiers
Collection restoreCollection(ModelIdentifier $value)

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

 из SerializesAndRestoresModelIdentifiers
Model restoreModel(ModelIdentifier $value)

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

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

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

 из SerializesAndRestoresModelIdentifiers
array __serialize()

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

 из SerializesModels
void __unserialize(array $values)

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

 из SerializesModels
mixed getPropertyValue(ReflectionProperty $property)

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

 из SerializesModels
void __construct(SerializableClosure $closure)

Создать новый экземпляр задания.
static CallQueuedClosure create(Closure $job)

Создать новый экземпляр задания.
void handle(Container $container)

Выполнить задание.
$this onFailure(callable $callback)

Добавить обратный вызов, который выполняется, если задание завершается с ошибкой.
void failed(Throwable $e)

Обработать сбой задания.
string displayName()

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

Подробности

Batch|null batch()

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

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

Batch|null

bool batching()

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

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

bool

$this withBatchId(string $batchId)

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

Параметры

string $batchId

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

$this

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

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

Параметры

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

static PendingDispatch dispatch(mixed ...$arguments)

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

Параметры

mixed ...$arguments

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

PendingDispatch

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

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

Parameters

bool|Closure $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent

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

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

Parameters

bool|Closure $boolean
mixed ...$arguments

Return Value

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

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

Очередные задачи будут отправлены в очередь "sync".

Parameters

mixed ...$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

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты и времени.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени "доступно в" в формате UNIX timestamp.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.

Parameters

DateTimeInterface|DateInterval|int $delay

Return Value

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Return Value

int

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(DateTimeInterface|DateInterval|int $delay = 0)

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

Parameters

DateTimeInterface|DateInterval|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)

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

Параметры

string|null $queue

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

$this

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

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

Параметры

DateTimeInterface|DateInterval|array|int|null $delay

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

$this

$this afterCommit()

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

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

$this

$this beforeCommit()

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

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

$this

$this through(array|object $middleware)

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

Параметры

array|object $middleware

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

$this

$this chain(array $chain)

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

Параметры

array $chain

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

$this

$this prependToChain(mixed $job)

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

Параметры

mixed $job

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

$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, bool $withRelations = true)

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

Параметры

mixed $value
bool $withRelations

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

mixed

protected mixed getRestoredPropertyValue(mixed $value)

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

Параметры

mixed $value

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

mixed

protected Collection restoreCollection(ModelIdentifier $value)

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

Параметры

ModelIdentifier $value

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

Collection

Модель restoreModel(ModelIdentifier $value)

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

Параметры

ModelIdentifier $value

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

Модель

protected Билдер getQueryForModelRestoration(Модель $model, array|int $ids)

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

Параметры

Модель $model
array|int $ids

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

Билдер

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/10.x/Illuminate/Queue/CallQueuedClosure.html

Spec-Zone.ru

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