SyncJob
класс SyncJob расширяет Job реализует Job (View source)
Черты
| InteractsWithTime |
Свойства
| protected mixed | $instance | Экземпляр обработчика задания. | из Job |
| protected Container | $container | Экземпляр контейнера IoC. | из Job |
| protected bool | $deleted | Указывает, было ли удалено задание. | из Job |
| protected bool | $released | Указывает, было ли освобождено задание. | из Job |
| protected bool | $failed | Указывает, завершилось ли задание с ошибкой. | из Job |
| protected string | $connectionName | Имя соединения, к которому принадлежит задание. | из Job |
| protected string | $queue | Имя очереди, к которой принадлежит задание. | из Job |
| protected string | $job | Имя класса задания. | |
| protected string | $payload | Данные сообщения очереди. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до заданной даты и времени. | из 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() Получить необработанную строку тела для задания. | |
| void | fire() Запустить задание. | из Job |
| void | delete() Удалить задание из очереди. | из Job |
| bool | isDeleted() Определить, было ли удалено задание. | из Job |
| void | release(int $delay = 0) Вернуть задание в очередь. | |
| bool | isReleased() Определить, было ли задание возвращено в очередь. | из Job |
| bool | isDeletedOrReleased() Определить, было ли задание удалено или возвращено. | из Job |
| bool | hasFailed() Определить, было ли задание помечено как неудачное. | из Job |
| void | markAsFailed() Пометить задание как "неудачное". | из Job |
| void | fail(Throwable|null $e = null) Удалить задание, вызвать метод "failed" и вызвать событие неудачного задания. | из Job |
| void | failed(Throwable|null $e) Обработать исключение, которое привело к сбою задания. | из Job |
| mixed | resolve(string $class) Разрешить заданный класс. | из Job |
| array | payload() Получить декодированное тело задания. | из Job |
| int|null | maxTries() Получить количество попыток выполнения задания. | из Job |
| int|null | delaySeconds() Получить количество секунд для задержки неудачного задания перед повторной попыткой. | из Job |
| int|null | timeout() Получить количество секунд, в течение которых может выполняться задание. | из Job |
| int|null | timeoutAt() Получить метку времени, указывающую, когда должно истечь время ожидания задания. | из Job |
| string | getName() Получить имя класса задания в очереди. | из Job |
| string | resolveName() Получить разрешенное имя класса задания в очереди. | из Job |
| string | getConnectionName() Получить имя соединения, к которому принадлежит задание. | из Job |
| string | getQueue() Получить имя очереди, к которой принадлежит задание. | |
| Container | getContainer() Получить экземпляр контейнера сервисов. | из Job |
| void | __construct(Container $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()
Получить необработанную строку тела для задания.
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()
Получить экземпляр контейнера сервисов.
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/5.8/Illuminate/Queue/Jobs/SyncJob.html
