Событие

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

Трейты

Свойства

static protected массив	$macros	Зарегистрированные строковые макросы.	из Macroable
строка\|null	$command	Строка команды.
строка	$expression	Выражение cron, представляющее частоту события.
целое число\|null	$repeatSeconds	Частота повторения события в течение минуты.
DateTimeZone\|строка	$timezone	Временная зона, в которой должна оцениваться дата.
строка\|null	$user	Пользователь, от имени которого должна выполняться команда.
массив	$environments	Список сред, в которых должна выполняться команда.
булево	$evenInMaintenanceMode	Указывает, должна ли команда выполняться в режиме технического обслуживания.
булево	$withoutOverlapping	Указывает, должна ли команда не перекрываться.
булево	$onOneServer	Указывает, должна ли команда выполняться только на одном сервере для каждого выражения cron.
целое число	$expiresAt	Количество минут, в течение которого мьютекс должен быть действительным.
булево	$runInBackground	Указывает, должна ли команда выполняться в фоновом режиме.
protected массив	$filters	Массив колбэков-фильтров.
protected массив	$rejects	Массив колбэков-отклонений.
строка	$output	Расположение, куда должен направляться вывод.
булево	$shouldAppendOutput	Указывает, должен ли вывод добавляться в конец.
protected массив	$beforeCallbacks	Массив колбэков, которые должны выполняться перед началом события.
protected массив	$afterCallbacks	Массив колбэков, которые должны выполняться после завершения события.
строка\|null	$description	Человекопонятное описание события.
EventMutex	$mutex	Реализация мьютекса события.
Closure\|null	$mutexNameResolver	Колбэк для разрешения имени мьютекса.
protected Carbon\|null	$lastChecked	Последний момент времени, когда событие проверялось на возможность выполнения.
целое число\|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	everySecond() Запланировать событие для запуска каждую секунду.	from ManagesFrequencies
$this	everyTwoSeconds() Запланировать событие для запуска каждые две секунды.	from ManagesFrequencies
$this	everyFiveSeconds() Запланировать событие для запуска каждые пять секунд.	from ManagesFrequencies
$this	everyTenSeconds() Запланировать событие для запуска каждые десять секунд.	from ManagesFrequencies
$this	everyFifteenSeconds() Запланировать событие для запуска каждые пятнадцать секунд.	from ManagesFrequencies
$this	everyTwentySeconds() Запланировать событие для запуска каждые двадцать секунд.	from ManagesFrequencies
$this	everyThirtySeconds() Запланировать событие для запуска каждые тридцать секунд.	from ManagesFrequencies
$this	repeatEvery(int $seconds) Запланировать событие для запуска несколько раз в минуту.	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\|string\|int $offset) Запланировать событие для запуска каждый час с заданным смещением в часе.	from ManagesFrequencies
$this	everyOddHour(array\|string\|int $offset = 0) Запланировать событие для запуска каждый нечётный час.	from ManagesFrequencies
$this	everyTwoHours(array\|string\|int $offset = 0) Запланировать событие для запуска каждые два часа.	from ManagesFrequencies
$this	everyThreeHours(array\|string\|int $offset = 0) Запланировать событие для запуска каждые три часа.	from ManagesFrequencies
$this	everyFourHours(array\|string\|int $offset = 0) Запланировать событие для запуска каждые четыре часа.	from ManagesFrequencies

$this	everySixHours(array\|string\|int $offset = 0) Запланировать событие на выполнение каждые шесть часов.	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	hourBasedSchedule(array\|string\|int $minutes, array\|string\|int $hours) Запланировать событие на выполнение в указанные минуты и часы.	from ManagesFrequencies
$this	weekdays() Запланировать событие на выполнение только в будние дни.	from ManagesFrequencies
$this	weekends() Запланировать событие на выполнение только в выходные дни.	from 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	quarterlyOn(int $dayOfQuarter = 1, string $time = '0:0') Запланировать событие на ежеквартальное выполнение в заданный день и время.	from ManagesFrequencies
$this	yearly() Запланировать событие на ежегодное выполнение.	from ManagesFrequencies
$this	yearlyOn(int $month = 1, int\|string $dayOfMonth = 1, string $time = '0:0') Запланировать событие на ежегодное выполнение в заданный месяц, день и время.	from ManagesFrequencies
$this	days(array\|mixed $days) Установить дни недели, в которые должна выполняться команда.	from ManagesFrequencies
$this	timezone(DateTimeZone\|string $timezone) Установить часовой пояс, в котором должна оцениваться дата.	from ManagesFrequencies
$this	spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения.	from ManagesFrequencies
string	firstClosureParameterType(Closure $closure) Получить имя класса первого параметра данного Closure.	from ReflectsClosures

