Spec-Zone.ru › Laravel 11

CallbackEvent

class CallbackEvent extends Event (View source)

Свойства

Macroable
ManagesFrequencies
ReflectsClosures
Tappable

Свойства

static protected array $macros

Зарегистрированные строковые макросы.

from Macroable
string|null $command

Строка команды.

from Event
string $expression

Выражение cron, представляющее частоту выполнения события.

from Event
int|null $repeatSeconds

Частота повторения события в течение минуты.

from Event
DateTimeZone|string $timezone

Часовой пояс, в котором должно оцениваться время.

from Event
string|null $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|null $description

Человекопонятное описание события.

from Event
EventMutex $mutex

Реализация мьютекса события.

from Event
Closure|null $mutexNameResolver

Обратный вызов для разрешения имени мьютекса.

from Event
protected Carbon|null $lastChecked

Последний раз, когда событие проверялось на возможность выполнения.

from Event
int|null $exitCode

Код завершения команды.

from Event
protected string $callback

Вызываемый обратный вызов.

protected array $parameters

Параметры, передаваемые методу.

protected mixed $result

Результат выполнения обратного вызова.

protected Throwable|null $exception

Исключение, которое было выброшено при вызове обратного вызова, если таковое имелось.

Методы

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 void flushMacros()

Очистить существующие макрокоманды.

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)

Расписание события для выполнения между начальным и конечным временем.

от ManagesFrequencies
$this unlessBetween(string $startTime, string $endTime)

Расписание события для невыполнения между начальным и конечным временем.

от ManagesFrequencies
$this everySecond()

Расписание события для выполнения каждую секунду.

от ManagesFrequencies
$this everyTwoSeconds()

Расписание события для выполнения каждую две секунды.

от ManagesFrequencies
$this everyFiveSeconds()

Расписание события для выполнения каждую пять секунд.

от ManagesFrequencies
$this everyTenSeconds()

Расписание события для выполнения каждую десять секунд.

от ManagesFrequencies
$this everyFifteenSeconds()

Расписание события для выполнения каждую пятнадцать секунд.

от ManagesFrequencies
$this everyTwentySeconds()

Настроить выполнение события каждые двадцать секунд.

из ManagesFrequencies
$this everyThirtySeconds()

Настроить выполнение события каждые тридцать секунд.

из ManagesFrequencies
$this repeatEvery(int $seconds)

Настроить выполнение события несколько раз в минуту.

из ManagesFrequencies
$this everyMinute()

Настроить выполнение события каждую минуту.

из ManagesFrequencies
$this everyTwoMinutes()

Настроить выполнение события каждые две минуты.

из ManagesFrequencies
$this everyThreeMinutes()

Настроить выполнение события каждые три минуты.

из ManagesFrequencies
$this everyFourMinutes()

Настроить выполнение события каждые четыре минуты.

из ManagesFrequencies
$this everyFiveMinutes()

Распланировать событие для выполнения каждые пять минут.

из ManagesFrequencies
$this everyTenMinutes()

Распланировать событие для выполнения каждые десять минут.

из ManagesFrequencies
$this everyFifteenMinutes()

Распланировать событие для выполнения каждые пятнадцать минут.

из ManagesFrequencies
$this everyThirtyMinutes()

Распланировать событие для выполнения каждые тридцать минут.

из ManagesFrequencies
$this hourly()

Распланировать событие для выполнения каждый час.

из ManagesFrequencies
$this hourlyAt(array|string|int $offset)

Распланировать событие для выполнения каждый час в заданный момент.

из ManagesFrequencies
$this everyOddHour(array|string|int $offset = 0)

Распланировать событие для выполнения в каждый нечетный час.

из ManagesFrequencies
$this everyTwoHours(array|string|int $offset = 0)

Настройте событие для запуска каждые два часа.

из ManagesFrequencies
$this everyThreeHours(array|string|int $offset = 0)

Настройте событие для запуска каждые три часа.

из ManagesFrequencies
$this everyFourHours(array|string|int $offset = 0)

Настройте событие для запуска каждые четыре часа.

из ManagesFrequencies
$this everySixHours(array|string|int $offset = 0)

Настройте событие для запуска каждые шесть часов.

из 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 twiceDailyAt(int $first = 1, int $second = 13, int $offset = 0)

Настроить событие для запуска дважды в день в заданный интервал.

из ManagesFrequencies
$this hourBasedSchedule(array|string|int $minutes, array|string|int $hours)

Настроить событие для запуска в заданные минуты и часы.

