Работа

интерфейс Работа (Просмотреть исходный код)

Методы

string\|null	uuid() Получить UUID задания.
string	getJobId() Получить идентификатор задания.
array	payload() Получить декодированное тело задания.
void	fire() Запустить задание.
void	release(int $delay = 0) Возвратить задание обратно в очередь.
bool	isReleased() Определить, было ли задание возвращено в очередь.
void	delete() Удалить задание из очереди.
bool	isDeleted() Определить, было ли задание удалено.
bool	isDeletedOrReleased() Определить, было ли задание удалено или возвращено в очередь.
int	attempts() Получить количество попыток выполнения задания.
bool	hasFailed() Определить, было ли задание помечено как ошибка.
void	markAsFailed() Пометить задание как "ошибка".
void	fail(Throwable\|null $e = null) Удалить задание, вызвать метод "ошибка", и поднять событие о задании с ошибкой.

int\|null	maxTries() Получить количество попыток выполнения задачи.
int\|null	maxExceptions() Получить максимальное количество разрешённых исключений, независимо от попыток.
int\|null	timeout() Получить количество секунд, которое задача может выполняться.
int\|null	timeoutAt() Получить отметку времени, указывающую, когда задача должна истечь.
string	getName() Получить имя класса очереди задач.
string	resolveName() Получить разрешённое имя класса очереди задач.
string	getConnectionName() Получить имя соединения, к которому относится задача.
string	getQueue() Получить имя очереди, к которой относится задача.
string	getRawBody() Получить строку-тело задачи в сыром виде.

Подробности

string|null uuid()

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

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

string|null

string getJobId()

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

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

string

array payload()

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

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

array

void fire()

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

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

void

void release(int $delay = 0)

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

Принимает задержку, заданную в секундах.

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

void delete()

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

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

void

bool isDeleted()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

int attempts()

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

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

int

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задание как "не выполненное".

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

void

void fail(Throwable|null $e = null)

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

Параметры

Throwable|null

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

void

int|null maxTries()

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

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

int|null

int|null maxExceptions()

Получить максимальное количество исключений, разрешённых независимо от попыток.

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

int|null

int|null timeout()

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

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

int|null

int|null timeoutAt()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

string getRawBody()

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

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

string

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