Spec-Zone.ru › Laravel 9

Событие

класс Событие (Просмотреть исходный код)

Трейты

Macroable
ManagesFrequencies
ReflectsClosures

Свойства

статический защищенный массив $macros

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

из Macroable
строка|null $command

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

строка $expression

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

DateTimeZone|строка $timezone

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

строка|null $user

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

массив $environments

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

логическое $evenInMaintenanceMode

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

логическое $withoutOverlapping

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

логическое $onOneServer

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

целое число $expiresAt

Количество минут, в течение которых должна быть действительной блокировка mutex.

логическое $runInBackground

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

защищенный массив $filters

Массив колбеков фильтров.

защищенный массив $rejects

Массив колбеков отклонения.

строка $output

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

логическое $shouldAppendOutput

Указывает, должен ли вывод добавляться.

защищенный массив $beforeCallbacks

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

защищенный массив $afterCallbacks

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

строка|null $description

Описание события, понятное пользователю.

EventMutex $mutex

Реализация блокировки mutex события.

Closure|null $mutexNameResolver

Колбек-функция для разрешения имени блокировки mutex.

целое число|null $exitCode

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

Методы

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

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

from 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 $command, DateTimeZone|string|null $timezone = null)

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

string getDefaultOutput()

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

void run(Container $container)

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

bool shouldSkipDueToOverlapping()

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

int start(Container $container)

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

int execute(Container $container)

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

void finish(Container $container, int $exitCode)

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

void callBeforeCallbacks(Container $container)

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

void callAfterCallbacks(Container $container)

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

string buildCommand()

Создать строку команды.

bool isDue(Application $app)

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

bool runsInMaintenanceMode()

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

bool expressionPasses()

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

bool runsInEnvironment(string $environment)

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

bool filtersPass(Application $app)

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

$this storeOutput()

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

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

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

$this appendOutputTo(string $location)

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

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

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

$this emailWrittenOutputTo(array|mixed $addresses)

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

$this emailOutputOnFailure(array|mixed $addresses)

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

void ensureOutputIsBeingCaptured()

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

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

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

string getEmailSubject()

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

$this pingBefore(string $url)

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

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

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

$this thenPing(string $url)

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

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

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

$this pingOnSuccess(string $url)

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

$this pingOnFailure(string $url)

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

Closure pingCallback(string $url)

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

$this runInBackground()

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

$this user(string $user)

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

$this environments(array|mixed $environments)

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

$this evenInMaintenanceMode()

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

$this withoutOverlapping(int $expiresAt = 1440)

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

$this onOneServer()

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

$this when(Closure|bool $callback)

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

$this skip(Closure|bool $callback)

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

$this before(Closure $callback)

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

$this after(Closure $callback)

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

$this then(Closure $callback)

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

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

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

$this onSuccess(Closure $callback)

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

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

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

$this onFailure(Closure $callback)

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

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

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

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

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

$this name(string $description)

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

$this description(string $description)

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

строка getSummaryForDisplay()

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

Carbon nextRunDate(DateTimeInterface|строка $currentTime = 'now', целое $nth = 0, булево $allowCurrentDate = false)

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

строка getExpression()

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

$this preventOverlapsUsing(EventMutex $mutex)

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

строка mutexName()

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

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

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

void removeMutex()

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

Подробности

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

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

Параметры

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

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

void

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

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

Параметры

объект $mixin
булево $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

строка $name

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

bool

static void flushMacros()

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

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

void

static смешанный __callStatic(string $method, array $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

смешанный __call(string $method, array $parameters)

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

Параметры

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

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

смешанный

Исключения

BadMethodCallException

$this cron(string $expression)

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

Параметры

строка $expression

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

$this

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

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

Параметры

строка $startTime
строка $endTime

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

$this

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

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

Параметры

строка $startTime
строка $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)

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

Параметры

массив|целое $offset

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

$this

$this everyOddHour()

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

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

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

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

string

Исключения

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

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

Параметры

Closure $closure

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

array

Исключения

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

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

Параметры

Closure $closure

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

array

Исключения

ReflectionException

void __construct(EventMutex $mutex, string $command, DateTimeZone|string|null $timezone = null)

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

Параметры

EventMutex $mutex
string $command
DateTimeZone|string|null $timezone

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

void

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)

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

Зарегистрировать обратный вызов для отправки запроса на заданный 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

$this onOneServer()

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

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

$this

$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/Event.html

Spec-Zone.ru

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