SyncJob

class SyncJob extends Job implements Job (View source)

Свойства

protected mixed	$instance	Экземпляр обработчика задач.	из Job
protected Container	$container	Экземпляр контейнера IoC.	из Job
protected bool	$deleted	Указывает, была ли задача удалена.	из Job
protected bool	$released	Указывает, была ли задача выпущена обратно в очередь.	из Job
protected bool	$failed	Указывает, произошла ли ошибка при выполнении задачи.	из Job
protected	$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)

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

из InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

из InteractsWithTime

int

currentTime()

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

из InteractsWithTime

string

getJobId()

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

string

getRawBody()

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

void

fire()

Выполнить задачу.

из Job

void

delete()

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

из Job

bool

isDeleted()

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

из Job

void

release(int $delay = 0)

Выпустить задачу обратно в очередь.

bool

isReleased()

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

из Job

bool

isDeletedOrReleased()

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

из Job

bool

hasFailed()

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

из Job

void

markAsFailed()

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

из Job

void

failed(Exception $e)

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

из Job

mixed

resolve(string $class)

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

из Job

array

payload()

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

из Job

int|null

maxTries()

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

из Job

int|null

timeout()

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

из Job

int|null

timeoutAt()

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

из 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)

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

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.

Return Value

int

string getJobId()

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

Return Value

string

string getRawBody()

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

Return Value

string

void fire()

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

Return Value

void

void delete()

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

Return Value

void

bool isDeleted()

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

Return Value

bool

void release(int $delay = 0)

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

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 failed(Exception $e)

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

Parameters

Exception

Return Value

void

protected mixed resolve(string $class)

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

Parameters

string

$class

Return Value

mixed

array payload()

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

Return Value

array

int|null maxTries()

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

Return Value

int|null

int|null timeout()

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

Return Value

int|null

int|null timeoutAt()

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

Return Value

int|null

string getName()

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

Return Value

string

string resolveName()

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

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

Return Value

string

string getConnectionName()

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

Return Value

string

string getQueue()

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

Return Value

string

Container getContainer()

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

Return Value

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