SyncJob

class SyncJob extends Job implements Job (View source)

Свойства

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

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

string|null

uuid()

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

from Job

void

fire()

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

from Job

void

delete()

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

from Job

bool

isDeleted()

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

from Job

void

release(int $delay = 0)

Возвратить задание в очередь.

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

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

from Job

void

fail(Throwable|null $e = null)

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

from Job

void

failed(Throwable|null $e)

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

from Job

mixed

resolve(string $class)

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

from Job

mixed

getResolvedJob()

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

maxExceptions()

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

from Job

bool

shouldFailOnTimeout()

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

from Job

int|null

backoff()

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

from Job

int|null

timeout()

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

from Job

int|null

retryUntil()

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

from Job

string

getName()

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

from Job

string

resolveName()

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

from Job

string

getConnectionName()

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

from Job

string

getQueue()

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

Container

getContainer()

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

from 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.

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

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)

Вернуть задачу обратно в очередь.

Параметры

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|null backoff()

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

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

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/8.x/Illuminate/Queue/Jobs/SyncJob.html