CallbackEvent
класс CallbackEvent расширяет 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 |
| строка | buildCommand() Создать строку команды. | из Event |
| логическое | isDue(Application $app) Определить, должно ли данное событие выполняться на основе выражения Cron. | из Event |
| логическое | runsInMaintenanceMode() Определить, выполняется ли событие в режиме технического обслуживания. | из Event |
| логическое | expressionPasses() Определить, выполняется ли выражение Cron. | из Event |
| логическое | runsInEnvironment(строка $environment) Определить, выполняется ли событие в заданной среде. | из Event |
| логическое | filtersPass(Application $app) Определить, проходят ли фильтры для события. | из Event |
| $this | sendOutputTo(строка $location, логическое $append = false) Отправить вывод команды в заданное место. | из Event |
| $this | appendOutputTo(строка $location) Добавить вывод команды к заданному месту. | из Event |
| $this | emailOutputTo(массив|смешанное $addresses, логическое $onlyIfOutputExists = false) Отправить электронное письмо с результатами запланированной операции. | из Event |
| $this | emailWrittenOutputTo(массив|смешанное $addresses) Отправить электронное письмо с результатами запланированной операции, если она создаёт вывод. | из Event |
| пусто | ensureOutputIsBeingCapturedForEmail() Убедиться, что вывод сохраняется для отправки по электронной почте. | из Event |
| пусто | emailOutput(Mailer $mailer, массив $addresses, логическое $onlyIfOutputExists = false) Отправить вывод события получателям по электронной почте. | из Event |
| строка | getEmailSubject() Получить строку темы электронного письма для результатов вывода. | из Event |
| $this | pingBefore(строка $url) Зарегистрировать обратный вызов для ping заданного URL перед запуском задачи. | из Event |
| $this | pingBeforeIf(логическое $value, строка $url) Зарегистрировать обратный вызов для ping заданного URL перед запуском задачи, если заданное условие истинно. | из Event |
| $this | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса ping на указанный URL после выполнения задачи. | from Event |
| $this | thenPingIf(bool $value, string $url) Зарегистрировать обратный вызов для отправки запроса ping на указанный 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, 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)
Смешать другой объект в класс.
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)
Вызвать все обратные вызовы "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 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 pingBeforeIf(bool $value, string $url)
Зарегистрировать обратный вызов для проверки URL перед запуском задачи, если заданное условие истинно.
$this thenPing(string $url)
Зарегистрировать обратный вызов для проверки URL после выполнения задачи.
$this thenPingIf(bool $value, string $url)
Зарегистрировать обратный вызов для отправки запроса ping на указанный 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, 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.6/Illuminate/Console/Scheduling/CallbackEvent.html
