Событие
класс Event (Просмотреть исходный код)
Трейты
| Macroable |
| ManagesFrequencies |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| string | $command | Строка команды. | |
| string | $expression | Выражение cron, определяющее частоту события. | |
| DateTimeZone|string | $timezone | Часовой пояс, в котором следует оценивать дату. | |
| string | $user | Пользователь, от имени которого должна выполняться команда. | |
| array | $environments | Список сред, в которых должна выполняться команда. | |
| bool | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | |
| bool | $withoutOverlapping | Указывает, должна ли команда не перекрывать себя. | |
| int | $expiresAt | Срок действия мьютекса (в секундах). | |
| bool | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | |
| protected array | $filters | Массив функций-фильтров. | |
| protected array | $rejects | Массив функций-обработчиков отклонений. | |
| string | $output | Место, куда будет отправлен вывод. | |
| bool | $shouldAppendOutput | Указывает, следует ли добавлять вывод. | |
| protected array | $beforeCallbacks | Массив функций-обработчиков, которые будут выполнены до начала события. | |
| protected array | $afterCallbacks | Массив функций-обработчиков, которые будут выполнены после завершения события. | |
| string | $description | Описание события, понятное человеку. | |
| Mutex | $mutex | Реализация мьютекса. |
Методы
| static void | macro(string $name, callable $macro) Зарегистрировать пользовательский макрос. | 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 | 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) Запланировать выполнение события дважды в месяц. | from ManagesFrequencies |
| $this | quarterly() Запланировать выполнение события ежеквартально. | from ManagesFrequencies |
| $this | yearly() Запланировать выполнение события ежегодно. | from ManagesFrequencies |
| $this | everyMinute() Запланировать выполнение события каждую минуту. | from ManagesFrequencies |
| $this | everyFiveMinutes() Запланировать выполнение события каждые пять минут. | from ManagesFrequencies |
| $this | everyTenMinutes() Запланировать выполнение события каждые десять минут. | from ManagesFrequencies |
| $this | everyThirtyMinutes() Настройте событие для выполнения каждые тридцать минут. | из ManagesFrequencies |
| $this | days(array|mixed $days) Установите дни недели, в которые должна выполняться команда. | из ManagesFrequencies |
| $this | timezone(DateTimeZone|string $timezone) Установите часовой пояс, в котором следует оценивать дату. | из ManagesFrequencies |
| $this | spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения. | из ManagesFrequencies |
| void | __construct(Mutex $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 | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL после запуска задачи. | |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | |
| $this | environments(array|mixed $environments) Ограничить среды, в которых должна выполняться команда. | |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | |
| $this | withoutOverlapping(int $expiresAt = 1440) Не допускать перекрытия событий. | |
| $this | when(Closure $callback) Зарегистрировать обратный вызов для дополнительной фильтрации расписания. | |
| $this | skip(Closure $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(Mutex $mutex) Установить реализацию мьютекса для использования. |
Подробности
static void macro(string $name, callable $macro)
Зарегистрировать пользовательское макро.
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 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 everyMinute()
Настройка события для выполнения каждую минуту.
$this everyFiveMinutes()
Настройка события для выполнения каждую пять минут.
$this everyTenMinutes()
Настройка события для выполнения каждые десять минут.
$this everyThirtyMinutes()
Настройка события для выполнения каждые тридцать минут.
$this days(array|mixed $days)
Установить дни недели, в которые должна выполняться команда.
$this timezone(DateTimeZone|string $timezone)
Установить часовой пояс, в котором должно оцениваться время.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
void __construct(Mutex $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 thenPing(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи.
$this runInBackground()
Указать, что команда должна выполняться в фоновом режиме.
$this user(string $user)
Указать, от имени какого пользователя должна выполняться команда.
$this environments(array|mixed $environments)
Ограничить среды, в которых должна выполняться команда.
$this evenInMaintenanceMode()
Указать, что команда должна выполняться даже в режиме технического обслуживания.
$this withoutOverlapping(int $expiresAt = 1440)
Запретить перекрытие событий друг другом.
$this when(Closure $callback)
Зарегистрировать обратный вызов для дополнительной фильтрации расписания.
$this skip(Closure $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(Mutex $mutex)
Установить реализацию mutex, которая будет использоваться.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Console/Scheduling/Event.html
