FakeJob

класс FakeJob расширяет Job (View source)

Трейты

Свойства

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
int	$releaseDelay	Количество секунд, на которое было отложено выпущенное задание.
int	$attempts	Количество попыток обработки задания.
Throwable	$failedWith	Исключение, с которым потерпело неудачу задание.

Методы

int

secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

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

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

from InteractsWithTime

DateTimeInterface|int

parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

string

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

Учитывая начальное время, отформатировать общее время выполнения для удобного восприятия человеком.

from InteractsWithTime

string

getJobId()

Получить идентификатор задания.

string

getRawBody()

Получить исходное тело задания.

string|null

uuid()

Получить UUID задания.

from Job

void

fire()

Запустить задание.

from Job

void

delete()

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

bool

isDeleted()

Определить, было ли задание удалено.

from Job

void

release(int $delay = 0)

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

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

Определить, было ли задание помечено как неудачное.

from Job

void

markAsFailed()

Пометить задание как "неудачное".

from Job

void

fail(Throwable|null $exception = null)

Удалить задание, вызвать метод "failed" и поднять событие о неудачном задании.

void

failed(Throwable|null $e)

Обработать исключение, которое привело к неудаче задания.

from Job

mixed

resolve(string $class)

Разрешить указанный класс.

from Job

mixed

getResolvedJob()

Получить экземпляр обработчика разрешенного задания.

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

maxExceptions()

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

from Job

bool

shouldFailOnTimeout()

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

from Job

int|int[]|null

backoff()

Количество секунд ожидания перед повторной попыткой задания, столкнувшегося с непредвиденным исключением.

from Job

int|null

timeout()

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

from Job

int|null

retryUntil()

Получить отметку времени, указывающую, когда задание должно выйти за пределы времени ожидания.

from Job

string

getName()

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

from Job

string

resolveName()

Получить разрешенное имя класса задания в очереди.

from Job

string

getConnectionName()

Получить имя соединения, к которому относится задание.

from Job

string

getQueue()

Получить имя очереди, к которой относится задание.

from Job

Container

getContainer()

Получить экземпляр контейнера сервисов.

from Job

int

attempts()

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

Подробности

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

Получить метку времени «доступно в» (UNIX timestamp).

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

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

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

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

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

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

int

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

Вывести общее время выполнения в читаемом формате.

Параметры

float	$startTime
float	$endTime

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

string

string getJobId()

Получить идентификатор задачи.

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

string

string getRawBody()

Получить исходное тело задачи.

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

string

string|null uuid()

Получить UUID задачи.

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

string|null

void fire()

Запустить задачу.

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

void

void delete()

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

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

void

bool isDeleted()

Определить, была ли задача удалена.

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

bool

void release(int $delay = 0)

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

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

Определить, была ли задача помечена как неудачная.

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

bool

void markAsFailed()

Пометить задачу как «неудачная».

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

void

void fail(Throwable|null $exception = null)

Удалить задачу, вызвать метод «failed» и сгенерировать событие «failed job».

Параметры

Throwable|null

$exception

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

void

protected void failed(Throwable|null $e)

Обработать исключение, приведшее к неудаче задачи.

Параметры

Throwable|null

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

void

protected mixed resolve(string $class)

Разрешить указанный класс.

Параметры

string

$class

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

mixed

mixed getResolvedJob()

Получить экземпляр обработчика разрешенной задачи.

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null maxExceptions()

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

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

int|null

bool shouldFailOnTimeout()

Определить, должна ли задача завершиться неудачно при истечении времени ожидания.

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

bool

int|int[]|null backoff()

Количество секунд ожидания перед повторной попыткой выполнения задачи, которая столкнулась с непредвиденной ошибкой.

Значение возврата

int|int[]|null

int|null timeout()

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

Значение возврата

int|null

int|null retryUntil()

Получить отметку времени, указывающую, когда задача должна истечь.

Значение возврата

int|null

string getName()

Получить имя очереди класса задачи.

Значение возврата

string

string resolveName()

Получить разрешенное имя класса очереди задач.

Разрешает имя «упакованных» задач, таких как обработчики на основе классов.

Значение возврата

string

string getConnectionName()

Получить имя соединения, к которому принадлежит задача.

Значение возврата

string

string getQueue()

Получить имя очереди, к которой принадлежит задача.

Значение возврата

string

Container getContainer()

Получить экземпляр контейнера сервисов.

Значение возврата

Container

int attempts()

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

Значение возврата

int

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