CallbackEvent
class CallbackEvent extends Event (View source)
Свойства
| Macroable |
| ManagesFrequencies |
Свойства
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| string | $command | Строка команды. | from Event |
| string | $expression | Выражение cron, представляющее частоту события. | from Event |
| DateTimeZone|string | $timezone | Часовой пояс, в котором должна оцениваться дата. | from Event |
| string | $user | Пользователь, от имени которого должна выполняться команда. | from Event |
| array | $environments | Список сред, в которых должна выполняться команда. | from Event |
| bool | $evenInMaintenanceMode | Указывает, должна ли команда выполняться в режиме технического обслуживания. | from Event |
| bool | $withoutOverlapping | Указывает, не должна ли команда перекрывать сама себя. | from Event |
| bool | $onOneServer | Указывает, должна ли команда выполняться только на одном сервере для каждого выражения cron. | from Event |
| int | $expiresAt | Время действия мьютекса. | from Event |
| bool | $runInBackground | Указывает, должна ли команда выполняться в фоновом режиме. | from Event |
| protected array | $filters | Массив колбеков фильтрации. | from Event |
| protected array | $rejects | Массив колбеков отклонения. | from Event |
| string | $output | Место назначения вывода. | from Event |
| bool | $shouldAppendOutput | Указывает, нужно ли добавлять вывод. | from Event |
| protected array | $beforeCallbacks | Массив колбеков, которые должны быть выполнены перед запуском события. | from Event |
| protected array | $afterCallbacks | Массив колбеков, которые должны быть выполнены после завершения события. | from Event |
| string | $description | Описание события, понятное пользователю. | from Event |
| EventMutex | $mutex | Реализация мьютекса события. | from Event |
| protected string | $callback | Вызываемый колбек. | |
| protected array | $parameters | Параметры для передачи методу. |
Методы
| 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') Настроить событие для ежемесячного выполнения в заданный день и время. | из 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) Вызвать все обратные вызовы "before" для события. | из Event |
| void | callAfterCallbacks(Container $container) Вызвать все обратные вызовы "after" для события. | из Event |
| string | buildCommand() Создать строку команды. | from Event |
| bool | isDue(Application $app) Определить, нужно ли выполнить данное событие на основе выражения Cron. | from Event |
| bool | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | from Event |
| bool | expressionPasses() Определить, соответствует ли выражение Cron. | from Event |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в заданной среде. | from Event |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | from Event |
| $this | storeOutput() Обеспечить сохранение вывода на диск в файл журнала. | from Event |
| $this | sendOutputTo(string $location, bool $append = false) Отправить вывод команды в указанное место. | from Event |
| $this | appendOutputTo(string $location) Добавить вывод команды к указанному месту. | from Event |
| $this | emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false) Отправить результаты запланированной операции по электронной почте. | from Event |
| $this | emailWrittenOutputTo(array|mixed $addresses) Отправить результаты запланированной операции по электронной почте, если она произвела вывод. | from Event |
| void | ensureOutputIsBeingCapturedForEmail() deprecated Обеспечить захват вывода для электронной почты. | from Event |
| void | ensureOutputIsBeingCaptured() Обеспечить захват вывода команды. | from Event |
| void | emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить вывод события получателям по электронной почте. | from Event |
| string | getEmailSubject() Получить тему электронного письма для результатов вывода. | from Event |
| $this | pingBefore(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL перед выполнением задачи. | from Event |
| $this | pingBeforeIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL перед выполнением задачи, если заданное условие истинно. | from Event |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи. | from Event |
| $this | thenPingIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи, если заданное условие истинно. | from Event |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | from Event |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | from Event |
| $this | environments(array|mixed $environments) Ограничить окружения, в которых должна выполняться команда. | from Event |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | from Event |
| $this | withoutOverlapping(int $expiresAt = 1440) Не допускать перекрытия событий друг другом. | |
| $this | onOneServer() Разрешить выполнение события только на одном сервере для каждого выражения cron. | |
| $this | when(Closure|bool $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | from Event |
| $this | skip(Closure|bool $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания. | from Event |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | from Event |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | from Event |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | from Event |
| $this | name(string $description) Установить удобочитаемое описание события. | from Event |
| $this | description(string $description) Установите описание события, понятное для человека. | from Event |
| string | getSummaryForDisplay() Получить краткое описание события для отображения. | |
| Carbon | nextRunDate(DateTime|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false) Определить следующую дату выполнения события. | from Event |
| string | getExpression() Получить выражение Cron для события. | from Event |
| $this | preventOverlapsUsing(EventMutex $mutex) Установить реализацию блокировки событий. | from Event |
| void | removeMutex() Очистить блокировку для события. |
Подробности
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(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)
Вызвать все обратные вызовы "перед" событием.
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 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)
Отправить по электронной почте результаты запланированной операции, если она генерирует вывод.
protected void ensureOutputIsBeingCapturedForEmail() устаревший
устаревший
Убедиться, что вывод захватывается для электронной почты.
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 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 name(string $description)
Установить описание события, понятное человеку.
$this description(string $description)
Указать описание события, понятное пользователю.
string getSummaryForDisplay()
Получить сводку события для отображения.
Carbon nextRunDate(DateTime|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.7/Illuminate/Console/Scheduling/CallbackEvent.html
