CallbackEvent
class CallbackEvent extends Event (View source)
Свойства
| string | $command | Строка команды. | from Event |
| string | $expression | Выражение cron, определяющее частоту события. | from Event |
| DateTimeZone|string | $timezone | Часовой пояс, в котором должно оцениваться время. | from Event |
| string | $user | Пользователь, от имени которого должна выполняться команда. | from Event |
| array | $environments | Список сред, в которых должна выполняться команда. | from Event |
| bool | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | from Event |
| bool | $withoutOverlapping | Указывает, должна ли команда не перекрывать себя. | from Event |
| bool | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | from Event |
| protected array | $filters | Массив колбэков-фильтров. | from Event |
| protected array | $rejects | Массив колбэков-отклонений. | from Event |
| string | $output | Место назначения вывода. | from Event |
| protected bool | $shouldAppendOutput | Указывает, должен ли вывод добавляться в конец. | from Event |
| protected array | $beforeCallbacks | Массив колбэков, которые должны быть выполнены до запуска события. | from Event |
| protected array | $afterCallbacks | Массив колбэков, которые должны быть выполнены после завершения события. | from Event |
| string | $description | Описание события для отображения пользователю. | from Event |
| protected string | $callback | Вызываемый колбэк. | |
| protected array | $parameters | Параметры, которые нужно передать методу. |
Методы
| void | __construct(string $callback, array $parameters = []) Создать новый экземпляр события. | |
| string | getDefaultOutput() Получить стандартный вывод в зависимости от ОС. | from Event |
| void | run(Container $container) Запустить данное событие. | |
| void | runCommandInForeground(Container $container) Запустить команду в фоновом режиме. | from Event |
| void | runCommandInBackground() Запустить команду в фоновом режиме. | from Event |
| void | callBeforeCallbacks(Container $container) Вызвать все коллбэки "before" для события. | from Event |
| void | callAfterCallbacks(Container $container) Вызвать все коллбэки "after" для события. | from Event |
| string | buildCommand() Построить строку команды. | from Event |
| string | mutexPath() Получить путь к мьютексу для запланированной команды. | |
| bool | isDue(Application $app) Определить, должно ли выполняться данное событие на основе выражения Cron. | from Event |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | from Event |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | from Event |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в данной среде. | from Event |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | from Event |
| $this | cron(string $expression) Выражение Cron, представляющее частоту события. | from Event |
| $this | hourly() Запланировать событие для запуска каждый час. | from Event |
| $this | daily() Запланировать событие для запуска ежедневно. | from Event |
| $this | at(string $time) Запланировать команду на заданное время. | from Event |
| $this | dailyAt(string $time) Запланировать событие для запуска ежедневно в заданное время (10:00, 19:30 и т.д.). | from Event |
| $this | twiceDaily(int $first = 1, int $second = 13) Запланировать событие для запуска дважды в день. | from Event |
| $this | weekdays() Запланировать событие для запуска только по будням. | from Event |
| $this | mondays() Запланировать событие для запуска только по понедельникам. | from Event |
| $this | tuesdays() Запланировать событие для запуска только по вторникам. | from Event |
| $this | wednesdays() Запланировать событие для запуска только по средам. | from Event |
| $this | thursdays() Запланировать событие для запуска только по четвергам. | from Event |
| $this | fridays() Запланировать событие для запуска только по пятницам. | from Event |
| $this | saturdays() Запланировать событие для запуска только по субботам. | from Event |
| $this | sundays() Запланировать событие для запуска только по воскресеньям. | from Event |
| $this | weekly() Запланировать событие для запуска еженедельно. | from Event |
| $this | weeklyOn(int $day, string $time = '0:0') Запланировать событие для запуска еженедельно в заданный день и время. | from Event |
| $this | monthly() Запланировать событие для запуска ежемесячно. | from Event |
| $this | monthlyOn(int $day = 1, string $time = '0:0') Запланировать событие для запуска ежемесячно в заданный день и время. | from Event |
| $this | quarterly() Запланировать событие для запуска ежеквартально. | from Event |
| $this | yearly() Запланировать событие для запуска ежегодно. | from Event |
| $this | everyMinute() Распланировать событие для запуска каждую минуту. | from Event |
| $this | everyFiveMinutes() Распланировать событие для запуска каждую пять минут. | from Event |
| $this | everyTenMinutes() Распланировать событие для запуска каждую десять минут. | from Event |
| $this | everyThirtyMinutes() Распланировать событие для запуска каждую тридцать минут. | from Event |
| $this | days(array|mixed $days) Установить дни недели, в которые должна выполняться команда. | from Event |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | from Event |
| $this | timezone(DateTimeZone|string $timezone) Установить часовой пояс, в котором должно оцениваться время. | from Event |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | from Event |
| $this | environments(array|mixed $environments) Ограничить среды, в которых должна выполняться команда. | from Event |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | from Event |
| $this | withoutOverlapping() Запретить перекрытие событий друг другом. | |
| $this | when(Closure $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | from Event |
| $this | skip(Closure $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | from Event |
| $this | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в заданное место. | from Event |
| $this | appendOutputTo(string $location) Добавить вывод команды в заданное место. | from Event |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false) Отправить результаты запланированной операции по электронной почте. | from Event |
| $this | emailWrittenOutputTo(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она произвела вывод. | from Event |
| void | emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить вывод события по электронной почте получателям. | from Event |
| string | getEmailSubject() Получить тему электронного письма для результатов вывода. | from Event |
| $this | pingBefore(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL-адрес перед запуском задачи. | from Event |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван до операции. | from Event |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL-адрес после запуска задачи. | from Event |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | from Event |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | from Event |
| $this | name(string $description) Установить описание события, понятное пользователю. | from Event |
| $this | description(string $description) Установить описание события, понятное пользователю. | from Event |
| $this | spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения. | from Event |
| string | getSummaryForDisplay() Получить сводку события для отображения. | |
| string | getExpression() Получить выражение Cron для события. | from Event |
| void | removeMutex() Удалить файл мьютекса из диска. |
Details
void __construct(string $callback, array $parameters = [])
Создать новый экземпляр события.
protected string getDefaultOutput()
Получить значение по умолчанию для вывода в зависимости от ОС.
void run(Container $container)
Выполнить заданное событие.
protected void runCommandInForeground(Container $container)
Выполнить команду в фоновом режиме.
protected void runCommandInBackground()
Выполнить команду в фоновом режиме.
protected void callBeforeCallbacks(Container $container)
Вызвать все "до" обратные вызовы для события.
protected void callAfterCallbacks(Container $container)
Вызвать все обратные вызовы "после" события.
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)
Зарегистрировать обратный вызов для отправки запроса на указанный URL перед запуском задачи.
$this before(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван перед операцией.
$this thenPing(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный 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 для события.
protected void removeMutex()
Удалить файл мьютекса из диска.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Console/Scheduling/CallbackEvent.html
