SyncJob

класс SyncJob расширяет Job и реализует Job (Просмотреть исходный код)

Трейты

Свойства

protected mixed	$instance	Экземпляр обработчика задач.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, была ли задача удалена.	из Job
protected bool	$released	Указывает, была ли задача выпущена.	из Job
protected bool	$failed	Указывает, потерпела ли задача неудачу.	из Job
protected string	$connectionName	Имя подключения, к которому принадлежит задача.	из Job
protected string	$queue	Имя очереди, к которой принадлежит задача.	из Job
protected string	$job	Имя класса задачи.
protected string	$payload	Данные сообщения очереди.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

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

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

Получить идентификатор задания.

string

getRawBody()

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

string|null

uuid()

Получить UUID задания.

из Job

void

fire()

Запустить задание.

из Job

void

delete()

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

из Job

bool

isDeleted()

Определить, было ли задание удалено.

из Job

void

release(int $delay = 0)

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

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

Пометить задание как "ошибочное".

из Job

void

fail(Throwable|null $e = null)

Удалить задание, вызвать метод "failed" и сгенерировать событие о неудачном задании.

из Job

void

failed(Throwable|null $e)

Обработать исключение, из-за которого задание завершилось неудачно.

из Job

mixed

resolve(string $class)

Разрешить заданный класс.

из Job

mixed

getResolvedJob()

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

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

maxExceptions()

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

из Job

bool

shouldFailOnTimeout()

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

из Job

int|int[]|null

backoff()

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

из Job

int|null

timeout()

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

из Job

int|null

retryUntil()

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

из Job

string

getName()

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

из Job

string

resolveName()

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

из Job

string

getConnectionName()

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

из Job

string

getQueue()

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

Container

getContainer()

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

из Job

void

__construct(Container $container, string $payload, string $connectionName, string $queue)

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

int

attempts()

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

Подробности

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

string getJobId()

Получить идентификатор задания.

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

string

string getRawBody()

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

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

string

string|null uuid()

Получить UUID задания.

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

string|null

void fire()

Запустить задание.

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

void

void delete()

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

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

void

bool isDeleted()

Определить, было ли задание удалено.

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задание как «ошибка».

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

void

void fail(Throwable|null $e = null)

Удалить задание, вызвать метод «failed», и поднять событие о завершении задания с ошибкой.

Параметры

Throwable|null

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

void

protected void failed(Throwable|null $e)

Обработать исключение, из-за которого задание завершилось с ошибкой.

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

Разрешить указанный класс.

Параметры

string

$class

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

mixed

mixed getResolvedJob()

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

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

bool shouldFailOnTimeout()

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

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

bool

int|int[]|null backoff()

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

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

int|int[]|null

int|null timeout()

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

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

int|null

int|null retryUntil()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

Разрешает имя «упакованных» задач, таких как обработчики на основе классов.

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

void __construct(Container $container, string $payload, string $connectionName, string $queue)

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

Параметры

Container	$container
string	$payload
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

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