CallbackEvent
class CallbackEvent extends Event (View source)
Свойства
| Macroable | |
| ManagesFrequencies | |
| ReflectsClosures |
Свойства
| 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 |
| int|null | $exitCode | Код завершения команды. | from 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 | everyTwoMinutes()
Настроить событие на выполнение каждые две минуты. | from ManagesFrequencies |
| $this | everyThreeMinutes()
Настроить событие на выполнение каждые три минуты. | from ManagesFrequencies |
| $this | everyFourMinutes()
Настроить событие на выполнение каждые четыре минуты. | from ManagesFrequencies |
| $this | everyFiveMinutes()
Настроить событие на выполнение каждые пять минут. | from ManagesFrequencies |
| $this | everyTenMinutes()
Настроить событие на выполнение каждые десять минут. | from ManagesFrequencies |
| $this | everyFifteenMinutes()
Настроить событие на выполнение каждые пятнадцать минут. | from ManagesFrequencies |
| $this | everyThirtyMinutes()
Настройте событие для запуска каждые тридцать минут. | из ManagesFrequencies |
| $this | hourly()
Настройте событие для запуска каждый час. | из ManagesFrequencies |
| $this | hourlyAt(array|int $offset)
Настройте событие для запуска каждый час в заданный интервал. | из ManagesFrequencies |
| $this | everyTwoHours()
Настройте событие для запуска каждые два часа. | из ManagesFrequencies |
| $this | everyThreeHours()
Настройте событие для запуска каждые три часа. | из ManagesFrequencies |
| $this | everyFourHours()
Настройте событие для запуска каждые четыре часа. | из ManagesFrequencies |
| $this | everySixHours()
Настройте событие для запуска каждые шесть часов. | из ManagesFrequencies |
| $this | daily()
Настройте событие для ежедневного запуска. | из ManagesFrequencies |
| $this | at(string $time)
Настройте команду на запуск в заданное время. | из ManagesFrequencies |
| $this | dailyAt(string $time)
Настройте событие для запуска ежедневно в заданное время (10:00, 19:30 и т. д.). | из ManagesFrequencies |
| $this | twiceDaily(int $first = 1, int $second = 13)
Настройте событие для запуска дважды в день. | из ManagesFrequencies |
| $this | weekdays()
Настройте событие для запуска только в будние дни. | из ManagesFrequencies |
| $this | weekends()
Настройте событие для запуска только в выходные дни. | из ManagesFrequencies |
| $this | mondays()
Настройте событие для запуска только по понедельникам. | из ManagesFrequencies |
| $this | tuesdays()
Настройте событие для запуска только по вторникам. | из ManagesFrequencies |
| $this | wednesdays()
Настройте событие для запуска только по средам. | из ManagesFrequencies |
| $this | thursdays()
Настройте событие для запуска только по четвергам. | из ManagesFrequencies |
| $this | fridays()
Настройте событие для запуска только по пятницам. | из ManagesFrequencies |
| $this | saturdays()
Настройте событие для запуска только по субботам. | из ManagesFrequencies |
| $this | sundays()
Настройте событие для запуска только по воскресеньям. | из ManagesFrequencies |
| $this | weekly()
Настройте событие для еженедельного запуска. | из ManagesFrequencies |
| $this | weeklyOn(int $day, string $time = '0:0')
Настройте событие для еженедельного запуска в определенный день и время. | из ManagesFrequencies |
| $this | monthly()
Настройте событие для ежемесячного запуска. | из ManagesFrequencies |
| $this | monthlyOn(int $day = 1, string $time = '0:0')
Настройте событие для ежемесячного запуска в определенный день и время. | из ManagesFrequencies |
| $this | twiceMonthly(int $first = 1, int $second = 16, string $time = '0:0')
Настройте событие для двухкратного ежемесячного запуска в заданное время. | из ManagesFrequencies |
| $this | lastDayOfMonth(string $time = '0:0')
Настройте событие для запуска в последний день месяца. | из 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 |
| array | closureParameterTypes(Closure $closure)
Получить имена/типы параметров данного замыкания. | from ReflectsClosures |
| string | firstClosureParameterType(Closure $closure)
Получить имя класса первого параметра данного замыкания. | from ReflectsClosures |
| void | __construct(EventMutex $mutex, string $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)
Создать новый экземпляр события. | |
| string | getDefaultOutput()
Получить значение по умолчанию вывода в зависимости от ОС. | from Event |
| void | run(Container $container)
Выполнить данное событие. | |
| string | mutexName()
Получить имя мьютекса для запланированной команды. | |
| void | runCommandInForeground(Container $container)
Выполнить команду в фоновом режиме. | from Event |
| void | runCommandInBackground(Container $container)
Выполнить команду в фоновом режиме. | from Event |
| void | callBeforeCallbacks(Container $container)
Вызвать все "перед" обратные вызовы для события. | from Event |
| void | callAfterCallbacks(Container $container)
Вызвать все "после" обратные вызовы для события. | from Event |
| void | callAfterCallbacksWithExitCode(Container $container, int $exitCode)
Вызвать все "после" обратные вызовы для события. | from Event |
| string | buildCommand()
Сформировать строку команды. | from Event |
| bool | isDue(Application $app)
Определить, должно ли данное событие выполняться в соответствии с выражением Cron. | from Event |
| bool | runsInMaintenanceMode()
Определить, выполняется ли событие в режиме технического обслуживания. | from 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 | thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод после выполнения задачи. | из Event |
| $this | onSuccess(Closure $callback)
Зарегистрировать обработчик, который будет вызван, если операция выполнена успешно. | из Event |
| $this | onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обработчик, использующий вывод, если операция выполнена успешно. | из Event |
| $this | onFailure(Closure $callback)
Зарегистрировать обработчик, который будет вызван, если операция завершилась неудачно. | из Event |
| $this | onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обработчик, использующий вывод, если операция завершилась неудачно. | из Event |
| Closure | withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)
Получить обработчик, предоставляющий вывод. | из 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 everyTwoMinutes()
Настроить событие для выполнения каждую две минуты.
$this everyThreeMinutes()
Настроить событие для выполнения каждую три минуты.
$this everyFourMinutes()
Настройте событие для выполнения каждые четыре минуты.
$this everyFiveMinutes()
Настройте событие для выполнения каждые пять минут.
$this everyTenMinutes()
Настройте событие для выполнения каждые десять минут.
$this everyFifteenMinutes()
Настройте событие для выполнения каждые пятнадцать минут.
$this everyThirtyMinutes()
Настройте событие для выполнения каждые тридцать минут.
$this hourly()
Настройте событие для выполнения каждый час.
$this hourlyAt(array|int $offset)
Настройте событие для выполнения каждый час в заданный момент.
$this everyTwoHours()
Настройте событие для выполнения каждые два часа.
$this everyThreeHours()
Настройте событие для выполнения каждые три часа.
$this everyFourHours()
Настройте событие для выполнения каждые четыре часа.
$this everySixHours()
Настройте событие для выполнения каждые шесть часов.
$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, string $time = '0:0')
Настройте событие для запуска два раза в месяц в заданное время.
$this lastDayOfMonth(string $time = '0:0')
Настройте событие для запуска в последний день месяца.
$this quarterly()
Настройте событие для запуска ежеквартально.
$this yearly()
Настройте событие для запуска ежегодно.
$this days(array|mixed $days)
Установите дни недели, в которые должна выполняться команда.
$this timezone(DateTimeZone|string $timezone)
Установите часовой пояс, в котором должно оцениваться время.
protected $this spliceIntoPosition(int $position, string $value)
Вставить заданное значение в заданную позицию выражения.
protected array closureParameterTypes(Closure $closure)
Получить имена/типы параметров заданного Closure.
protected string firstClosureParameterType(Closure $closure)
Получить имя класса первого параметра заданного Closure.
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)
Зарегистрировать обратный вызов для отправки запроса ping на указанный URL после выполнения задачи, если заданное условие истинно.
$this pingOnSuccess(string $url)
Зарегистрировать обратный вызов для отправки запроса ping на указанный URL, если операция выполнена успешно.
$this pingOnFailure(string $url)
Зарегистрировать обратный вызов для отправки запроса ping на указанный 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 thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод после выполнения задачи.
$this onSuccess(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция выполняется успешно.
$this onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, который использует вывод, если операция выполняется успешно.
$this onFailure(Closure $callback)
Зарегистрировать обратный вызов, который будет вызван, если операция завершится неудачно.
$this onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)
Зарегистрировать обратный вызов, использующий вывод, если операция завершится неудачно.
protected Closure withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)
Получить обратный вызов, предоставляющий вывод.
$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/7.x/Illuminate/Console/Scheduling/CallbackEvent.html
