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