CallbackEvent
class CallbackEvent extends Event (View source)
Свойства
| Macroable | |
| ManagesFrequencies |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| string | $command | Строка команды. | из Event |
| string | $expression | Выражение cron, определяющее частоту события. | из Event |
| DateTimeZone|string | $timezone | Часовой пояс, в котором должно быть вычислено время. | из Event |
| string | $user | Пользователь, от имени которого должна выполняться команда. | из Event |
| array | $environments | Список сред, в которых должна выполняться команда. | из Event |
| bool | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | из Event |
| bool | $withoutOverlapping | Указывает, не должна ли команда накладываться сама на себя. | из Event |
| bool | $onOneServer | Указывает, должна ли команда выполняться только на одном сервере для каждого cron-выражения. | из Event |
| int | $expiresAt | Время действия мьютекса. | из Event |
| bool | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | из Event |
| protected array | $filters | Массив колбэков-фильтров. | из Event |
| protected array | $rejects | Массив колбэков-отклонений. | из Event |
| string | $output | Место назначения вывода. | из Event |
| bool | $shouldAppendOutput | Указывает, должен ли вывод добавляться в конец. | из Event |
| protected array | $beforeCallbacks | Массив колбэков, которые нужно выполнить перед началом события. | из Event |
| protected array | $afterCallbacks | Массив колбэков, которые нужно выполнить после завершения события. | из Event |
| string | $description | Человекочитаемое описание события. | из Event |
| EventMutex | $mutex | Реализация мьютекса события. | из Event |
| int|null | $exitCode | Код завершения выполнения команды. | из Event |
| protected string | $callback | Вызываемый колбэк. | |
| protected array | $parameters | Параметры для передачи методу. |
Методы
| 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 | monthlyOn(int $day = 1, string $time = '0:0') Настроить событие на ежемесячное выполнение в заданный день и время. | из 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 $callback, array $parameters = []) Создать новый экземпляр события. | |
| string | getDefaultOutput() Получить значение по умолчанию для вывода в зависимости от ОС. | из Event |
| void | run(Container $container) Выполнить заданное событие. | |
| string | mutexName() Получить имя мьютекса для запланированной команды. | |
| void | runCommandInForeground(Container $container) Выполнить команду в фоновом режиме. | из Event |
| void | runCommandInBackground(Container $container) Выполнить команду в фоновом режиме. | из Event |
| void | callBeforeCallbacks(Container $container) Вызвать все обратные вызовы "до" для события. | из Event |
| void | callAfterCallbacks(Container $container) Вызвать все обратные вызовы "после" для события. | из Event |
| string | buildCommand() Сформировать строку команды. | из Event |
| bool | isDue(Application $app) Определить, должно ли заданное событие выполняться на основе выражения Cron. | из Event |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | из Event |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | из Event |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в заданной среде. | из Event |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | из Event |
| $this | storeOutput() Обеспечить сохранение вывода на диске в файле журнала. | из Event |
| $this | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в указанное местоположение. | из Event |
| $this | appendOutputTo(string $location) Добавить вывод команды к указанному местуположение. | из Event |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false) Отправить результаты запланированной операции по электронной почте. | из Event |
| $this | emailWrittenOutputTo(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она генерирует вывод. | из Event |
| $this | emailOutputOnFailure(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если произошла ошибка. | из Event |
| void | ensureOutputIsBeingCaptured() Убедиться, что вывод команды захватывается. | из Event |
| void | emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить вывод события по электронной почте получателям. | из Event |
| string | getEmailSubject() Получить тему письма для результатов вывода. | из Event |
| $this | pingBefore(string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL перед выполнением задачи. | из Event |
| $this | pingBeforeIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL перед выполнением задачи, если заданное условие истинно. | из Event |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL после выполнения задачи. | из Event |
| $this | thenPingIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL после выполнения задачи, если заданное условие истинно. | из Event |
| $this | pingOnSuccess(string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL, если операция выполнилась успешно. | из Event |
| $this | pingOnFailure(string $url) Зарегистрировать обратный вызов для отправки пинга на заданный URL, если операция завершилась неудачей. | из Event |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | из Event |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | из Event |
| $this | environments(array|mixed $environments) Ограничить окружения, в которых должна выполняться команда. | из Event |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | из Event |
| $this | withoutOverlapping(int $expiresAt = 1440) Запретить перекрытие событий. | |
| $this | onOneServer() Разрешить выполнение события только на одном сервере для каждого выражения cron. | |
| $this | when(Closure|bool $callback) Зарегистрировать обратный вызов для дополнительной фильтрации расписания. | из Event |
| $this | skip(Closure|bool $callback) Зарегистрировать обратный вызов для дополнительной фильтрации расписания. | из Event |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | из Event |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | из Event |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | из Event |
| $this | onSuccess(Closure $callback) Зарегистрировать обратный вызов, который будет вызван, если операция выполнится успешно. | из Event |
| $this | onFailure(Closure $callback) Зарегистрировать обратный вызов, который будет вызван, если операция завершится неудачей. | из Event |
| $this | name(string $description) Установить описание события для удобного восприятия человеком. | из Event |
| $this | description(string $description) Установить описание события для удобного восприятия человеком. | из Event |
| string | getSummaryForDisplay() Получить сводку события для отображения. | |
| Carbon | nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false) Определить следующую дату выполнения события. | из Event |
| string | getExpression() Получить выражение Cron для события. | из Event |
| $this | preventOverlapsUsing(EventMutex $mutex) Установить реализацию блокировки событий, которую следует использовать. | из Event |
| void | removeMutex() Очистить блокировку для события. |
Подробности
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 $callback, array $parameters = [])
Создать новый экземпляр события.
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 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-адрес, если операция завершилась с ошибкой.
$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)
Установить реализацию блокировки событий, которая будет использоваться.
protected void removeMutex()
Очистить блокировку для события.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.8/Illuminate/Console/Scheduling/CallbackEvent.html
