Spec-Zone.ru › Laravel 5.4

SyncJob

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

Методы

int secondsUntil(DateTimeInterface $delay)

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

from InteractsWithTime
int availableAt(DateTimeInterface|int $delay)

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

from InteractsWithTime
int currentTime()

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

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

Параметры

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 $e

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

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.4/Illuminate/Queue/Jobs/SyncJob.html

Spec-Zone.ru

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