Spec-Zone.ru › Laravel 11

Задача

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

Методы

строка|null uuid()

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

строка getJobId()

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

массив payload()

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

void fire()

Запустить задачу.

void release(int $delay = 0)

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

bool isReleased()

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

void delete()

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

bool isDeleted()

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

bool isDeletedOrReleased()

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

int attempts()

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

bool hasFailed()

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

void markAsFailed()

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

void fail(Throwable|null $e = null)

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

int|null maxTries()

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

int|null maxExceptions()

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

int|null timeout()

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

int|null retryUntil()

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

строка getName()

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

строка resolveName()

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

строка getConnectionName()

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

строка getQueue()

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

строка getRawBody()

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

Подробности

строка|null uuid()

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

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

строка|null

строка getJobId()

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

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

строка

массив payload()

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

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

массив

void fire()

Запустить задачу.

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

void

void release(int $delay = 0)

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

Параметры

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)

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

Параметры

Throwable|null $e

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

void

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

int|null timeout()

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

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

int|null

int|null retryUntil()

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

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

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/11.x/Illuminate/Contracts/Queue/Job.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API