SyncQueue
class SyncQueue extends Queue implements Queue (View source)
Трейты
| InteractsWithTime |
Свойства
| protected Container | $container | Экземпляр контейнера IoC. | from Queue |
| protected string | $connectionName | Имя подключения к очереди. | from Queue |
| static protected callable|null | $createPayloadCallback | Обратный вызов создания полезной нагрузки. | from Queue |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay) Получить количество секунд до указанной даты и времени. | from InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0) Получить отметку времени «доступно в» в формате UNIX. | from InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime. | from InteractsWithTime |
| int | currentTime() Получить текущее системное время в формате UNIX. | from InteractsWithTime |
| mixed | pushOn(string $queue, string $job, mixed $data = '') Добавить новую задачу в очередь. | from Queue |
| mixed | laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '') Добавить новую задачу в очередь с задержкой. | from Queue |
| mixed | bulk(array $jobs, mixed $data = '', string $queue = null) Добавить массив задач в очередь. | from Queue |
| string | createPayload(string $job, string $queue, mixed $data = '') Создать строковое представление полезной нагрузки из задачи и данных. | from Queue |
| array | createPayloadArray(mixed $job, string $queue, mixed $data = '') Создать массив полезной нагрузки из задачи и данных. | from Queue |
| array | createObjectPayload(mixed $job, string $queue) Создать полезную нагрузку для обработчика очереди на основе объектов. | from Queue |
| string | getDisplayName(mixed $job) Получить отображаемое имя для данной задачи. | from Queue |
| mixed | getJobExpiration(mixed $job) Получить отметку времени истечения срока действия задачи для обработчика очереди на основе объектов. | from Queue |
| array | createStringPayload(string $job, string $queue, mixed $data) Создать массив типичной полезной нагрузки для очереди на основе строк. | from Queue |
| static void | createPayloadUsing(callable $callback) Зарегистрировать обратный вызов, который будет выполнен при создании полезных нагрузок задач. | from Queue |
| array | withCreatePayloadHooks(string $queue, array $payload) Создать заданную полезную нагрузку с использованием любых зарегистрированных хуков для создания полезной нагрузки. | from Queue |
| string | getConnectionName() Получить имя подключения для очереди. | from Queue |
| $this | setConnectionName(string $name) Установить имя подключения для очереди. | from Queue |
| void | setContainer(Container $container) Установить экземпляр контейнера IoC. | from Queue |
| int | size(string $queue = null) Получить размер очереди. | |
| mixed | push(string|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь. | |
| SyncJob | resolveJob(string $payload, string $queue) Разрешить экземпляр задачи Sync. | |
| void | raiseBeforeJobEvent(Job $job) Вызвать событие перед задачей в очереди. | |
| void | raiseAfterJobEvent(Job $job) Вызвать событие после задачи в очереди. | |
| void | raiseExceptionOccurredJobEvent(Job $job, Exception $e) Вызвать событие о возникновении исключения во время обработки задачи в очереди. | |
| void | handleException(Job $queueJob, Exception $e) Обработать исключение, возникшее во время обработки задачи. | |
| mixed | pushRaw(string $payload, string $queue = null, array $options = []) Добавить сырую полезную нагрузку в очередь. | |
| mixed | later(DateTimeInterface|DateInterval|int $delay, string|object $job, mixed $data = '', string $queue = null) Добавить новую задачу в очередь с задержкой. | |
| Job|null | pop(string $queue = null) Извлечь следующую задачу из очереди. |
Details
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.
mixed pushOn(string $queue, string $job, mixed $data = '')
Добавить новую задачу в очередь.
mixed laterOn(string $queue, DateTimeInterface|DateInterval|int $delay, string $job, mixed $data = '')
Добавить новую задачу в очередь с отложенным выполнением.
mixed bulk(array $jobs, mixed $data = '', string $queue = null)
Добавить массив задач в очередь.
protected string createPayload(string $job, string $queue, mixed $data = '')
Создать строку полезной нагрузки из заданной задачи и данных.
protected array createPayloadArray(mixed $job, string $queue, mixed $data = '')
Создать массив полезной нагрузки из заданной задачи и данных.
protected array createObjectPayload(mixed $job, string $queue)
Создать полезную нагрузку для обработчика очереди на основе объектов.
protected string getDisplayName(mixed $job)
Получить отображаемое имя для заданной задачи.
mixed getJobExpiration(mixed $job)
Получить отметку времени истечения срока действия для обработчика очереди на основе объектов.
protected array createStringPayload(string $job, string $queue, mixed $data)
Создать массив типичной полезной нагрузки на основе строк для очереди.
static void createPayloadUsing(callable $callback)
Зарегистрировать обратный вызов, который будет выполнен при создании полезной нагрузки задачи.
protected array withCreatePayloadHooks(string $queue, array $payload)
Создать заданную полезную нагрузку с использованием зарегистрированных хуков полезной нагрузки.
string getConnectionName()
Получить имя подключения для очереди.
$this setConnectionName(string $name)
Установить имя подключения для очереди.
void setContainer(Container $container)
Установить экземпляр контейнера IoC.
int size(string $queue = null)
Получить размер очереди.
смешанный push(строка|объект $job, смешанный $data = '', строка $queue = null)
Поместить новую задачу в очередь.
защищенный SyncJob resolveJob(строка $payload, строка $queue)
Разрешить экземпляр задачи Sync.
защищенный void raiseBeforeJobEvent(Задача $job)
Вызвать событие перед задачей очереди.
защищенный void raiseAfterJobEvent(Задача $job)
Вызвать событие после задачи очереди.
защищенный void raiseExceptionOccurredJobEvent(Задача $job, Исключение $e)
Вызвать событие возникновения исключения в задаче очереди.
защищенный void handleException(Задача $queueJob, Исключение $e)
Обработать исключение, возникшее при обработке задачи.
смешанный pushRaw(строка $payload, строка $queue = null, массив $options = [])
Поместить сырой массив в очередь.
смешанный later(DateTimeInterface|DateInterval|int $delay, строка|объект $job, смешанный $data = '', строка $queue = null)
Поместить новую задачу в очередь с задержкой.
Задача|null pop(строка $queue = null)
Извлечь следующую задачу из очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.7/Illuminate/Queue/SyncQueue.html
