Spec-Zone.ru › Laravel 8

Событие

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

Трейты

Macroable
ManagesFrequencies
ReflectsClosures

Свойства

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

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

из Macroable
строка $command

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

строка $expression

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

DateTimeZone|строка $timezone

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

строка $user

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

массив $environments

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

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

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

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

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

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

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

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

Время действия мьютекса.

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

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

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

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

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

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

строка $output

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

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

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

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

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

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

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

строка $description

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

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

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

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

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

из ReflectsClosures
array firstClosureParameterTypes(Closure $closure)

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

из ReflectsClosures
array closureParameterTypes(Closure $closure)

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

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

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

string getDefaultOutput()

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

void run(Container $container)

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

string mutexName()

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

void runCommandInForeground(Container $container)

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

void runCommandInBackground(Container $container)

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

void callBeforeCallbacks(Container $container)

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

void callAfterCallbacks(Container $container)

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

void callAfterCallbacksWithExitCode(Container $container, int $exitCode)

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

string buildCommand()

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

bool isDue(Application $app)

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

bool runsInMaintenanceMode()

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

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)

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

string getSummaryForDisplay()

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

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

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

string getExpression()

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

$this preventOverlapsUsing(EventMutex $mutex)

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

void removeMutex()

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

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

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

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

$this cron(string $expression)

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

Параметры

string $expression

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

$this

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

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

Параметры

string $startTime
string $endTime

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

$this

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

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

Параметры

string $startTime
string $endTime

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

$this

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

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)

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

Parameters

string $environment

Return Value

bool

bool filtersPass(Application $app)

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

Parameters

Application $app

Return Value

bool

$this storeOutput()

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

Return Value

$this

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

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

Parameters

string $location
bool $append

Return Value

$this

$this appendOutputTo(string $location)

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

Parameters

string $location

Return Value

$this

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

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

Parameters

array|mixed $addresses
bool $onlyIfOutputExists

Return Value

$this

Exceptions

LogicException

$this emailWrittenOutputTo(array|mixed $addresses)

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

Parameters

array|mixed $addresses

Return Value

$this

Exceptions

LogicException

$this emailOutputOnFailure(array|mixed $addresses)

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

Parameters

array|mixed $addresses

Return Value

$this

protected void ensureOutputIsBeingCaptured()

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

Return Value

void

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

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

Parameters

Mailer $mailer
array $addresses
bool $onlyIfOutputExists

Return Value

void

protected string getEmailSubject()

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

Return Value

string

$this pingBefore(string $url)

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

Parameters

string $url

Return Value

$this

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

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

Parameters

bool $value
string $url

Return Value

$this

$this thenPing(string $url)

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

Parameters

string $url

Return Value

$this

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

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

Parameters

bool $value
string $url

Return Value

$this

$this pingOnSuccess(string $url)

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

Parameters

string $url

Return Value

$this

$this pingOnFailure(string $url)

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

Parameters

string $url

Return Value

$this

protected Closure pingCallback(string $url)

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

Parameters

string $url

Return Value

Closure

$this runInBackground()

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

Return Value

$this

$this user(string $user)

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

Parameters

string $user

Return Value

$this

$this environments(array|mixed $environments)

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

Parameters

array|mixed $environments

Return Value

$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

строка getExpression()

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

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

строка

$this preventOverlapsUsing(EventMutex $mutex)

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

Параметры

EventMutex $mutex

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

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

Spec-Zone.ru

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