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)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

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

Вывести время выполнения в читаемом формате.

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)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

Пометить задачу как "неудачная".

from Job

void

fail(Throwable|null $e = null)

Удалить задачу, вызвать метод "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|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)

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

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

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

Вывести время выполнения в удобочитаемом формате.

Parameters

float	$startTime
float	$endTime

Return Value

string

string getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

string|null uuid()

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

Return Value

string|null

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

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

Parameters

int

$delay

Return Value

void

bool isReleased()

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

Return Value

bool

bool isDeletedOrReleased()

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

Return Value

bool

bool hasFailed()

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

Return Value

bool

void markAsFailed()

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

Return Value

void

void fail(Throwable|null $e = null)

Удалить задание, вызвать метод «ошибка» и вызвать событие ошибочного задания.

Parameters

Throwable|null

Return Value

void

protected void failed(Throwable|null $e)

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

Parameters

Throwable|null

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

mixed getResolvedJob()

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

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null maxExceptions()

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

Return Value

int|null

bool shouldFailOnTimeout()

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

Return Value

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