Spec-Zone.ru › Laravel 11

InteractsWithQueue

trait InteractsWithQueue (View source)

Свойства

InteractsWithTime

Свойства

Job|null $job

Экземпляр задания очереди.

Методы

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 timestamp.

из InteractsWithTime
string runTimeForHumans(float $startTime, float $endTime = null)

Вывести продолжительность выполнения в удобочитаемом формате.

из InteractsWithTime
int attempts()

Получить количество попыток выполнения задания.

void delete()

Удалить задание из очереди.

void fail(Throwable|string|null $exception = null)

Отметить задание как завершенное с ошибкой.

void release(DateTimeInterface|DateInterval|int $delay = 0)

Вернуть задание обратно в очередь через (n) секунд.

$this withFakeQueueInteractions()

Указать, что взаимодействие с очередью (например, fail, delete, release) должно быть смоделировано.

$this assertDeleted()

Проверить, что задание было удалено из очереди.

$this assertFailed()

Проверить, что задание было помечено как завершенное с ошибкой.

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Проверить, что задание было возвращено в очередь.

$this setJob(Job $job)

Установить базовый экземпляр задания очереди.

Подробное описание

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить метку времени "доступно в" в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение представляет интервал, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате UNIX timestamp.

Возвращаемое значение

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

Вывести продолжительность выполнения в удобочитаемом формате.

Параметры

float $startTime
float $endTime

Возвращаемое значение

string

int attempts()

Получить количество попыток выполнения задания.

Возвращаемое значение

int

void delete()

Удалить задание из очереди.

Возвращаемое значение

void

void fail(Throwable|string|null $exception = null)

Отметить задание как завершенное с ошибкой.

Параметры

Throwable|string|null $exception

Возвращаемое значение

void

void release(DateTimeInterface|DateInterval|int $delay = 0)

Вернуть задачу в очередь после (n) секунд.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

void

$this withFakeQueueInteractions()

Указать, что взаимодействия с очередью, такие как fail, delete и release, должны быть смоделированы.

Возвращаемое значение

$this

$this assertDeleted()

Утверждать, что задача была удалена из очереди.

Возвращаемое значение

$this

$this assertFailed()

Утверждать, что задача была вручную помечена как не удавшаяся.

Возвращаемое значение

$this

$this assertReleased(DateTimeInterface|DateInterval|int $delay = null)

Утверждать, что задача была возвращена в очередь.

Параметры

DateTimeInterface|DateInterval|int $delay

Возвращаемое значение

$this

$this setJob(Job $job)

Установить базовый экземпляр задачи очереди.

Параметры

Job $job

Возвращаемое значение

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Queue/InteractsWithQueue.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API