array	firstClosureParameterTypes(Closure $closure) Получить имена классов первого параметра заданного замыкания, включая типы объединения.	из ReflectsClosures
array	closureParameterTypes(Closure $closure) Получить имена/типы параметров заданного замыкания.	из ReflectsClosures
tap($callback = null) Вызвать заданное замыкание с этим экземпляром, затем вернуть экземпляр.	из Tappable
void	__construct(EventMutex $mutex, string $command, DateTimeZone\|string\|null $timezone = null) Создать новый экземпляр события.
string	getDefaultOutput() Получить стандартный вывод в зависимости от ОС.
void	run(Container $container) Запустить заданное событие.
bool	shouldSkipDueToOverlapping() Определить, должно ли событие пропустить выполнение из-за перекрытия.
bool	isRepeatable() Определить, настроено ли событие для многократного повторения в минуту.
bool	shouldRepeatNow() Определить, готово ли событие к повторению.
int	start(Container $container) Запустить процесс выполнения команды.
int	execute(Container $container) Запустить процесс выполнения команды.
void	finish(Container $container, int $exitCode) Отметить процесс выполнения команды как завершённый и выполнить обратные вызовы/очистку.
void	callBeforeCallbacks(Container $container) Вызвать все обратные вызовы "перед" событием.
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() Получить предмет e-mail для результатов вывода.
$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.
ClientInterface	getHttpClient(Container $container) Получить Guzzle HTTP-клиент для отправки запросов.
$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) Установить реализацию блокировки событий, которая будет использоваться.
string	mutexName() Получить имя блокировки для запланированной команды.
$this	createMutexNameUsing(Closure\|string $mutexName) Установить имя блокировки или обратный вызов для получения имени.
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

END_OF_DOCUMENT_MARKER

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

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

Параметры

string	$startTime
string	$endTime

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

$this

$this everySecond()

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

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

$this

$this everyTwoSeconds()

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

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

$this

$this everyFiveSeconds()

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

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

$this

$this everyTenSeconds()

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

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

$this

$this everyFifteenSeconds()

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

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

$this

$this everyTwentySeconds()

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

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

$this

$this everyThirtySeconds()

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

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

$this

protected $this repeatEvery(int $seconds)

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

Параметры

int

$seconds

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

$this

$this everyMinute()

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

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

$this

$this everyTwoMinutes()

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

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

$this

$this everyThreeMinutes()

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

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

$this

$this everyFourMinutes()

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

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

$this

$this everyFiveMinutes()

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

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

$this

$this everyTenMinutes()

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

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

$this

$this everyFifteenMinutes()

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

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

$this

$this everyThirtyMinutes()

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

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

$this

$this hourly()

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

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

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

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

Параметры

array|string|int

$offset

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

$this

$this daily()

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

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

$this

$this at(string $time)

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

Параметры

string

$time

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

$this

$this dailyAt(string $time)

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

Параметры

string

$time

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

$this

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

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

Параметры

int	$first
int	$second

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

$this

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

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

Параметры

int	$first
int	$second
int	$offset

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

$this

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

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

Параметры

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

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

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

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

Параметры

int	$dayOfQuarter
string	$time

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

$this

$this yearly()

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

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

$this

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

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

Параметры

int	$month
int\|string	$dayOfMonth
string	$time

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

$this

$this days(array|mixed $days)

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

Параметры

array|mixed

$days

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

$this

$this timezone(DateTimeZone|string $timezone)

Установить часовой пояс для оценки даты.

Параметры

DateTimeZone|string

