SyncJob

class SyncJob extends Job implements 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	$connectionName	Имя подключения, к которому относится задача.	из Job
protected string	$queue	Имя очереди, к которой относится задача.	из Job
protected string	$job	Имя класса задачи.
protected string	$payload	Данные сообщения очереди.

Трейты

InteractsWithTime

Методы

int

secondsUntil(DateTimeInterface $delay)

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

from InteractsWithTime

int

availableAt(DateTimeInterface|int $delay)

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

from InteractsWithTime

int

currentTime()

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

from InteractsWithTime

void

fire()

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

from Job

void

delete()

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

from Job

bool

isDeleted()

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

from Job

void

release(int $delay)

Возвратить задачу в очередь.

bool

isReleased()

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

from Job

bool

isDeletedOrReleased()

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

from Job

bool

hasFailed()

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

from Job

void

markAsFailed()

Пометить задачу как "неисправную".

from Job

void

failed(Exception $e)

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

from Job

mixed

resolve(string $class)

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

from Job

array

payload()

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

from Job

int|null

maxTries()

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

from Job

int|null

timeout()

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

from Job

string

getName()

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

from Job

string

resolveName()

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

from Job

string

getConnectionName()

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

from Job

string

getQueue()

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

Container

getContainer()

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

from Job

void

__construct(Container $container, string $payload, string $connectionName, string $queue)

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

int

attempts()

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

string

getJobId()

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

string

getRawBody()

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

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

protected int secondsUntil(DateTimeInterface $delay)

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

Параметры

DateTimeInterface

$delay

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

int

protected int availableAt(DateTimeInterface|int $delay)

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

Параметры

DateTimeInterface|int

$delay

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

int

protected int currentTime()

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

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

int

void fire()

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

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

void

void delete()

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

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

void

bool isDeleted()

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

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

bool

void release(int $delay)

Вернуть задачу обратно в очередь.

Параметры

int

$delay

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

void

bool isReleased()

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

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

bool

bool isDeletedOrReleased()

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

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

bool

bool hasFailed()

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

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

bool

void markAsFailed()

Пометить задачу как «завершившуюся с ошибкой».

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

void

void failed(Exception $e)

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

Параметры

Exception

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

void

protected mixed resolve(string $class)

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

Параметры

string

$class

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

mixed

array payload()

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

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

array

int|null maxTries()

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

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

int|null

int|null timeout()

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

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

int|null

string getName()

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

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

string

string resolveName()

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

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

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

string

string getConnectionName()

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

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

string

string getQueue()

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

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

string

Container getContainer()

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

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

Container

void __construct(Container $container, string $payload, string $connectionName, string $queue)

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

Параметры

Container	$container
string	$payload
string	$connectionName
string	$queue

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

void

int attempts()

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

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

int

string getJobId()

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

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

string

string getRawBody()

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

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

string

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