Spec-Zone.ru › Laravel 7

Расписание

класс Расписание (Просмотреть исходный код)

Трейты

Macroable

Свойства

статический защищённый массив $macros

Зарегистрированные строковые макросы.

из Macroable
защищённый Event[] $events

Все события в расписании.

защищённый EventMutex $eventMutex

Реализация мьютекса для событий.

защищённый SchedulingMutex $schedulingMutex

Реализация мьютекса для расписания.

защищённый DateTimeZone|строка $timezone

Часовой пояс, в котором должны оцениваться даты.

защищённый Dispatcher $dispatcher

Реализация диспетчера задач.

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

from Macroable
static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

from Macroable
static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

from Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

from Macroable
void __construct(DateTimeZone|string|null $timezone = null)

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

CallbackEvent call(string|callable $callback, array $parameters = [])

Добавить новое событие обратного вызова в расписание.

Event command(string $command, array $parameters = [])

Добавить новое событие команды Artisan в расписание.

CallbackEvent job(object|string $job, string|null $queue = null, string|null $connection = null)

Добавить новое событие обратного вызова задания в расписание.

void dispatchToQueue(object $job, string|null $queue, string|null $connection)

Отправить заданное задание в очередь.

void dispatchNow(object $job)

Отправить заданное задание прямо сейчас.

Event exec(string $command, array $parameters = [])

Добавить новое событие выполнения команды в расписание.

string compileParameters(array $parameters)

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

string compileArrayInput(string|int $key, array $value)

Скомпилировать входные данные массива для команды.

bool serverShouldRun(Event $event, DateTimeInterface $time)

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

Collection dueEvents(Application $app)

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

Event[] events()

Получить все события в расписании.

$this useCache(string $store)

Указать хранилище кеша, которое должно использоваться для хранения мьютексов.

Dispatcher getDispatcher()

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

Details

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы к классу.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(DateTimeZone|string|null $timezone = null)

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

Параметры

DateTimeZone|string|null $timezone

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

void

CallbackEvent call(string|callable $callback, array $parameters = [])

Добавить новый обработчик событий в расписание.

Параметры

string|callable $callback
array $parameters

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

CallbackEvent

Event command(string $command, array $parameters = [])

Добавить новое событие команды Artisan в расписание.

Параметры

string $command
array $parameters

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

Event

CallbackEvent job(object|string $job, string|null $queue = null, string|null $connection = null)

Добавить новое событие обработки задач в расписание.

Параметры

object|string $job
string|null $queue
string|null $connection

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

CallbackEvent

protected void dispatchToQueue(object $job, string|null $queue, string|null $connection)

Отправить заданную задачу в очередь.

Параметры

object $job
string|null $queue
string|null $connection

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

void

protected void dispatchNow(object $job)

Отправить заданную задачу прямо сейчас.

Параметры

object $job

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

void

Event exec(string $command, array $parameters = [])

Добавить новое событие команды в расписание.

Параметры

string $command
array $parameters

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

Event

protected string compileParameters(array $parameters)

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

Параметры

array $parameters

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

string

string compileArrayInput(string|int $key, array $value)

Скомпилировать массив входных данных для команды.

Параметры

string|int $key
array $value

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

string

bool serverShouldRun(Event $event, DateTimeInterface $time)

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

Параметры

Event $event
DateTimeInterface $time

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

bool

Collection dueEvents(Application $app)

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

Параметры

Application $app

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

Collection

Event[] events()

Получить все события в расписании.

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

Event[]

$this useCache(string $store)

Указать хранилище кэша, которое должно использоваться для хранения мьютексов.

Параметры

string $store

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

$this

protected Dispatcher getDispatcher()

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

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

Dispatcher

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/7.x/Illuminate/Console/Scheduling/Schedule.html

Spec-Zone.ru

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