Событие
класс 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 | Реализация мьютекса события. |
Методы
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin) Смешать другой объект в класс. | 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(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 | tuesdays() Назначить событие для выполнения только во вторник. | from ManagesFrequencies |
| $this | wednesdays() Назначить событие для выполнения только в среду. | from ManagesFrequencies |
| $this | thursdays() Назначить событие для выполнения только в четверг. | from ManagesFrequencies |
| $this | fridays() Назначить событие для выполнения только в пятницу. | from ManagesFrequencies |
| $this | saturdays() Назначить событие для выполнения только в субботу. | from ManagesFrequencies |
| $this | sundays() Назначить событие для выполнения только в воскресенье. | from ManagesFrequencies |
| $this | weekly() Назначить событие для еженедельного выполнения. | from ManagesFrequencies |
| $this | weeklyOn(int $day, string $time = '0:0') Назначить событие для еженедельного выполнения в определенный день и время. | from ManagesFrequencies |
| $this | monthly() Назначить событие для ежемесячного выполнения. | from ManagesFrequencies |
| $this | monthlyOn(int $day = 1, string $time = '0:0') Назначить событие для ежемесячного выполнения в определенный день и время. | from 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) Создать новый экземпляр события. | |
| 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 | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в заданное местоположение. | |
| $this | appendOutputTo(string $location) Добавить вывод команды в заданное местоположение. | |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false) Отправить результаты запланированной операции по электронной почте. | |
| $this | emailWrittenOutputTo(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она производит вывод. | |
| void | ensureOutputIsBeingCapturedForEmail() Убедиться, что вывод собирается для отправки по электронной почте. | |
| 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 | 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 | name(string $description) Установить удобочитаемое описание события. | |
| $this | description(string $description) Установить удобочитаемое описание события. | |
| string | getSummaryForDisplay() Получить сводку события для отображения. | |
| Carbon | nextRunDate(DateTime|string $currentTime = 'now', int $nth, bool $allowCurrentDate = false) Определить следующую дату выполнения события. | |
| string | getExpression() Получить выражение Cron для события. | |
| $this | preventOverlapsUsing(EventMutex $mutex) Установить реализацию блокировки события, которая будет использоваться. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макрос.
static void mixin(object $mixin)
Добавить другой объект в класс.
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(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)
Создать новый экземпляр события.
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 sendOutputTo(string $location, bool $append = false)
Отправить вывод команды в заданное местоположение.
$this appendOutputTo(string $location)
Добавить вывод команды к заданному местуположения.
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)
Отправить по электронной почте результаты запланированной операции.
$this emailWrittenOutputTo(array|mixed $addresses)
Отправить по электронной почте результаты запланированной операции, если она создаёт вывод.
protected void ensureOutputIsBeingCapturedForEmail()
Обеспечить, чтобы вывод был захвачен для отправки по электронной почте.
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 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 name(string $description)
Указать описание события в удобочитаемом формате.
$this description(string $description)
Указать описание события в удобочитаемом формате.
string getSummaryForDisplay()
Получить краткое описание события для отображения.
Carbon nextRunDate(DateTime|string $currentTime = 'now', int $nth, 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.6/Illuminate/Console/Scheduling/Event.html
