Spec-Zone.ru › Laravel 8

CallbackEvent

класс CallbackEvent расширяет 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 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()

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

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

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

из ManagesFrequencies
$this weekdays()

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

из ManagesFrequencies
$this weekends()

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

из ManagesFrequencies
$this mondays()

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

from ManagesFrequencies
$this tuesdays()

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

from ManagesFrequencies
$this wednesdays()

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

from ManagesFrequencies
$this thursdays()

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

from ManagesFrequencies
$this fridays()

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

from ManagesFrequencies
$this saturdays()

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

from ManagesFrequencies
$this sundays()

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

from ManagesFrequencies
$this weekly()

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

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

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

from ManagesFrequencies
$this monthly()

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

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

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

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

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

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

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

from ManagesFrequencies
$this quarterly()

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

from ManagesFrequencies
$this yearly()

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

from 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 $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

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

string getDefaultOutput()

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

из Event
void run(Container $container)

Запустить данное событие.

string mutexName()

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

void runCommandInForeground(Container $container)

Запустить команду в фоновом режиме.

из Event
void runCommandInBackground(Container $container)

Запустить команду в фоновом режиме.

из Event
void callBeforeCallbacks(Container $container)

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

из Event
void callAfterCallbacks(Container $container)

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

из Event
void callAfterCallbacksWithExitCode(Container $container, int $exitCode)

Вызвать все обратные вызовы "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)

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

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

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

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 = 'now', int $nth = 0, bool $allowCurrentDate = false)

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

из Event
строка getExpression()

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

из Event
$this preventOverlapsUsing(EventMutex $mutex)

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

из Event
void removeMutex()

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

Подробности

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

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

Параметры

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

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

void

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

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

Параметры

объект $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

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

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

строка $method
массив $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 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|int $offset)

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

Параметры

array|int $offset

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

$this

$this everyTwoHours()

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

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

$this

$this everyThreeHours()

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

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

$this

$this everyFourHours()

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

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

$this

$this everySixHours()

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

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

$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

$this weekdays()

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

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

$this

$this weekends()

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

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

$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 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 $callback, array $parameters = [], DateTimeZone|string|null $timezone = null)

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

Параметры

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

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

void

Исключения

InvalidArgumentException

string getDefaultOutput()

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

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

string

void run(Container $container)

Выполнить данное событие.

Параметры

Container $container

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

void

Исключения

Exception

string mutexName()

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

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

string

protected void runCommandInForeground(Container $container)

Выполнить команду в фоновом режиме.

Параметры

Container $container

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

void

protected void runCommandInBackground(Container $container)

Выполнить команду в фоновом режиме.

Параметры

Container $container

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

void

void callBeforeCallbacks(Container $container)

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

Параметры

Container $container

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

void

void callAfterCallbacks(Container $container)

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

Параметры

Container $container

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

void

void callAfterCallbacksWithExitCode(Container $container, int $exitCode)

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

Параметры

Container $container
int $exitCode

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

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

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

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

Parameters

Closure $callback

Return Value

$this

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

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

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

$this

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

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

Parameters

Closure $callback
bool $onlyIfOutputExists

Return Value

Closure

$this name(string $description)

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

Parameters

string $description

Return Value

$this

$this description(string $description)

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

Parameters

string $description

Return Value

$this

string getSummaryForDisplay()

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

Return Value

string

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

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

Parameters

DateTimeInterface|string $currentTime
int $nth
bool $allowCurrentDate

Return Value

Carbon

string getExpression()

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

Return Value

string

$this preventOverlapsUsing(EventMutex $mutex)

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

Parameters

EventMutex $mutex

Return Value

$this

protected void removeMutex()

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

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

void

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

Spec-Zone.ru

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