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 | 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 $callback, array $parameters = [], DateTimeZone|string|null $timezone = null) Создать новый экземпляр события. | |
| 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 |
| void | callAfterCallbacksWithExitCode(Container $container, int $exitCode) Вызвать все "после" колбэки для события. | из 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 |
| Closure | pingCallback(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 = [], 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)
Получить обработчик, который отправляет запрос 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 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/6.x/Illuminate/Console/Scheduling/CallbackEvent.html
