Spec-Zone.ru › Laravel 9

CallbackEvent

class CallbackEvent extends Event (View source)

Свойства

Macroable
ManagesFrequencies
ReflectsClosures

Свойства

static protected array $macros

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

from Macroable
string|null $command

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

from Event
string $expression

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

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

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

из Event
int|null $exitCode

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

из 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)

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

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

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

from ManagesFrequencies
$this hourly()

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

from ManagesFrequencies
$this hourlyAt(array|int $offset)

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

from ManagesFrequencies
$this everyOddHour()

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

from ManagesFrequencies
$this everyTwoHours()

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

from ManagesFrequencies
$this everyThreeHours()

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

from ManagesFrequencies
$this everyFourHours()

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

from ManagesFrequencies
$this everySixHours()

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

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

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

from ManagesFrequencies
$this weekdays()

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

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

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

из ManagesFrequencies
$this monthly()

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

из 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, int $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
void __construct(EventMutex $mutex, string|callable $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

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

string getDefaultOutput()

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

из Event
void run(Container $container)

Выполнить событие-обработчик.

bool shouldSkipDueToOverlapping()

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

int start(Container $container)

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

из 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.

из 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)

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

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

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

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

from Event
$this pingOnSuccess(string $url)

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

from Event
$this pingOnFailure(string $url)

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

from Event
Closure pingCallback(string $url)

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

from Event
$this runInBackground()

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

$this user(string $user)

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

from Event
$this environments(array|mixed $environments)

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

from Event
$this evenInMaintenanceMode()

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

from Event
$this withoutOverlapping(int $expiresAt = 1440)

Запретить перекрытие событий.

$this onOneServer()

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

$this when(Closure|bool $callback)

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

from Event
$this skip(Closure|bool $callback)

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

from Event
$this before(Closure $callback)

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

from Event
$this after(Closure $callback)

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

from Event
$this then(Closure $callback)

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

from Event
$this 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
строка getSummaryForDisplay()

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

Carbon nextRunDate(DateTimeInterface|строка $currentTime = 'сейчас', целое число $nth = 0, логическое значение $allowCurrentDate = ложь)

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

из события
строка getExpression()

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

из события
$this preventOverlapsUsing(EventMutex $mutex)

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

из события
строка mutexName()

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

$this createMutexNameUsing(Closure|строка $mutexName)

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

из события
пусто removeMutex()

Очистить блокировку для события.

Подробности

static пусто macro(строка $name, объект|вызов $macro)

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

Параметры

строка $name
объект|вызов $macro

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

пусто

static пусто mixin(объект $mixin, логическое значение $replace = true)

Смешать другой объект в класс.

Параметры

объект $mixin
логическое значение $replace

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

пусто

Исключения

ReflectionException

static логическое значение hasMacro(строка $name)

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

Параметры

строка $name

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

логическое значение

static пусто flushMacros()

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

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

пусто

static смешанное значение __callStatic(строка $method, массив $parameters)

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

Параметры

строка $method
массив $parameters

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

смешанное значение

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

$this cron(string $expression)

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

Parameters

string $expression

Return Value

$this

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

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

Parameters

string $startTime
string $endTime

Return Value

$this

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

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

Parameters

string $startTime
string $endTime

Return Value

$this

$this everyMinute()

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

Return Value

$this

$this everyTwoMinutes()

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

Return Value

$this

$this everyThreeMinutes()

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

Return Value

$this

$this everyFourMinutes()

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

Return Value

$this

$this everyFiveMinutes()

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

Return Value

$this

$this everyTenMinutes()

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

Return Value

$this

$this everyFifteenMinutes()

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

Return Value

$this

$this everyThirtyMinutes()

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

Return Value

$this

$this hourly()

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

Return Value

$this

$this hourlyAt(array|int $offset)

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

Parameters

array|int $offset

Return Value

$this

$this everyOddHour()

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

Return Value

$this

$this everyTwoHours()

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

Return Value

$this

$this everyThreeHours()

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

Return Value

$this

$this everyFourHours()

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

Return Value

$this

$this everySixHours()

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

Return Value

$this

$this daily()

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

Return Value

$this

$this at(string $time)

Настройте команду на запуск в заданное время.

Parameters

string $time

Return Value

$this

$this dailyAt(string $time)

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

Parameters

string $time

Return Value

$this

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

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

Parameters

int $first
int $second

Return Value

$this

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

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

Parameters

int $first
int $second
int $offset

Return Value

$this

$this weekdays()

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

Return Value

$this

$this weekends()

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

Return Value

$this

$this mondays()

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

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

$this

$this tuesdays()

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

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

$this

$this wednesdays()

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

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

$this

$this thursdays()

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

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

$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, int $time = '0:0')

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

Параметры

int $dayOfQuarter
int $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

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

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)

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

Параметры

Container $container

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

void

void callAfterCallbacks(Container $container)

Вызвать все обратные вызовы «после» для события.

Параметры

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)

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

Параметры

string $url

Значение, возвращаемое функцией

$this

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

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

Параметры

bool $value
string $url

Значение, возвращаемое функцией

$this

$this pingOnSuccess(string $url)

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

Параметры

string $url

Значение, возвращаемое функцией

$this

$this pingOnFailure(string $url)

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

Параметры

string $url

Значение, возвращаемое функцией

$this

protected Closure pingCallback(string $url)

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

Параметры

string $url

Значение, возвращаемое функцией

Closure

$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/9.x/Illuminate/Console/Scheduling/CallbackEvent.html

Spec-Zone.ru

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