Событие
класс Event (Просмотреть исходный код)
Трейты
| Macroable |
| ManagesFrequencies |
Свойства
| статический защищенный массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $command | Строка команды. | |
| строка | $expression | Выражение cron, представляющее частоту события. | |
| DateTimeZone|строка | $timezone | Часовой пояс, в котором должно быть выполнено вычисление даты. | |
| строка | $user | Пользователь, от имени которого должна выполняться команда. | |
| массив | $environments | Список сред, в которых должна выполняться команда. | |
| логический | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | |
| логический | $withoutOverlapping | Указывает, не должна ли команда перекрывать сама себя. | |
| целое число | $expiresAt | Время действия мьютекса. | |
| логический | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | |
| защищенный массив | $filters | Массив колбэков фильтров. | |
| защищенный массив | $rejects | Массив колбэков отклонений. | |
| строка | $output | Место, куда должен быть отправлен вывод. | |
| логический | $shouldAppendOutput | Указывает, должен ли вывод дописываться. | |
| защищенный массив | $beforeCallbacks | Массив колбэков, которые должны быть выполнены перед запуском события. | |
| защищенный массив | $afterCallbacks | Массив колбэков, которые должны быть выполнены после завершения события. | |
| строка | $description | Описание события, понятное человеку. | |
| Mutex | $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(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|bool $callback) Зарегистрировать коллбек для дополнительной фильтрации расписания. | |
| $this | skip(Closure|bool $callback) Зарегистрировать коллбек для дополнительной фильтрации расписания. | |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | |
| $this | name(string $description) Установить описания события для пользователей. |
| $this | описание(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, 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(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)
Вызвать все обратные вызовы "после" для события.
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|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(Mutex $mutex)
Установить реализацию мьютекса, которую следует использовать.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Console/Scheduling/Event.html
