Событие
класс Event (Просмотреть исходный код)
Свойства
| строка | $command | Строка команды. | |
| строка | $expression | Выражение cron, определяющее частоту события. | |
| DateTimeZone|строка | $timezone | Часовой пояс, в котором следует оценивать дату. | |
| строка | $user | Пользователь, от имени которого должна выполняться команда. | |
| массив | $environments | Список сред, в которых должна выполняться команда. | |
| логическое значение | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | |
| логическое значение | $withoutOverlapping | Указывает, не должно ли событие перекрывать само себя. | |
| логическое значение | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | |
| защищённый массив | $filters | Массив обратных вызовов фильтра. | |
| защищённый массив | $rejects | Массив обратных вызовов отклонения. | |
| строка | $output | Расположение, куда следует отправлять вывод. | |
| защищённое логическое значение | $shouldAppendOutput | Указывает, следует ли добавлять вывод. | |
| защищённый массив | $beforeCallbacks | Массив обратных вызовов, которые должны быть выполнены до начала события. | |
| защищённый массив | $afterCallbacks | Массив обратных вызовов, которые должны быть выполнены после завершения события. | |
| строка | $description | Описание события, понятное человеку. |
Методы
| void | __construct(string $command) Создать новый экземпляр события. | |
| string | getDefaultOutput() Получить стандартный вывод в зависимости от ОС. | |
| void | run(Container $container) Запустить заданное событие. | |
| void | runCommandInForeground(Container $container) Запустить команду в foreground. | |
| void | runCommandInBackground() Запустить команду в background. | |
| void | callBeforeCallbacks(Container $container) Вызвать все коллбеки "before" для события. | |
| void | callAfterCallbacks(Container $container) Вызвать все коллбеки "after" для события. | |
| string | buildCommand() Сформировать строку команды. | |
| string | mutexPath() Получить путь к mutex для запланированной команды. | |
| bool | isDue(Application $app) Определить, должно ли выполняться данное событие на основе выражения Cron. | |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в данной среде. | |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | |
| $this | cron(string $expression) Выражение Cron, представляющее частоту события. | |
| $this | hourly() Запланировать событие для ежечасного запуска. | |
| $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 | 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 | quarterly() Запланировать событие для ежеквартального запуска. | |
| $this | yearly() Запланировать событие для ежегодного запуска. | |
| $this | everyMinute() Запланировать событие для запуска каждую минуту. | |
| $this | everyFiveMinutes() Запланировать событие для запуска каждые пять минут. | |
| $this | everyTenMinutes() Запланировать событие для запуска каждые десять минут. | |
| $this | everyThirtyMinutes() Запланировать событие для запуска каждые тридцать минут. | |
| $this | days(array|mixed $days) Установить дни недели, в которые должна выполняться команда. | |
| $this | runInBackground() Указать, что команда должна выполняться в background. | |
| $this | timezone(DateTimeZone|string $timezone) Установить часовой пояс, в котором должна оцениваться дата. | |
| $this | user(string $user) Установить пользователя, от имени которого должна выполняться команда. | |
| $this | environments(array|mixed $environments) Ограничить среды, в которых должна выполняться команда. | |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | |
| $this | withoutOverlapping() Не допускать перекрытия событий друг другом. | |
| $this | when(Closure $callback) Зарегистрировать коллбек для дополнительной фильтрации расписания. | |
| $this | skip(Closure $callback) Зарегистрировать коллбек для дополнительной фильтрации расписания. | |
| $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 | emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить по электронной почте вывод события получателям. | |
| string | getEmailSubject() Получить тему письма для результатов вывода. | |
| $this | pingBefore(string $url) Зарегистрировать обратный вызов для отправки запроса ping на указанный URL перед запуском задачи. | |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса ping на указанный URL после запуска задачи. | |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | name(string $description) Указать удобочитаемое описание события. | |
| $this | description(string $description) Указать удобочитаемое описание события. | |
| $this | spliceIntoPosition(int $position, string $value) Вставить заданное значение в указанную позицию выражения. | |
| string | getSummaryForDisplay() Получить сводку события для отображения. | |
| string | getExpression() Получить выражение Cron для события. |
Подробности
void __construct(string $command)
Создать новый экземпляр события.
protected string getDefaultOutput()
Получить значение по умолчанию для вывода, в зависимости от ОС.
void run(Container $container)
Запустить заданное событие.
protected void runCommandInForeground(Container $container)
Запустить команду в фоновом режиме.
protected void runCommandInBackground()
Запустить команду в фоновом режиме.
protected void callBeforeCallbacks(Container $container)
Вызвать все обратные вызовы "before" для события.
protected void callAfterCallbacks(Container $container)
Вызвать все обратные вызовы "after" для события.
string buildCommand()
Сформировать строку команды.
protected string mutexPath()
Получить путь к мьютексу для запланированной команды.
bool isDue(Application $app)
Определить, следует ли запустить данное событие на основе выражения Cron.
protected bool expressionPasses()
Определить, удовлетворяет ли выражение Cron.
bool filtersPass(Application $app)
Определить, проходят ли фильтры для события.
bool runsInEnvironment(string $environment)
Определить, запускается ли событие в заданной среде.
bool runsInMaintenanceMode()
Определить, находится ли событие в режиме технического обслуживания.
$this cron(string $expression)
Выражение задания Cron, определяющее частоту события.
$this hourly()
Настроить событие для выполнения каждый час.
$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 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 quarterly()
Настроить событие для выполнения ежеквартально.
$this yearly()
Настроить событие для выполнения ежегодно.
$this everyMinute()
Настроить событие для выполнения каждую минуту.
$this everyFiveMinutes()
Настроить событие для выполнения каждые пять минут.
$this everyTenMinutes()
Настроить событие для выполнения каждые десять минут.
$this everyThirtyMinutes()
Настроить событие для выполнения каждые тридцать минут.
$this days(array|mixed $days)
Установить дни недели, в которые должна выполняться команда.
$this runInBackground()
Указать, что команда должна выполняться в фоновом режиме.
$this timezone(DateTimeZone|string $timezone)
Установить часовой пояс, в котором должна оцениваться дата.
$this user(string $user)
Указать пользователя, от имени которого должна выполняться команда.
$this environments(array|mixed $environments)
Ограничьте среды, в которых должна выполняться команда.
$this evenInMaintenanceMode()
Укажите, что команда должна выполняться даже в режиме технического обслуживания.
$this withoutOverlapping()
Не допускайте перекрытия событий друг другом.
$this when(Closure $callback)
Зарегистрируйте обратный вызов для дальнейшей фильтрации расписания.
$this skip(Closure $callback)
Зарегистрируйте обратный вызов для дальнейшей фильтрации расписания.
$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 emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false)
Отправить вывод события получателям по электронной почте.
protected string getEmailSubject()
Получить тему письма для результатов вывода.
$this pingBefore(string $url)
Зарегистрировать обратный вызов для отправки запроса ping на заданный URL-адрес перед запуском задания.
$this before(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван перед выполнением операции.
$this thenPing(string $url)
Зарегистрировать обратный вызов для отправки запроса ping на заданный URL-адрес после выполнения задания.
$this after(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван после выполнения операции.
$this then(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван после выполнения операции.
$this name(string $description)
Установите описание события, понятное человеку.
$this description(string $description)
Установите описание события, понятное человеку.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
string getSummaryForDisplay()
Получить сводку события для отображения.
string getExpression()
Получить выражение Cron для события.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Console/Scheduling/Event.html
