Работа
абстрактный класс Работа (Просмотреть исходный код)
Свойства
| Взаимодействие со временем |
Свойства
| 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) Получить количество секунд до заданной даты. | из Взаимодействие со временем |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить отметку времени "доступно в" в формате Unix timestamp. | из Взаимодействие со временем |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение является интервалом, преобразовать его в объект DateTime. | из Взаимодействие со временем |
| int | currentTime() Получить текущее системное время в формате Unix timestamp. | из Взаимодействие со временем |
| string | getJobId() Получить идентификатор задачи. | |
| string | getRawBody() Получить исходное тело задачи. | |
| void | fire() Запустить задачу. | |
| void | delete() Удалить задачу из очереди. | |
| bool | isDeleted() Определить, была ли задача удалена. | |
| void | release(int $delay = 0) Вернуть задачу обратно в очередь. | |
| bool | isReleased() Определить, была ли задача возвращена в очередь. | |
| bool | isDeletedOrReleased() Определить, была ли задача удалена или возвращена в очередь. | |
| bool | hasFailed() Определить, была ли задача помечена как проваленная. | |
| void | markAsFailed() Пометить задачу как "проваленную". | |
| void | fail(Throwable|null $e = null) Удалить задачу, вызвать метод "failed" и сгенерировать событие о провале задачи. | |
| void | failed(Throwable|null $e) Обработать исключение, которое привело к провалу задачи. | |
| mixed | resolve(string $class) Разрешить указанный класс. | |
| array | payload() Получить декодированное тело задачи. | |
| int|null | maxTries() Получить количество попыток выполнения задачи. | |
| int|null | delaySeconds() Получить количество секунд задержки проваленной задачи перед повторной попыткой. | |
| int|null | timeout() Получить количество секунд, в течение которых может выполняться задача. | |
| int|null | timeoutAt() Получить отметку времени, указывающую, когда задача должна истечь. | |
| string | getName() Получить имя класса очереди задач. | |
| string | resolveName() Получить разрешенное имя класса очереди задач. | |
| string | getConnectionName() Получить имя подключения, к которому принадлежит задача. | |
| string | getQueue() Получить имя очереди, к которой принадлежит задача. | |
| Контейнер | getContainer() Получить экземпляр контейнера сервисов. |
Подробное описание
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени "доступно в" в формате Unix timestamp.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время в виде метки времени Unix.
abstract string getJobId()
Получить идентификатор задачи.
abstract string getRawBody()
Получить исходное тело задачи.
void fire()
Запустить задачу.
void delete()
Удалить задачу из очереди.
bool isDeleted()
Определить, была ли задача удалена.
void release(int $delay = 0)
Возвратить задачу обратно в очередь.
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)
Разрешить указанный класс.
array payload()
Получить декодированное тело задачи.
int|null maxTries()
Получить количество попыток выполнения задачи.
int|null delaySeconds()
Получить количество секунд задержки для завершённой с ошибкой задачи перед повторной попыткой.
int|null timeout()
Получить количество секунд, в течение которых может выполняться задача.
int|null timeoutAt()
Получить отметку времени, указывающую, когда задача должна истечь.
string getName()
Получить имя класса задачи в очереди.
string resolveName()
Получить разрешенное имя класса задачи в очереди.
Разрешает имя "упакованных" задач, таких как обработчики на основе классов.
string getConnectionName()
Получить имя подключения, к которому принадлежит задача.
string getQueue()
Получить имя очереди, к которой принадлежит задача.
Container getContainer()
Получить экземпляр контейнера сервисов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Queue/Jobs/Job.html
