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 |
| 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 |
| Mutex | $mutex | Реализация мьютекса. | from Event |
| protected string | $callback | Вызываемый коллбэк. | |
| protected array | $parameters | Параметры для передачи методу. |
Методы
| static void | macro(string $name, callable $macro) Зарегистрировать пользовательский макрос. | 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 | 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') Настройте событие для ежемесячного запуска в определенный день и время. | from ManagesFrequencies |
| $this | twiceMonthly(int $first = 1, int $second = 16) Настройте событие для запуска дважды в месяц. | from ManagesFrequencies |
| $this | quarterly() Настройте событие для запуска ежеквартально. | from ManagesFrequencies |
| $this | yearly() Настройте событие для ежегодного запуска. | from ManagesFrequencies |
| $this | everyMinute() Настройте событие для запуска каждую минуту. | from ManagesFrequencies |
| $this | everyFiveMinutes() Настройте событие для запуска каждую пять минут. | from ManagesFrequencies |
| $this | everyTenMinutes() Распланировать событие для запуска каждые десять минут. | из ManagesFrequencies |
| $this | everyThirtyMinutes() Распланировать событие для запуска каждые тридцать минут. | из ManagesFrequencies |
| $this | days(array|mixed $days) Установить дни недели, в которые должна выполняться команда. | из ManagesFrequencies |
| $this | timezone(DateTimeZone|string $timezone) Установить часовой пояс, в котором должна оцениваться дата. | из ManagesFrequencies |
| $this | spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения. | из ManagesFrequencies |
| void | __construct(Mutex $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() Определить, выполняется ли событие в режиме технического обслуживания. | from Event |
| bool | expressionPasses() Определить, проходит ли выражение Cron. | from Event |
| bool | runsInEnvironment(string $environment) Определить, выполняется ли событие в заданной среде. | from Event |
| bool | filtersPass(Application $app) Определить, проходят ли фильтры для события. | 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() Убедиться, что вывод сохраняется для отправки по электронной почте. | 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 | thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса на заданный URL после запуска задачи. | from Event |
| $this | runInBackground() Указать, что команда должна выполняться в фоновом режиме. | from Event |
| $this | user(string $user) Указать, от имени какого пользователя должна выполняться команда. | from Event |
| $this | environments(array|mixed $environments) Ограничить среды, в которых должна выполняться команда. | из Event |
| $this | evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме технического обслуживания. | из Event |
| $this | withoutOverlapping(int $expiresAt = 1440) Не допускать перекрытия событий друг другом. | |
| $this | when(Closure $callback) Зарегистрировать обратный вызов для дополнительной фильтрации расписания. | из Event |
| $this | skip(Closure $callback) Зарегистрировать обратный вызов для дополнительной фильтрации расписания. | из Event |
| $this | before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией. | из Event |
| $this | after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | из Event |
| $this | then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции. | из Event |
| $this | name(string $description) Установить описание события для удобного восприятия человеком. | из Event |
| $this | description(string $description) Установить описание события для удобного восприятия человеком. | из Event |
| string | getSummaryForDisplay() Получить сводку события для отображения. | |
| Carbon | nextRunDate(DateTime|string $currentTime = 'now', int $nth, bool $allowCurrentDate = false) Определить следующую дату выполнения события. | из Event |
| string | getExpression() Получить выражение Cron для события. | из Event |
| $this | preventOverlapsUsing(Mutex $mutex) Установить реализацию взаимного исключения, которая будет использоваться. | из Event |
| void | removeMutex() Очистить взаимное исключение для события. |
Подробности
static void macro(string $name, callable $macro)
Зарегистрировать пользовательское макро.
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 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 everyMinute()
Настройте событие на выполнение каждую минуту.
$this everyFiveMinutes()
Настройте событие на выполнение каждую пять минут.
$this everyTenMinutes()
Настройте событие на выполнение каждую десять минут.
$this everyThirtyMinutes()
Настройте событие на выполнение каждые тридцать минут.
$this days(array|mixed $days)
Установите дни недели, в которые должно выполняться задание.
$this timezone(DateTimeZone|string $timezone)
Установите часовой пояс, в котором должно оцениваться дата.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
void __construct(Mutex $mutex, string $callback, array $parameters = [])
Создать новый экземпляр события.
string getDefaultOutput()
Получить стандартный вывод в зависимости от ОС.
void run(Контейнер $container)
Выполнить заданное событие.
string mutexName()
Получить имя мьютекса для запланированной команды.
protected void runCommandInForeground(Контейнер $container)
Выполнить команду в фоновом режиме.
protected void runCommandInBackground(Контейнер $container)
Выполнить команду в фоновом режиме.
void callBeforeCallbacks(Контейнер $container)
Вызвать все обратные вызовы "before" для события.
void callAfterCallbacks(Контейнер $container)
Вызвать все обратные вызовы "after" для события.
string buildCommand()
Создать строку команды.
bool isDue(Приложение $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 thenPing(string $url)
Зарегистрировать обратный вызов для отправки запроса на указанный URL после выполнения задачи.
$this runInBackground()
Указать, что команда должна выполняться в фоновом режиме.
$this user(string $user)
Указать, от имени какого пользователя должна выполняться команда.
$this environments(array|mixed $environments)
Ограничить среды, в которых должна выполняться команда.
$this evenInMaintenanceMode()
Указать, что команда должна выполняться даже в режиме технического обслуживания.
$this withoutOverlapping(int $expiresAt = 1440)
Не допускать перекрытия событий.
$this when(Closure $callback)
Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.
$this skip(Closure $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(Mutex $mutex)
Установить реализацию мьютекса, которую нужно использовать.
protected void removeMutex()
Очистить мьютекс для события.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Console/Scheduling/CallbackEvent.html