$timezone

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

$this

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

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

Параметры

int	$position
string	$value

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

$this

protected string firstClosureParameterType(Closure $closure)

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

Параметры

Closure

$closure

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

string

Исключения

ReflectionException
RuntimeException

protected array firstClosureParameterTypes(Closure $closure)

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

Параметры

Closure

$closure

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

array

Исключения

ReflectionException
RuntimeException

protected array closureParameterTypes(Closure $closure)

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

Параметры

Closure

$closure

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

array

Исключения

ReflectionException

tap($callback = null)

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

Параметры

$callback

void __construct(EventMutex $mutex, string $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

bool isRepeatable()

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

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

bool

bool shouldRepeatNow()

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

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

bool

protected int start(Container $container)

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

Параметры

Container

$container

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

int

Исключения

Throwable

protected int execute(Container $container)

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

Параметры

Container

$container

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

int

void finish(Container $container, int $exitCode)

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

Параметры

Container	$container
int	$exitCode

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

void

void callBeforeCallbacks(Container $container)

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

Параметры

Container

$container

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

void

void callAfterCallbacks(Container $container)

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

Параметры

Container

$container

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

void

string buildCommand()

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

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

string

bool isDue(Application $app)

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

Параметры

Application

$app

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

bool

bool runsInMaintenanceMode()

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

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

bool

protected bool expressionPasses()

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

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

bool

bool runsInEnvironment(string $environment)

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

Параметры

string

$environment

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

bool

bool filtersPass(Application $app)

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

Параметры

Application

$app

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

bool

$this storeOutput()

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

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

$this

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

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

Параметры

string	$location
bool	$append

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

$this

$this appendOutputTo(string $location)

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

Параметры

string

$location

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

$this

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

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

Параметры

array\|mixed	$addresses
bool	$onlyIfOutputExists

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

$this

Исключения

LogicException

$this emailWrittenOutputTo(array|mixed $addresses)

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

Параметры

array|mixed

$addresses

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

$this

Исключения

LogicException

$this emailOutputOnFailure(array|mixed $addresses)

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

Параметры

array|mixed

$addresses

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

$this

protected void ensureOutputIsBeingCaptured()

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

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

void

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

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

Параметры

Mailer	$mailer
array	$addresses
bool	$onlyIfOutputExists

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

void

protected string getEmailSubject()

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

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

string

$this pingBefore(string $url)

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

Параметры

string

$url

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

$this

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

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

Параметры

bool	$value
string	$url

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

$this

$this thenPing(string $url)

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

Parameters

string

$url

Return Value

Closure

protected ClientInterface getHttpClient(Container $container)

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

Parameters

Container

$container

Return Value

ClientInterface

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

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

Return Value

$this

$this withoutOverlapping(int $expiresAt = 1440)

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

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

Parameters

int

$expiresAt

Return Value

$this

$this onOneServer()

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

Return Value

$this

$this when(Closure|bool $callback)

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

Parameters

Closure|bool

$callback

Return Value

$this

$this skip(Closure|bool $callback)

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

Parameters

Closure|bool

$callback

Return Value

$this

$this before(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

$this after(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

$this then(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

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

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

Parameters

Closure	$callback
bool	$onlyIfOutputExists

Return Value

$this

$this onSuccess(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

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

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

Parameters

Closure	$callback
bool	$onlyIfOutputExists

Return Value

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

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

Параметры

Closure	$callback
bool	$onlyIfOutputExists

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

Closure

$this name(string $description)

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

Параметры

string

$description

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

$this

$this description(string $description)

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

Параметры

string

$description

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

$this

string getSummaryForDisplay()

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

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

string

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

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

Параметры

DateTimeInterface\|string	$currentTime
int	$nth
bool	$allowCurrentDate

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

Carbon

string getExpression()

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

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

string

$this preventOverlapsUsing(EventMutex $mutex)

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

Параметры

EventMutex

$mutex

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

$this

string mutexName()

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

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

string

$this createMutexNameUsing(Closure|string $mutexName)

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

Параметры

Closure|string

$mutexName

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

$this

protected void removeMutex()

Удалить блокировку для события.

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

void

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