из ManagesFrequencies
$this weekdays()

Настроить событие для запуска только в будние дни.

из ManagesFrequencies
$this weekends()

Настроить событие для запуска только в выходные дни.

из ManagesFrequencies
$this mondays()

Настроить событие для запуска только в понедельник.

из ManagesFrequencies
$this tuesdays()

Настроить событие для запуска только во вторник.

из 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(array|mixed $dayOfWeek, string $time = '0:0')

Настройте событие для еженедельного запуска в определенный день и время.

from ManagesFrequencies
$this monthly()

Настройте событие для ежемесячного запуска.

from ManagesFrequencies
$this monthlyOn(int $dayOfMonth = 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 quarterlyOn(int $dayOfQuarter = 1, string $time = '0:0')

Настроить событие для запуска ежеквартально в заданный день и время.

из ManagesFrequencies
$this yearly()

Настроить событие для запуска ежегодно.

из ManagesFrequencies
$this yearlyOn(int $month = 1, int|string $dayOfMonth = 1, string $time = '0:0')

Настроить событие для запуска ежегодно в заданный месяц, день и время.

из ManagesFrequencies
$this days(array|mixed $days)

Установите дни недели, в которые должна выполняться команда.

из ManagesFrequencies
$this timezone(DateTimeZone|string $timezone)

Установите часовой пояс, в котором следует оценивать дату.

из ManagesFrequencies
$this spliceIntoPosition(int $position, string $value)

Вставьте заданное значение в заданную позицию выражения.

из ManagesFrequencies
string firstClosureParameterType(Closure $closure)

Получить имя класса первого параметра данного замыкания.

из ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

Получить имена классов первого параметра данного замыкания, включая типы объединений.

из ReflectsClosures
array closureParameterTypes(Closure $closure)

Получить имена/типы параметров данного замыкания.

из ReflectsClosures
tap($callback = null)

Вызвать переданный замыкание (Closure) с этим экземпляром, а затем вернуть экземпляр.

from Tappable
void __construct(EventMutex $mutex, string|callable $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

Создать новый экземпляр события.

string getDefaultOutput()

Получить стандартный вывод в зависимости от ОС.

from Event
void run(Container $container)

Выполнить вызываемое событие.

bool shouldSkipDueToOverlapping()

Определить, должно ли событие быть пропущено из-за перекрытия с другим процессом.

bool isRepeatable()

Определить, настроено ли событие на повторение несколько раз в минуту.

from Event
bool shouldRepeatNow()

Определить, готово ли событие к повторению.

from Event
int start(Container $container)

Выполнить процесс команды.

from Event
int execute(Container $container)

Выполнить обратный вызов.

void finish(Container $container, int $exitCode)

Отметить процесс выполнения команды как завершенный и выполнить обратные вызовы/очистку.

из Event
void callBeforeCallbacks(Container $container)

Вызвать все обратные вызовы "before" для события.

из Event
void callAfterCallbacks(Container $container)

Вызвать все обратные вызовы "after" для события.

из Event
string buildCommand()

Сформировать строку команды.

из Event
bool isDue(Application $app)

Определить, должно ли данное событие выполняться на основе выражения Cron.

из Event
bool runsInMaintenanceMode()

Определить, выполняется ли событие в режиме технического обслуживания.

из 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
$this emailOutputOnFailure(array|mixed $addresses)

Отправить электронное письмо с результатами запланированной операции, если она завершилась ошибкой.

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-адрес после выполнения задачи.

из 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
ClientInterface getHttpClient(Container $container)

Получить HTTP-клиент Guzzle для отправки запросов.

из Event
$this runInBackground()

Указать, что обратный вызов должен выполняться в фоновом режиме.

$this user(string $user)

Указать пользователя, от имени которого должна выполняться команда.

из 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 thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий вывод после выполнения задачи.

from Event
$this onSuccess(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван, если операция выполнена успешно.

from Event
$this onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий вывод, если операция выполнена успешно.

from Event
$this onFailure(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван, если операция завершилась неудачно.

from Event
$this onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий вывод, если операция завершилась неудачно.

from Event
Closure withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)

Получить обратный вызов, предоставляющий вывод.

from Event
$this name(string $description)

Установить описание события, понятное человеку.

from Event
$this description(string $description)

Установить описание события, понятное человеку.

from Event
string getSummaryForDisplay()

Получить сводку события для отображения.

Carbon nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)

Определить следующую дату выполнения события.

from Event
string getExpression()

Получить выражение Cron для события.

from Event
$this preventOverlapsUsing(EventMutex $mutex)

Установить реализацию взаимного исключения для события.

from Event
string mutexName()

Получить имя мьютекса для запланированной команды.

$this createMutexNameUsing(Closure|string $mutexName)

Установить имя мьютекса или обратный вызов для получения имени.

из Event
void removeMutex()

Очистить мьютекс для события.

Подробности

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string $name
object|callable $macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

object $mixin
bool $replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Параметры

string $name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

$this cron(string $expression)

Выражение Cron, определяющее частоту события.

Параметры

string $expression

Возвращаемое значение

$this

$this between(string $startTime, string $endTime)

Настроить событие для выполнения между начальным и конечным временем.

Параметры

string $startTime
string $endTime

Возвращаемое значение

$this

$this unlessBetween(string $startTime, string $endTime)

Настроить событие для того, чтобы оно не выполнялось между начальным и конечным временем.

Параметры

string $startTime
string $endTime

Возвращаемое значение

$this

$this everySecond()

Настроить событие для выполнения каждую секунду.

Возвращаемое значение

$this

$this everyTwoSeconds()

Настроить событие для выполнения каждые две секунды.

Возвращаемое значение

$this

$this everyFiveSeconds()

Настроить событие для выполнения каждые пять секунд.

Возвращаемое значение

$this

$this everyTenSeconds()

Настроить событие для выполнения каждые десять секунд.

Возвращаемое значение

$this

$this everyFifteenSeconds()

Настройка события для выполнения каждые пятнадцать секунд.

Значение возврата

$this

$this everyTwentySeconds()

Настройка события для выполнения каждые двадцать секунд.

Значение возврата

$this

$this everyThirtySeconds()

Настройка события для выполнения каждые тридцать секунд.

Значение возврата

$this

protected $this repeatEvery(int $seconds)

Настройка события для выполнения несколько раз в минуту.

Параметры

int $seconds

Значение возврата

$this

$this everyMinute()

Настройка события для выполнения каждую минуту.

Значение возврата

$this

$this everyTwoMinutes()

Настройка события для выполнения каждые две минуты.

Значение возврата

$this

$this everyThreeMinutes()

Настройка события для выполнения каждые три минуты.

Значение возврата

$this

$this everyFourMinutes()

Настроить событие для запуска каждые четыре минуты.

Возвращаемое значение

$this

$this everyFiveMinutes()

Настроить событие для запуска каждые пять минут.

Возвращаемое значение

$this

$this everyTenMinutes()

Настроить событие для запуска каждые десять минут.

Возвращаемое значение

$this

$this everyFifteenMinutes()

Настроить событие для запуска каждые пятнадцать минут.

Возвращаемое значение

$this

$this everyThirtyMinutes()

Настроить событие для запуска каждые тридцать минут.

Возвращаемое значение

$this

$this hourly()

Настроить событие для запуска каждый час.

Возвращаемое значение

$this

$this hourlyAt(array|string|int $offset)

Настроить событие для запуска каждый час в заданный момент.

Параметры

array|string|int $offset

Возвращаемое значение

$this

$this everyOddHour(array|string|int $offset = 0)

Настроить событие на выполнение каждые нечётные часы.

Параметры

array|string|int $offset

Значение результата

$this

$this everyTwoHours(array|string|int $offset = 0)

Настроить событие на выполнение каждые два часа.

Параметры

array|string|int $offset

Значение результата

$this

$this everyThreeHours(array|string|int $offset = 0)

Настроить событие на выполнение каждые три часа.

Параметры

array|string|int $offset

Значение результата

$this

$this everyFourHours(array|string|int $offset = 0)

Настроить событие на выполнение каждые четыре часа.

Параметры

array|string|int $offset

Значение результата

$this

$this everySixHours(array|string|int $offset = 0)

Настроить событие на выполнение каждые шесть часов.

Параметры

array|string|int $offset

Значение результата

$this

$this daily()

Настроить событие для ежедневного выполнения.

Значение результата

$this

$this at(string $time)

Настроить выполнение команды в заданное время.

Параметры

string $time

Значение результата

$this

$this dailyAt(string $time)

Настроить выполнение события ежедневно в заданное время (10:00, 19:30 и т.д.).

Параметры

string $time

Значение результата

$this

$this twiceDaily(int $first = 1, int $second = 13)

Настроить выполнение события дважды в день.

Параметры

int $first
int $second

Значение результата

$this

$this twiceDailyAt(int $first = 1, int $second = 13, int $offset = 0)

Настроить выполнение события дважды в день со смещением.

Параметры

int $first
int $second
int $offset

Значение результата

$this

protected $this hourBasedSchedule(array|string|int $minutes, array|string|int $hours)

Настройте событие для запуска в заданные минуты и часы.

Parameters

array|string|int $minutes
array|string|int $hours

Return Value

$this

$this weekdays()

Настройте событие для запуска только в будние дни.

Return Value

$this

$this weekends()

Настройте событие для запуска только в выходные дни.

Return Value

$this

$this mondays()

Настройте событие для запуска только по понедельникам.

Return Value

$this

$this tuesdays()

Настройте событие для запуска только по вторникам.

Return Value

$this

$this wednesdays()

Настройте событие для запуска только по средам.

Return Value

$this

$this thursdays()

Настройте событие для запуска только по четвергам.

Return Value

$this

$this fridays()

Настройте событие для запуска только по пятницам.

Значение возврата

$this

$this saturdays()

Настройте событие для запуска только по субботам.

Значение возврата

$this

$this sundays()

Настройте событие для запуска только по воскресеньям.

Значение возврата

$this

$this weekly()

Настройте событие для еженедельного запуска.

Значение возврата

$this

$this weeklyOn(array|mixed $dayOfWeek, string $time = '0:0')

Настройте событие для еженедельного запуска в определенный день и время.

Параметры

array|mixed $dayOfWeek
string $time

Значение возврата

$this

$this monthly()

Настройте событие для ежемесячного запуска.

Значение возврата

$this

$this monthlyOn(int $dayOfMonth = 1, string $time = '0:0')

Настройте событие для ежемесячного выполнения в заданный день и время.

Параметры

int $dayOfMonth
string $time

Возвращаемое значение

$this

$this twiceMonthly(int $first = 1, int $second = 16, string $time = '0:0')

Настройте событие для двукратного ежемесячного выполнения в заданное время.

Параметры

int $first
int $second
string $time

Возвращаемое значение

$this

$this lastDayOfMonth(string $time = '0:0')

Настройте событие для выполнения в последний день месяца.

Параметры

string $time

Возвращаемое значение

$this

$this quarterly()

Настройте событие для выполнения ежеквартально.

Возвращаемое значение

$this

$this quarterlyOn(int $dayOfQuarter = 1, string $time = '0:0')

Настройте событие для ежеквартального выполнения в заданный день и время.

Параметры

int $dayOfQuarter
string $time

Возвращаемое значение

$this

$this yearly()

Настроить событие на ежегодное выполнение.

Возвращаемое значение

$this

$this yearlyOn(int $month = 1, int|string $dayOfMonth = 1, string $time = '0:0')

Настроить событие на ежегодное выполнение в заданный месяц, день и время.

Параметры

int $month
int|string $dayOfMonth
string $time

Возвращаемое значение

$this

$this days(array|mixed $days)

Установить дни недели, в которые должна выполняться команда.

Параметры

array|mixed $days

Возвращаемое значение

$this

$this timezone(DateTimeZone|string $timezone)

Установить часовой пояс, в котором следует оценивать дату.

Параметры

DateTimeZone|string $timezone

Возвращаемое значение

$this

protected $this spliceIntoPosition(int $position, string $value)

Вставить заданное значение в заданную позицию выражения.

Параметры

int $position
string $value

Возвращаемое значение

$this

protected string firstClosureParameterType(Closure $closure)

Получить имя класса первого параметра данного замыкания.

Параметры

Closure $closure

Значение возврата

string

Исключения

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

Получить имена классов первого параметра данного замыкания, включая объединённые типы.

Параметры

Closure $closure

Значение возврата

array

Исключения

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

Получить имена/типы параметров заданного замыкания.

Параметры

Closure $closure

Возвращаемое значение

array

Исключения

ReflectionException

tap($callback = null)

Вызвать заданное замыкание с этим экземпляром, затем вернуть экземпляр.

Параметры

$callback

void __construct(EventMutex $mutex, string|callable $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

Создать новый экземпляр события.

Параметры

EventMutex $mutex
string|callable $callback
array $parameters
DateTimeZone|string|null $timezone

Возвращаемое значение

void

Исключения

InvalidArgumentException

string getDefaultOutput()

Получить значение по умолчанию для вывода в зависимости от ОС.

Значение возврата

string

void run(Container $container)

Выполнить обработку события.

Параметры

Container $container

Значение возврата

void

Исключения

Throwable

bool shouldSkipDueToOverlapping()

Определить, следует ли пропустить событие из-за перекрытия другим процессом.

Значение возврата

bool

bool isRepeatable()

Определить, настроено ли событие на повторение несколько раз в минуту.

Значение возврата

bool

bool shouldRepeatNow()

Определить, готово ли событие к повторению.

Значение возврата

bool

protected int start(Container $container)

Запустить процесс команды.

Параметры

Container $container

Возвращаемое значение

int

Исключения

Throwable

protected int execute(Container $container)

Выполнить обратный вызов.

Параметры

Container $container

Возвращаемое значение

int

void finish(Container $container, int $exitCode)

Отметить процесс команды как завершенный и выполнить обратные вызовы/очистку.

Параметры

Container $container
int $exitCode

Возвращаемое значение

void

void callBeforeCallbacks(Container $container)

Вызвать все обратные вызовы "before" для события.

Параметры

Container $container

Возвращаемое значение

void

void callAfterCallbacks(Container $container)

Вызвать все обратные вызовы "after" для события.

Параметры

Container $container

Возвращаемое значение

void

string buildCommand()

Сформировать строку команды.

Возвращаемое значение

string

bool isDue(Application $app)

Определить, должно ли данное событие выполняться на основе выражения Cron.

Параметры

Application $app

Возвращаемое значение

bool

bool runsInMaintenanceMode()

Определить, выполняется ли событие в режиме технического обслуживания.

Возвращаемое значение

bool

protected bool expressionPasses()

Определить, проходит ли выражение Cron.

Возвращаемое значение

bool

bool runsInEnvironment(string $environment)

Определить, выполняется ли событие в данном окружении.

Параметры

string $environment

Возвращаемое значение

bool

bool filtersPass(Application $app)

Определить, проходят ли фильтры для события.

Параметры

Application $app

Возвращаемое значение

bool

$this storeOutput()

Обеспечить, что вывод сохраняется на диске в файле журнала.

Возвращаемое значение

$this

$this sendOutputTo(string $location, bool $append = false)

Отправить вывод команды в указанное местоположение.

Параметры

string $location
bool $append

Возвращаемое значение

$this

$this appendOutputTo(string $location)

Добавить вывод команды в заданное местоположение.

Параметры

string $location

Значение возврата

$this

$this emailOutputTo(array|mixed $addresses, bool $onlyIfOutputExists = false)

Отправить электронное письмо с результатами запланированной операции.

Параметры

array|mixed $addresses
bool $onlyIfOutputExists

Значение возврата

$this

Исключения

LogicException

$this emailWrittenOutputTo(array|mixed $addresses)

Отправить электронное письмо с результатами запланированной операции, если она произвела вывод.

Параметры

array|mixed $addresses

Значение возврата

$this

Исключения

LogicException

$this emailOutputOnFailure(array|mixed $addresses)

Отправить электронное письмо с результатами запланированной операции, если она завершилась неудачей.

Параметры

array|mixed $addresses

Значение возврата

$this

protected void ensureOutputIsBeingCaptured()

Обеспечить, что вывод команды захватывается.

Значение возврата

void

protected void emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false)

Отправить электронное письмо с выводом события получателям.

Параметры

Mailer $mailer
array $addresses
bool $onlyIfOutputExists

Значение возврата

void

protected string getEmailSubject()

Получить тему электронного письма для результатов вывода.

Значение возврата

string

$this pingBefore(string $url)

Зарегистрировать обратный вызов для проверки заданного URL-адреса перед запуском задачи.

Параметры

string $url

Значение возврата

$this

$this pingBeforeIf(bool $value, string $url)

Зарегистрировать обратный вызов для проверки заданного URL-адреса перед запуском задачи, если указанное условие истинно.

Параметры

bool $value
string $url

Значение возврата

$this

$this thenPing(string $url)

Зарегистрировать обратный вызов для отправки запроса ping на указанный URL после выполнения задачи.

Параметры

string $url

Возвращаемое значение

$this

$this thenPingIf(bool $value, string $url)

Зарегистрировать обратный вызов для отправки запроса ping на указанный URL после выполнения задачи, если заданное условие истинно.

Параметры

bool $value
string $url

Возвращаемое значение

$this

$this pingOnSuccess(string $url)

Зарегистрировать обратный вызов для отправки запроса ping на указанный URL, если операция выполнена успешно.

Параметры

string $url

Возвращаемое значение

$this

$this pingOnFailure(string $url)

Зарегистрировать обратный вызов для отправки запроса ping на указанный URL, если операция завершилась неудачно.

Параметры

string $url

Возвращаемое значение

$this

protected Closure pingCallback(string $url)

Получить обратный вызов для отправки запроса ping на указанный URL.

Параметры

string $url

Возвращаемое значение

Closure

protected ClientInterface getHttpClient(Container $container)

Получить Guzzle HTTP-клиент для отправки пингов.

Параметры

Container $container

Возвращаемое значение

ClientInterface

$this runInBackground()

Указать, что обратный вызов должен выполняться в фоновом режиме.

Возвращаемое значение

$this

Исключения

RuntimeException

$this user(string $user)

Указать пользователя, от имени которого должна выполняться команда.

Параметры

string $user

Возвращаемое значение

$this

$this environments(array|mixed $environments)

Ограничить среды, в которых должна выполняться команда.

Параметры

array|mixed $environments

Возвращаемое значение

$this

$this evenInMaintenanceMode()

Указать, что команда должна выполняться даже в режиме технического обслуживания.

Возвращаемое значение

$this

$this withoutOverlapping(int $expiresAt = 1440)

Не допускайте перекрытия событий.

Время истечения блокировки кэша по умолчанию может быть указано в минутах.

Параметры

int $expiresAt

Возвращаемое значение

$this

Исключения

LogicException

$this onOneServer()

Разрешить выполнение события только на одном сервере для каждого выражения cron.

Возвращаемое значение

$this

Исключения

LogicException

$this when(Closure|bool $callback)

Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.

Параметры

Closure|bool $callback

Возвращаемое значение

$this

$this skip(Closure|bool $callback)

Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.

Параметры

Closure|bool $callback

Возвращаемое значение

$this

$this before(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван перед операцией.

Параметры

Closure $callback

Возвращаемое значение

$this

$this after(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван после выполнения операции.

Параметры

Closure $callback

Возвращаемое значение

$this

$this then(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван после выполнения операции.

Параметры

Closure $callback

Возвращаемое значение

$this

$this thenWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий результат выполнения задачи.

Параметры

Closure $callback
bool $onlyIfOutputExists

Возвращаемое значение

$this

$this onSuccess(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван, если операция выполнится успешно.

Параметры

Closure $callback

Возвращаемое значение

$this

$this onSuccessWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий вывод, если операция выполняется успешно.

Параметры

Closure $callback
bool $onlyIfOutputExists

Возвращаемое значение

$this

$this onFailure(Closure $callback)

Зарегистрировать обратный вызов, который будет вызван, если операция завершится с ошибкой.

Параметры

Closure $callback

Возвращаемое значение

$this

$this onFailureWithOutput(Closure $callback, bool $onlyIfOutputExists = false)

Зарегистрировать обратный вызов, использующий вывод, если операция завершится с ошибкой.

Параметры

Closure $callback
bool $onlyIfOutputExists

Возвращаемое значение

$this

protected Closure withOutputCallback(Closure $callback, bool $onlyIfOutputExists = false)

Получить обратный вызов, обеспечивающий вывод.

Параметры

Closure $callback
bool $onlyIfOutputExists

Возвращаемое значение

Closure

$this name(string $description)

Установить удобочитаемое описание события.

Параметры

string $description

Возвращаемое значение

$this

$this description(string $description)

Установить удобочитаемое описание события.

Параметры

string $description

Возвращаемое значение

$this

string getSummaryForDisplay()

Получить краткое описание события для отображения.

Возвращаемое значение

string

Carbon nextRunDate(DateTimeInterface|string $currentTime = 'now', int $nth = 0, bool $allowCurrentDate = false)

Определить следующую дату выполнения для события.

Параметры

DateTimeInterface|string $currentTime
int $nth
bool $allowCurrentDate

Возвращаемое значение

Carbon

string getExpression()

Получить выражение Cron для события.

Возвращаемое значение

string

$this preventOverlapsUsing(EventMutex $mutex)

Установить реализацию мьютекса события для использования.

Параметры

EventMutex $mutex

Возвращаемое значение

$this

string mutexName()

Получить имя мьютекса для запланированной команды.

Возвращаемое значение

string

$this createMutexNameUsing(Closure|string $mutexName)

Установить имя мьютекса или обратный вызов для разрешения имени.

Параметры

Closure|string $mutexName

Возвращаемое значение

$this

protected void removeMutex()

Очистить мьютекс для события.

Возвращаемое значение

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Console/Scheduling/CallbackEvent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API