Задача
абстрактный класс Задача (Просмотреть исходный код)
Трейты
| Взаимодействует со временем |
Свойства
| protected mixed | $instance | Экземпляр обработчика задач. | |
| protected Контейнер | $container | Экземпляр контейнера IoC. | |
| protected bool | $deleted | Указывает, была ли задача удалена. | |
| protected bool | $released | Указывает, была ли задача освобождена. | |
| protected bool | $failed | Указывает, потерпела ли задача неудачу. | |
| protected string | $connectionName | Имя подключения, к которому относится задача. | |
| protected string | $queue | Имя очереди, к которой относится задача. |
Методы
| 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-метки. | из InteractsWithTime |
| string | getJobId() Получить идентификатор задания. | |
| string | getRawBody() Получить исходное тело задания. | |
| string|null | uuid() Получить UUID задания. | |
| void | fire() Запустить задание. | |
| void | delete() Удалить задание из очереди. | |
| bool | isDeleted() Определить, было ли задание удалено. | |
| void | release(int $delay = 0) Вернуть задание в очередь через (n) секунд. | |
| bool | isReleased() Определить, было ли задание возвращено в очередь. | |
| bool | isDeletedOrReleased() Определить, было ли задание удалено или возвращено в очередь. | |
| bool | hasFailed() Определить, было ли задание помечено как невыполненное. | |
| void | markAsFailed() Пометить задание как "невыполненное". | |
| void | fail(Throwable|null $e = null) Удалить задание, вызвать метод "failed" и поднять событие невыполненного задания. | |
| void | failed(Throwable|null $e) Обработать исключение, которое привело к невыполнению задания. | |
| mixed | resolve(string $class) Разрешить указанный класс. | |
| mixed | getResolvedJob() Получить экземпляр обработчика решенного задания. | |
| array | payload() Получить декодированное тело задания. | |
| int|null | maxTries() Получить количество попыток выполнения задания. | |
| int|null | maxExceptions() Получить количество попыток выполнения задания после исключения. | |
| bool | shouldFailOnTimeout() Определить, должно ли задание завершиться с ошибкой при истечении времени. | |
| int|int[]|null | backoff() Количество секунд ожидания перед повторной попыткой задания, столкнувшегося с неуловленным исключением. | |
| int|null | timeout() Получить количество секунд, в течение которых может выполняться задание. | |
| int|null | retryUntil() Получить метку времени, указывающую, когда задание должно завершиться с ошибкой из-за таймаута. | |
| string | getName() Получить имя класса очереди заданий. | |
| string | resolveName() Получить разрешенное имя класса очереди заданий. | |
| string | getConnectionName() Получить имя подключения, к которому принадлежит задание. | |
| string | getQueue() Получить имя очереди, к которой принадлежит задание. | |
| Container | getContainer() Получить экземпляр контейнера сервисов. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить UNIX-метку времени "доступно в".
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в виде отметки UNIX.
abstract string getJobId()
Получить идентификатор задачи.
abstract string getRawBody()
Получить исходное тело задачи.
string|null uuid()
Получить UUID задачи.
void fire()
Запустить задачу.
void delete()
Удалить задачу из очереди.
bool isDeleted()
Определить, была ли задача удалена.
void release(int $delay = 0)
Возвратить задачу обратно в очередь после (n) секунд.
bool isReleased()
Определить, была ли задача возвращена в очередь.
bool isDeletedOrReleased()
Определить, была ли задача удалена или возвращена.
bool hasFailed()
Определить, была ли задача помечена как ошибка.
void markAsFailed()
Пометить задачу как «ошибка».
void fail(Throwable|null $e = null)
Удалить задачу, вызвать метод «failed», и поднять событие задачи с ошибкой.
protected void failed(Throwable|null $e)
Обработать исключение, которое привело к ошибке задачи.
protected mixed resolve(string $class)
Разрешить заданный класс.
mixed getResolvedJob()
Получить разрешённый экземпляр обработчика задач.
array payload()
Получить декодированное тело задачи.
int|null maxTries()
Получить количество попыток выполнения задачи.
int|null maxExceptions()
Получить количество попыток выполнения задачи после исключения.
bool shouldFailOnTimeout()
Определить, должна ли задача завершиться ошибкой при истечении времени ожидания.
int|int[]|null backoff()
Количество секунд ожидания перед повторной попыткой выполнения задачи, столкнувшейся с необработанным исключением.
int|null timeout()
Получить количество секунд, в течение которых может выполняться задача.
int|null retryUntil()
Получить отметку времени, указывающую, когда задача должна истечь.
string getName()
Получить имя класса задачи в очереди.
string resolveName()
Получить разрешённое имя класса задачи в очереди.
Разрешает имя «упакованных» задач, таких как обработчики на основе классов.
string getConnectionName()
Получить имя подключения, к которому принадлежит задача.
строка getQueue()
Получить имя очереди, к которой относится задача.
Контейнер getContainer()
Получить экземпляр контейнера служб.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Queue/Jobs/Job.html
