Событие
класс Event (Просмотр исходного кода)
Трейты
| Macroable | |
| ManagesFrequencies |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $command | Строка команды. | |
| строка | $expression | Выражение cron, представляющее частоту события. | |
| DateTimeZone|строка | $timezone | Часовой пояс, в котором следует оценивать дату. | |
| строка | $user | Пользователь, от имени которого должна выполняться команда. | |
| массив | $environments | Список сред, в которых должна выполняться команда. | |
| булево | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | |
| булево | $withoutOverlapping | Указывает, не должна ли команда перекрываться сама собой. | |
| булево | $onOneServer | Указывает, должна ли команда выполняться только на одном сервере для каждого cron-выражения. | |
| целое число | $expiresAt | Время, в течение которого мьютекс должен быть действительным. | |
| булево | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | |
| защищённый массив | $filters | Массив колбэков фильтра. | |
| защищённый массив | $rejects | Массив колбэков отбраковки. | |
| строка | $output | Место назначения вывода. | |
| булево | $shouldAppendOutput | Указывает, должен ли вывод добавляться. | |
| защищённый массив | $beforeCallbacks | Массив колбэков, которые должны быть выполнены до запуска события. | |
| защищённый массив | $afterCallbacks | Массив колбэков, которые должны быть выполнены после завершения события. | |
| строка | $description | Описание события, понятное человеку. | |
| EventMutex | $mutex | Реализация мьютекса события. | |
| целое число|null | $exitCode | Код возврата команды. |
Методы
| 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 |
| $this | cron(string $expression) Выражение Cron, определяющее частоту события. | from ManagesFrequencies |
| $this | between(string $startTime, string $endTime) Назначить событие для запуска между начальным и конечным временем. | from ManagesFrequencies |
| $this | unlessBetween(string $startTime, string $endTime) Назначить событие для того, чтобы оно не запускалось между начальным и конечным временем. | from ManagesFrequencies |
| $this | everyMinute() Назначить событие для запуска каждую минуту. | from ManagesFrequencies |
| $this | everyFiveMinutes() Назначить событие для запуска каждые пять минут. | from ManagesFrequencies |
| $this | everyTenMinutes() Назначить событие для запуска каждые десять минут. | from ManagesFrequencies |
| $this | everyFifteenMinutes() Назначить событие для запуска каждые пятнадцать минут. | from ManagesFrequencies |
| $this | everyThirtyMinutes() Назначить событие для запуска каждые тридцать минут. | from ManagesFrequencies |
| $this | hourly() Назначить событие для запуска каждый час. | from ManagesFrequencies |
| $this | hourlyAt(array|int $offset) Назначить событие для запуска каждый час в заданный интервал. | from ManagesFrequencies |
| $this | daily() Назначить событие для запуска ежедневно. | from ManagesFrequencies |
| $this | at(string $time) Назначить команду на запуск в заданное время. | from ManagesFrequencies |
| $this | dailyAt(string $time) Назначить событие для запуска ежедневно в заданное время (10:00, 19:30 и т.д.). | from ManagesFrequencies |
| $this | twiceDaily(int $first = 1, int $second = 13) Назначить событие для запуска дважды в день. | from ManagesFrequencies |
| $this | weekdays() Назначить событие для запуска только в рабочие дни. | from ManagesFrequencies |
| $this | weekends() Назначить событие для запуска только в выходные дни. | from ManagesFrequencies |
| $this | mondays() Назначить событие для запуска только в понедельник. | from ManagesFrequencies |
| $this | monthlyOn(int $day = 1, string $time = '0:0') Настроить событие для ежемесячного запуска в определенный день и время. | из ManagesFrequencies |
| $this | twiceMonthly(int $first = 1, int $second = 16) Настроить событие для ежемесячного запуска дважды. | из ManagesFrequencies |
| $this | quarterly() Настроить событие для ежеквартального запуска. | из ManagesFrequencies |
| $this | yearly() Настроить событие для ежегодного запуска. | из ManagesFrequencies |
| $this | days(array|mixed $days) Установить дни недели, в которые должна выполняться команда. | из ManagesFrequencies |
| $this | timezone(DateTimeZone|string $timezone) Установить часовой пояс для оценки даты. | из ManagesFrequencies |
| $this | spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения. | из ManagesFrequencies |
| void | __construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null) Создать новый экземпляр события. | |
| string | getDefaultOutput() Получить значение по умолчанию для вывода в зависимости от ОС. | |
| void | run(Container $container) Выполнить заданное событие. | |
| string | mutexName() Получить имя взаимной блокировки для запланированной команды. | |
| void | runCommandInForeground(Container $container) Запустить команду в фоновом режиме. | |
| void | runCommandInBackground(Container $container) Запустить команду в фоновом режиме. | |
| void | callBeforeCallbacks(Container $container) Вызвать все обратные вызовы "before" для события. | |
| void | callAfterCallbacks(Container $container) Вызвать все обратные вызовы "after" для события. | |
| string | buildCommand() Сформировать строку команды. | |
| bool | isDue(Application $app) Определить, должно ли данное событие выполняться на основе выражения Cron. | |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в указанной среде. | |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | |
| $this | storeOutput() Обеспечить, чтобы вывод был сохранен на диске в файле журнала. | |
| $this | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в указанное местоположение. | |
| $this | appendOutputTo(string $location) Добавить вывод команды к указанному местоположению. | |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false) Отправить результаты запланированной операции по электронной почте. | |
| $this | emailWrittenOutputTo(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она создала вывод. | |
| $this | emailOutputOnFailure(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она завершилась ошибкой. | |
| void | ensureOutputIsBeingCaptured() Убедиться, что вывод команды захватывается. | |
| void | emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить вывод события получателям по электронной почте. | |
| string | getEmailSubject() Получить строку темы электронного письма для результатов вывода. | |
| $this | pingBefore(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL перед запуском задачи. | |
| $this | pingBeforeIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL перед запуском задачи, если заданное условие истинно. | |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL после запуска задачи. | |
| $this | thenPingIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL после запуска задачи, если заданное условие истинно. | |
| $this | pingOnSuccess(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция выполняется успешно. | |
| $this | pingOnFailure(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция завершается неудачно. | |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | |
| $this | environments(array|mixed $environments) Ограничить среды, в которых должна выполняться команда. |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | |
| $this | withoutOverlapping(int $expiresAt = 1440) Не допускать перекрытия событий друг другом. | |
| $this | onOneServer() Разрешить выполнение события только на одном сервере для каждого выражения cron. | |
| $this | when(Closure|bool $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | |
| $this | skip(Closure|bool $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | onSuccess(Closure $callback) Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно. | |
| $this | onFailure(Closure $callback) Зарегистрировать обратный вызов, который будет вызван, если операция завершилась неудачно. | |
| $this | name(string $description) Установить описание события, понятное пользователю. | |
| $this | description(string $description) Установить описание события, понятное пользователю. | |
| string | getSummaryForDisplay() Получить краткое описание события для отображения. | |
| Carbon | nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false) Определить следующую дату выполнения события. | |
| string | getExpression() Получить выражение Cron для события. | |
| $this | preventOverlapsUsing(EventMutex $mutex) Установить реализацию взаимного исключения событий. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательскую макрокоманду.
static void mixin(object $mixin, bool $replace = true)
Включить другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирована ли макрокоманда.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
$this cron(string $expression)
Выражение Cron, определяющее частоту события.
$this between(string $startTime, string $endTime)
Настроить событие на выполнение между начальным и конечным временем.
$this unlessBetween(string $startTime, string $endTime)
Настроить событие на невыполнение между начальным и конечным временем.
$this everyMinute()
Настроить событие на выполнение каждую минуту.
$this everyFiveMinutes()
Настроить событие на выполнение каждые пять минут.
$this everyTenMinutes()
Настроить событие на выполнение каждые десять минут.
$this everyFifteenMinutes()
Настроить событие на выполнение каждые пятнадцать минут.
$this everyThirtyMinutes()
Настроить событие на выполнение каждые тридцать минут.
$this hourly()
Расписание события на каждый час.
$this hourlyAt(array|int $offset)
Расписание события на каждый час в заданный момент.
$this daily()
Расписание события на каждый день.
$this at(string $time)
Расписание команды на заданное время.
$this dailyAt(string $time)
Расписание события на каждый день в заданное время (10:00, 19:30 и т. д.).
$this twiceDaily(int $first = 1, int $second = 13)
Расписание события дважды в день.
$this weekdays()
Расписание события только в будние дни.
$this weekends()
Расписание события только в выходные дни.
$this mondays()
Расписание события только по понедельникам.
$this tuesdays()
Расписание события только по вторникам.
$this wednesdays()
Расписание события только по средам.
$this thursdays()
Расписание события только по четвергам.
$this fridays()
Расписание события только по пятницам.
$this saturdays()
Расписание события только по субботам.
$this sundays()
Расписание события только по воскресеньям.
$this weekly()
Расписание события еженедельно.
$this weeklyOn(int $day, string $time = '0:0')
Расписание события еженедельно на указанный день и время.
$this monthly()
Расписание события ежемесячно.
$this monthlyOn(int $day = 1, string $time = '0:0')
Расписание события ежемесячно на указанный день и время.
$this twiceMonthly(int $first = 1, int $second = 16)
Расписание события дважды в месяц.
$this quarterly()
Расписание события ежеквартально.
$this yearly()
Расписание события ежегодно.
$this days(array|mixed $days)
Установите дни недели, в которые должна выполняться команда.
$this timezone(DateTimeZone|string $timezone)
Установите часовой пояс для оценки даты.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
void __construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null)
Создать новый экземпляр события.
string getDefaultOutput()
Получить значение по умолчанию для вывода в зависимости от ОС.
void run(Container $container)
Выполнить данное событие.
string mutexName()
Получить имя мьютекса для запланированной команды.
protected void runCommandInForeground(Container $container)
Выполнить команду в фоновом режиме.
protected void runCommandInBackground(Container $container)
Выполнить команду в фоновом режиме.
void callBeforeCallbacks(Container $container)
Вызвать все обратные вызовы «before» для события.
void callAfterCallbacks(Container $container)
Вызвать все обратные вызовы «after» для события.
string buildCommand()
Сформировать строку команды.
bool isDue(Application $app)
Определить, должно ли данное событие выполняться на основе выражения Cron.
bool runsInMaintenanceMode()
Определить, выполняется ли событие в режиме технического обслуживания.
protected bool expressionPasses()
Определить, проходит ли выражение Cron.
bool runsInEnvironment(string $environment)
Определить, выполняется ли событие в указанной среде.
bool filtersPass(Application $app)
Определить, пройдены ли фильтры для события.
$this storeOutput()
Убедиться, что вывод записан на диск в файл журнала.
$this sendOutputTo(string $location, bool $append = false)
Отправить вывод команды в указанное место.
$this appendOutputTo(string $location)
Добавить вывод команды к указанному месту.
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)
Отправить по электронной почте результаты запланированной операции.
$this emailWrittenOutputTo(array|mixed $addresses)
Отправить по электронной почте результаты запланированной операции, если она генерирует вывод.
$this emailOutputOnFailure(array|mixed $addresses)
Отправить электронное письмо с результатами запланированной операции, если она завершится неудачей.
protected void ensureOutputIsBeingCaptured()
Убедиться, что вывод команды захватывается.
protected void emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false)
Отправить электронное письмо с выводом события получателям.
protected string getEmailSubject()
Получить строку темы электронного письма для результатов вывода.
$this pingBefore(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL до запуска задачи.
$this pingBeforeIf(bool $value, string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL до запуска задачи, если заданное условие истинно.
$this thenPing(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи.
$this thenPingIf(bool $value, string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи, если заданное условие истинно.
$this pingOnSuccess(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция выполнена успешно.
$this pingOnFailure(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция завершилась неудачей.
$this runInBackground()
Указать, что команда должна выполняться в фоновом режиме.
$this user(string $user)
Указать, от имени какого пользователя должна выполняться команда.
$this environments(array|mixed $environments)
Ограничить среды, в которых должна выполняться команда.
$this evenInMaintenanceMode()
Указать, что команда должна выполняться даже в режиме технического обслуживания.
$this withoutOverlapping(int $expiresAt = 1440)
Запретить перекрытие событий.
$this onOneServer()
Разрешить выполнение события только на одном сервере для каждого выражения cron.
$this when(Closure|bool $callback)
Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.
$this skip(Closure|bool $callback)
Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.
$this before(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван перед операцией.
$this after(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван после операции.
$this then(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван после операции.
$this onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно.
$this onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция завершилась ошибкой.
$this name(string $description)
Установить описание события для удобства восприятия человеком.
$this description(string $description)
Установить описание события для удобства восприятия человеком.
string getSummaryForDisplay()
Получить сводку события для отображения.
Carbon nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)
Определить следующую дату выполнения события.
string getExpression()
Получить выражение Cron для события.
$this preventOverlapsUsing(EventMutex $mutex)
Установить реализацию блокировки событий, которая будет использоваться.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Console/Scheduling/Event.html
