CallQueuedClosure

class CallQueuedClosure implements ShouldQueue (View source)

Свойства

Batchable

Dispatchable

SerializesAndRestoresModelIdentifiers

Свойства

string	$batchId	Идентификатор пакетной обработки (применимо).	из Batchable
Job\|null	$job	Экземпляр задания очереди.	из InteractsWithQueue
string\|null	$connection	Имя подключения, к которому должно быть отправлено задание.	из Queueable
string\|null	$queue	Имя очереди, к которой должно быть отправлено задание.	из Queueable
DateTimeInterface\|DateInterval\|array\|int\|null	$delay	Количество секунд, в течение которых задание должно быть доступно.	из Queueable
bool\|null	$afterCommit	Указывает, должно ли задание быть отправлено после завершения всех баз данных транзакций.	из Queueable
array	$middleware	Средства, через которые должно быть отправлено задание.	из Queueable
array	$chained	Задания, которые должны быть выполнены, если данное задание успешно завершено.	из Queueable
string\|null	$chainConnection	Имя подключения, к которому должна быть отправлена цепочка.	из Queueable
string\|null	$chainQueue	Имя очереди, к которой должна быть отправлена цепочка.	из Queueable
array\|null	$chainCatchCallbacks	Обработчики, которые должны быть выполнены при ошибке в цепочке.	из Queueable
SerializableClosure	$closure	Экземпляр сериализуемого замыкания.
array	$failureCallbacks	Обработчики, которые должны быть выполнены при ошибке.
bool	$deleteWhenMissingModels	Указывает, должно ли задание удаляться при отсутствии моделей.

Методы

Batch\|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
string	runTimeForHumans(float $startTime, float $endTime = null) Выводит общее время выполнения в читаемом человеком формате.	из 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	withFakeQueueInteractions() Указать, что взаимодействия с очередью (например, fail, delete, release) должны быть имитированы.	из InteractsWithQueue
$this	assertDeleted() Подтвердить, что задача была удалена из очереди.	из InteractsWithQueue
$this	assertFailed() Подтвердить, что задача была завершена с ошибкой.	из InteractsWithQueue
$this	assertReleased(DateTimeInterface\|DateInterval\|int $delay = null) Подтвердить, что задача была возвращена в очередь.	из 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	withoutDelay() Установите задержку для задачи в ноль секунд.	из 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
void	assertHasChain(array $expectedChain) Утверждение, что задача имеет заданную цепочку прикрепленных к ней задач.	из Queueable
void	assertDoesntHaveChain() Утверждение, что задача не имеет оставшихся задач в цепочке.	из Queueable
mixed	getSerializedPropertyValue(mixed $value, bool $withRelations = true) Получить значение свойства, подготовленное для сериализации.	из SerializesAndRestoresModelIdentifiers
mixed	getRestoredPropertyValue(mixed $value) Получить восстановленное значение свойства после десериализации.	из SerializesAndRestoresModelIdentifiers
Collection	restoreCollection(ModelIdentifier $value) Восстановить экземпляр коллекции queueable.	из SerializesAndRestoresModelIdentifiers
Model	restoreModel(ModelIdentifier $value) Восстановить модель из экземпляра идентификатора модели.	из SerializesAndRestoresModelIdentifiers
TModel>	getQueryForModelRestoration(TModel $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)

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

Параметры

bool\|Closure	$boolean
mixed	...$arguments

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

PendingDispatch|Fluent

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

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

Параметры

bool\|Closure	$boolean
mixed	...$arguments

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

PendingDispatch|Fluent

static mixed dispatchSync(mixed ...$arguments)

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

Задания с возможностью очереди будут отправлены в очередь «синхронно».

Параметры

mixed

...$arguments

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

mixed

static mixed dispatchAfterResponse(mixed ...$arguments)

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

Параметры

mixed

...$arguments

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

mixed

static PendingChain withChain(array $chain)

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

Параметры

array

$chain

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

PendingChain

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

На основе начального времени отформатировать общее время выполнения для удобного чтения человеком.

Параметры

float	$startTime
float	$endTime

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

string

int attempts()

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

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

int

void delete()

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

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

void

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

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

Параметры

Throwable|string|null

$exception

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

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

void

$this withFakeQueueInteractions()

Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть имитированы.

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

$this

$this assertDeleted()

Проверить, что задача была удалена из очереди.

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

$this

$this assertFailed()

Проверить, что задача была вручную приостановлена.

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

$this

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Проверить, что задача была возвращена в очередь.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

$this

$this setJob(Job $job)

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

Параметры

Job

$job

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

$this

$this onConnection(string|null $connection)

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

Параметры

string|null

$connection

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

$this

$this onQueue(string|null $queue)

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

Параметры

string|null

$queue

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

$this

$this allOnConnection(string|null $connection)

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

Параметры

string|null

$connection

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

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

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

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

$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

END_OF_DOCUMENT_MARKER

void invokeChainCatchCallbacks(Throwable $e)

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

Параметры

Throwable

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

void

void assertHasChain(array $expectedChain)

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

Параметры

array

$expectedChain

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

void

void assertDoesntHaveChain()

Утвердить, что задача не имеет оставшихся связанных задач.

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

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

Model restoreModel(ModelIdentifier $value)

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

Параметры

ModelIdentifier

$value

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

Model

protected TModel> getQueryForModelRestoration(TModel $model, array|int $ids)

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

Параметры

TModel	$model
array\|int	$ids

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

TModel>

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

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

void

string displayName()

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

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

string

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