Событие
класс Событие (Просмотреть исходный код)
Трейты
| Macroable | |
| ManagesFrequencies | |
| ReflectsClosures |
Свойства
| static protected массив | $macros | Зарегистрированные строковые макросы. |
из Macroable |
| строка | $command | Строка команды. |
|
| строка | $expression | Выражение cron, представляющее частоту события. |
|
| DateTimeZone|строка | $timezone | Временная зона, в которой должно быть произведено оценивание даты. |
|
| строка | $user | Пользователь, от имени которого должна выполняться команда. |
|
| массив | $environments | Список сред, в которых должна выполняться команда. |
|
| логическое | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. |
|
| логическое | $withoutOverlapping | Указывает, не должна ли команда перекрывать сама себя. |
|
| логическое | $onOneServer | Указывает, должна ли команда выполняться только на одном сервере для каждого выражения cron. |
|
| целое | $expiresAt | Время, в течение которого мьютекс должен быть действителен. |
|
| логическое | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. |
|
| protected массив | $filters | Массив обратных вызовов фильтра. |
|
| protected массив | $rejects | Массив обратных вызовов отклонения. |
|
| строка | $output | Место, куда должен отправляться вывод. |
|
| логическое | $shouldAppendOutput | Указывает, должен ли вывод дописываться. |
|
| protected массив | $beforeCallbacks | Массив обратных вызовов, которые должны быть выполнены перед запуском события. |
|
| protected массив | $afterCallbacks | Массив обратных вызовов, которые должны быть выполнены после завершения события. |
|
| строка | $description | Описание события для человека. |
|
| EventMutex | $mutex | Реализация мьютекса события. |
|
| целое|null | $exitCode | Код состояния завершения команды. |
Методы
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | 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 | everyTwoMinutes()
Запланировать событие для запуска каждые две минуты. | from ManagesFrequencies |
| $this | everyThreeMinutes()
Запланировать событие для запуска каждые три минуты. | from ManagesFrequencies |
| $this | everyFourMinutes()
Запланировать событие для запуска каждые четыре минуты. | from ManagesFrequencies |
| $this | everyFiveMinutes()
Запланировать событие для запуска каждые пять минут. | from ManagesFrequencies |
| $this | everyTenMinutes()
Запланировать событие для запуска каждые десять минут. | from ManagesFrequencies |
| $this | everyFifteenMinutes()
Запланировать событие для запуска каждые пятнадцать минут. | from ManagesFrequencies |
| $this | everyThirtyMinutes()
Запланировать событие для запуска каждые тридцать минут. | from ManagesFrequencies |
| $this | hourly()
Запланировать событие для запуска каждый час. | from ManagesFrequencies |
| $this | hourlyAt(array|int $offset)
Запланировать событие для запуска каждый час с заданным смещением в часе. | from ManagesFrequencies |
| $this | everyTwoHours()
Запланировать событие для запуска каждые два часа. | from ManagesFrequencies |
| $this | everyThreeHours()
Запланировать событие для запуска каждые три часа. | from ManagesFrequencies |
| $this | everyFourHours()
Запланировать событие для запуска каждые четыре часа. | from ManagesFrequencies |
| $this | everySixHours()
Запланировать событие для запуска каждые шесть часов. | 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() Настроить событие для запуска только по пятницам. | из ManagesFrequencies |
| $this | saturdays() Настроить событие для запуска только по субботам. | из ManagesFrequencies |
| $this | sundays() Настроить событие для запуска только по воскресеньям. | из ManagesFrequencies |
| $this | weekly() Настроить событие для еженедельного запуска. | из ManagesFrequencies |
| $this | weeklyOn(int $day, string $time = '0:0') Настроить событие для еженедельного запуска в заданный день и время. | из ManagesFrequencies |
| $this | monthly() Настроить событие для ежемесячного запуска. | из ManagesFrequencies |
| $this | monthlyOn(int $day = 1, string $time = '0:0') Настроить событие для ежемесячного запуска в заданный день и время. | из ManagesFrequencies |
| $this | twiceMonthly(int $first = 1, int $second = 16, string $time = '0:0') Настроить событие для двукратного ежемесячного запуска в заданное время. | из ManagesFrequencies |
| $this | lastDayOfMonth(string $time = '0:0') Настроить событие для запуска в последний день месяца. | из 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 |
| array | closureParameterTypes(Closure $closure) Получить имена/типы классов параметров заданного замыкания. | из ReflectsClosures |
| string | firstClosureParameterType(Closure $closure) Получить имя класса первого параметра заданного замыкания. | из ReflectsClosures |
| void | __construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null) Создать новый экземпляр события. | |
| 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" для события. | |
| void | callAfterCallbacksWithExitCode(Container $container, int $exitCode) Вызвать все обратные вызовы "after" для события. | |
| string | buildCommand() Собрать строку команды. | |
| bool | isDue(Application $app) Определить, должно ли данное событие выполняться на основе выражения Cron. | |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в заданной среде. | |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | |
| $this | storeOutput() Обеспечить сохранение вывода на диск в файле журнала. | |
| $this | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в заданное местоположение. | |
| $this | appendOutputTo(string $location) Добавить вывод команды к заданному местоположению. |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)
Отправить электронное письмо с результатами запланированной операции. | |
| $this | emailWrittenOutputTo(array|mixed $addresses)
Отправить электронное письмо с результатами запланированной операции, если она произвела вывод. | |
| $this | emailOutputOnFailure(array|mixed $addresses)
Отправить электронное письмо с результатами запланированной операции, если она завершилась неудачно. | |
| void | ensureOutputIsBeingCaptured()
Убедиться, что вывод команды захватывается. | |
| 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 | pingOnSuccess(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция выполнена успешно. | |
| $this | pingOnFailure(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL, если операция завершилась неудачей. | |
| Closure | pingCallback(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 | thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод после выполнения задачи. | |
| $this | onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно. | |
| $this | onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод, если операция выполнена успешно. | |
| $this | onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция завершилась неудачей. | |
| $this | onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод, если операция завершилась неудачей. | |
| Closure | withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)
Получить обратный вызов, предоставляющий вывод. | |
| $this | name(string $description)
Установить описание события, понятное человеку. | |
| $this | description(string $description)
Установить описание события, понятное человеку. | |
| string | getSummaryForDisplay()
Получить краткое описание события для отображения. | |
| Carbon | nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)
Определить следующую дату выполнения события. | |
| string | getExpression()
Получить выражение Cron для события. | |
| $this | preventOverlapsUsing(EventMutex $mutex)
Установить реализацию блокировки событий, используемую для предотвращения наложений. |
Details
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Добавить другой объект в класс.
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 everyTwoMinutes()
Настроить событие для выполнения каждую две минуты.
$this everyThreeMinutes()
Настроить событие для выполнения каждую три минуты.
$this everyFourMinutes()
Настроить событие для выполнения каждую четыре минуты.
$this everyFiveMinutes()
Настроить событие для выполнения каждую пять минут.
$this everyTenMinutes()
Настроить событие для выполнения каждые десять минут.
$this everyFifteenMinutes()
Настроить событие для выполнения каждые пятнадцать минут.
$this everyThirtyMinutes()
Настроить событие для выполнения каждые тридцать минут.
$this hourly()
Настроить событие для выполнения каждый час.
$this hourlyAt(array|int $offset)
Настроить событие для выполнения каждый час в заданный интервал.
$this everyTwoHours()
Настроить событие для выполнения каждые два часа.
$this everyThreeHours()
Настроить событие для выполнения каждые три часа.
$this everyFourHours()
Настроить событие для выполнения каждые четыре часа.
$this everySixHours()
Настроить событие для выполнения каждые шесть часов.
$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, string $time = '0:0')
Расписание события два раза в месяц в заданное время.
$this lastDayOfMonth(string $time = '0:0')
Расписание события на последний день месяца.
$this quarterly()
Расписание события ежеквартально.
$this yearly()
Расписание события ежегодно.
$this days(array|mixed $days)
Установить дни недели, в которые должно выполняться задание.
$this timezone(DateTimeZone|string $timezone)
Установить часовой пояс для оценки даты.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
protected array closureParameterTypes(Closure $closure)
Получить имена классов/типы параметров заданного замыкания.
protected string firstClosureParameterType(Closure $closure)
Получить имя класса первого параметра данного замыкания.
void __construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null)
Создать новый экземпляр события.
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" для события.
void callAfterCallbacksWithExitCode(Container $container, int $exitCode)
Вызвать все обратные вызовы "after" для события.
string buildCommand()
Сформировать строку команды.
bool isDue(Application $app)
Определить, должно ли данное событие выполняться на основе выражения Cron.
bool runsInMaintenanceMode()
Определить, выполняется ли событие в режиме технического обслуживания.
protected bool expressionPasses()
Определить, проходит ли выражение Cron.
bool runsInEnvironment(string $environment)
Определить, выполняется ли событие в данном окружении.
bool filtersPass(Application $app)
Определить, проходят ли фильтры для события.
$this storeOutput()
Убедиться, что вывод сохраняется на диске в файле журнала.
$this sendOutputTo(string $location, bool $append = false)
Отправить вывод команды в заданное местоположение.
$this appendOutputTo(string $location)
Добавить вывод команды к заданному местуположения.
$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)
Отправить по электронной почте результаты запланированной операции.
$this emailWrittenOutputTo(array|mixed $addresses)
Отправить по электронной почте результаты запланированной операции, если она сгенерировала вывод.
$this emailOutputOnFailure(array|mixed $addresses)
Отправить по электронной почте результаты запланированной операции, если произошла ошибка.
protected void ensureOutputIsBeingCaptured()
Убедиться, что вывод команды собирается.
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 pingOnSuccess(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL-адрес, если операция выполнена успешно.
$this pingOnFailure(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL-адрес, если операция завершилась неудачно.
protected Closure pingCallback(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 thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, использующий вывод после выполнения задачи.
$this onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно.
$this onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод, если операция выполнена успешно.
$this onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция завершилась с ошибкой.
$this onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод, если операция завершилась с ошибкой.
protected Closure withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)
Получить обратный вызов, который предоставляет вывод.
$this name(string $description)
Установить описание события, понятное человеку.
$this description(string $description)
Установить описание события, понятное человеку.
string getSummaryForDisplay()
Получить краткое описание события для отображения.
Carbon nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, 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/7.x/Illuminate/Console/Scheduling/Event.html