Работа
абстрактный класс Работа (Просмотреть исходный код)
Трейты
| InteractsWithTime |
Свойства
| protected mixed | $instance | Экземпляр обработчика задач. | |
| protected Container | $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) Возвратить задание обратно в очередь. | |
| bool | isReleased() Определить, было ли задание возвращено обратно в очередь. | |
| bool | isDeletedOrReleased() Определить, было ли задание удалено или возвращено обратно в очередь. | |
| bool | hasFailed() Определить, было ли задание помечено как завершившееся ошибкой. | |
| void | markAsFailed() Пометить задание как завершившееся ошибкой. | |
| void | fail(Throwable|null $e = null) Удалить задание, вызвать метод «failed» и поднять событие «failed job». | |
| void | failed(Throwable|null $e) Обработать исключение, которое привело к завершению задания с ошибкой. | |
| mixed | resolve(string $class) Разрешить указанный класс. | |
| mixed | getResolvedJob() Получить разрешённый экземпляр обработчика задания. | |
| array | payload() Получить декодированное тело задания. | |
| int|null | maxTries() Получить количество попыток выполнения задания. | |
| int|null | maxExceptions() Получить количество попыток выполнения задания после исключения. | |
| bool | shouldFailOnTimeout() Определить, должно ли задание завершиться ошибкой при истечении времени ожидания. | |
| 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)
Вернуть задание обратно в очередь.
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|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/8.x/Illuminate/Queue/Jobs/Job.html
