Событие
класс Событие (Просмотреть исходный код)
Трейты
| Macroable | |
| ManagesFrequencies |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| строка | $command | Строка команды. | |
| строка | $expression | Выражение cron, представляющее частоту события. | |
| DateTimeZone|строка | $timezone | Временная зона, в которой следует оценивать дату. | |
| строка | $user | Пользователь, от имени которого должна выполняться команда. | |
| массив | $environments | Список сред, в которых должна выполняться команда. | |
| логическое значение | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | |
| логическое значение | $withoutOverlapping | Указывает, должна ли команда не перекрывать себя. | |
| логическое значение | $onOneServer | Указывает, должна ли команда выполняться только на одном сервере для каждого выражения cron. | |
| целое число | $expiresAt | Время действия мьютекса. | |
| логическое значение | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | |
| защищённый массив | $filters | Массив обратных вызовов фильтрации. | |
| защищённый массив | $rejects | Массив обратных вызовов отклонения. | |
| строка | $output | Место назначения вывода. | |
| логическое значение | $shouldAppendOutput | Указывает, следует ли добавлять вывод. | |
| защищённый массив | $beforeCallbacks | Массив обратных вызовов, которые будут вызваны перед началом события. | |
| защищённый массив | $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 | 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 | 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(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)
Вызвать все "до" обратные вызовы для события. | |
| void | callAfterCallbacks(Container $container)
Вызвать все "после" обратные вызовы для события. | |
| void | callAfterCallbacksWithExitCode(Container $container, int $exitCode)
Вызвать все "после" обратные вызовы для события. | |
| 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 | onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван в случае успеха операции. | |
| $this | onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван в случае неудачи операции. | |
| $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 everyFiveMinutes()
Настройка события для ежепятиминутного выполнения.
$this everyTenMinutes()
Настройка события для ежедесятиминутного выполнения.
$this everyFifteenMinutes()
Настройка события для ежепятнадцатиминутного выполнения.
$this everyThirtyMinutes()
Настройка события для ежетридцатиминутного выполнения.
$this hourly()
Запланировать событие на выполнение каждый час.
$this hourlyAt(array|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(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 onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно.
$this onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция завершилась неудачно.
$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/6.x/Illuminate/Console/Scheduling/Event.html
