Событие

класс Event (Просмотр исходного кода)

Свойства

строка	$command	Строка команды.
строка	$expression	Выражение cron, представляющее частоту события.
DateTimeZone\|строка	$timezone	Часовой пояс, в котором следует оценивать дату.
строка	$user	Пользователь, от имени которого должна выполняться команда.
массив	$environments	Список сред, в которых должна выполняться команда.
логическое значение	$evenInMaintenanceMode	Указывает, должна ли команда выполняться в режиме технического обслуживания.
логическое значение	$withoutOverlapping	Указывает, должна ли команда не перекрывать себя.
логическое значение	$runInBackground	Указывает, должна ли команда выполняться в фоновом режиме.
защищённый массив	$filters	Массив колбэков фильтра.
защищённый массив	$rejects	Массив колбэков отклонения.
строка	$output	Расположение, куда следует отправлять вывод.
защищённое логическое значение	$shouldAppendOutput	Указывает, должен ли вывод добавляться.
защищённый массив	$beforeCallbacks	Массив колбэков, которые должны выполняться перед запуском события.
защищённый массив	$afterCallbacks	Массив колбэков, которые должны выполняться после завершения события.
строка	$description	Описание события для удобства чтения.

Методы

void	__construct(string $command) Создать новый экземпляр события.
string	getDefaultOutput() Получить стандартный вывод в зависимости от ОС.
void	run(Container $container) Запустить заданное событие.
void	runCommandInForeground(Container $container) Запустить команду в фоновом режиме.
void	runCommandInBackground() Запустить команду в фоновом режиме.
void	callBeforeCallbacks(Container $container) Вызвать все коллбэки "before" для события.
void	callAfterCallbacks(Container $container) Вызвать все коллбэки "after" для события.
string	buildCommand() Сформировать строку команды.
string	mutexPath() Получить путь к мьютексу для запланированной команды.
bool	isDue(Application $app) Определить, следует ли запускать данное событие на основе выражения Cron.
bool	expressionPasses() Определить, проходит ли выражение Cron.
bool	filtersPass(Application $app) Определить, проходят ли фильтры для события.
bool	runsInEnvironment(string $environment) Определить, запускается ли событие в данной среде.
bool	runsInMaintenanceMode() Определить, запускается ли событие в режиме обслуживания.
$this	cron(string $expression) Выражение Cron, представляющее частоту события.
$this	hourly() Запланировать выполнение события каждый час.
$this	hourlyAt(int $offset) Запланировать выполнение события каждый час с заданным смещением.
$this	daily() Запланировать выполнение события ежедневно.
$this	at(string $time) Запланировать команду на заданное время.
$this	dailyAt(string $time) Запланировать выполнение события ежедневно в заданное время (10:00, 19:30 и т.д.).
$this	twiceDaily(int $first = 1, int $second = 13) Запланировать выполнение события дважды в день.
$this	weekdays() Запланировать выполнение события только по будням.
$this	mondays() Запланировать выполнение события только по понедельникам.
$this	tuesdays() Запланировать выполнение события только по вторникам.
$this	wednesdays() Запланировать выполнение события только по средам.
$this	thursdays() Запланировать выполнение события только по четвергам.
$this	fridays() Запланировать выполнение события только по пятницам.
$this	saturdays() Запланировать выполнение события только по субботам.
$this	sundays() Запланировать выполнение события только по воскресеньям.
$this	weekly() Запланировать выполнение события еженедельно.
$this	weeklyOn(int $day, string $time = '0:0') Запланировать выполнение события еженедельно в заданный день и время.
$this	monthly() Запланировать выполнение события ежемесячно.
$this	monthlyOn(int $day = 1, string $time = '0:0') Запланировать выполнение события ежемесячно в заданный день и время.
$this	quarterly() Запланировать выполнение события ежеквартально.
$this	yearly() Запланировать выполнение события ежегодно.
$this	everyMinute() Запланировать выполнение события каждую минуту.
$this	everyFiveMinutes() Запланировать выполнение события каждые пять минут.
$this	everyTenMinutes() Запланировать выполнение события каждые десять минут.
$this	everyThirtyMinutes() Запланировать выполнение события каждые тридцать минут.
$this	days(array\|mixed $days) Установить дни недели, в которые должна выполняться команда.
$this	between(string $startTime, string $endTime) Запланировать выполнение события между начальным и конечным временем.
$this	unlessBetween(string $startTime, string $endTime) Запланировать, чтобы событие не запускалось между начальным и конечным временем.
$this	runInBackground() Указать, что команда должна выполняться в фоновом режиме.
$this	timezone(DateTimeZone\|string $timezone) Установить часовой пояс, в котором должна оцениваться дата.
$this	user(string $user) Установить пользователя, от имени которого должна выполняться команда.
$this	environments(array\|mixed $environments) Ограничить среды, в которых должна выполняться команда.
$this	evenInMaintenanceMode() Указать, что команда должна выполняться даже в режиме обслуживания.
$this	withoutOverlapping() Не допускать перекрытия событий друг другом.

$this	when(Closure $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.
$this	skip(Closure $callback) Зарегистрировать обратный вызов для дальнейшей фильтрации расписания.
$this	sendOutputTo(string $location, bool $append = false) Отправить вывод команды в заданное местоположение.
$this	appendOutputTo(string $location) Добавить вывод команды в заданное местоположение.
$this	emailOutputTo(array\|mixed $addresses, bool $onlyIfOutputExists = false) Отправить электронное письмо с результатами запланированной операции.
$this	emailWrittenOutputTo(array\|mixed $addresses) Отправить электронное письмо с результатами запланированной операции, если она создаёт вывод.
void	emailOutput(Mailer $mailer, array $addresses, bool $onlyIfOutputExists = false) Отправить электронное письмо с выводом события получателям.
string	getEmailSubject() Получить тему электронного письма для результатов вывода.
$this	pingBefore(string $url) Зарегистрировать обратный вызов для отправки запроса ping на заданный URL перед запуском задачи.
$this	before(Closure $callback) Зарегистрировать обратный вызов, который будет вызван перед операцией.
$this	thenPing(string $url) Зарегистрировать обратный вызов для отправки запроса ping на заданный URL после запуска задачи.
$this	after(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции.
$this	then(Closure $callback) Зарегистрировать обратный вызов, который будет вызван после операции.
$this	name(string $description) Установить удобочитаемое описание события.
$this	description(string $description) Установить удобочитаемое описание события.
$this	spliceIntoPosition(int $position, string $value) Вставить заданное значение в заданную позицию выражения.
string	getSummaryForDisplay() Получить сводку события для отображения.
string	getExpression() Получить выражение Cron для события.

Подробности

void __construct(string $command)

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

Parameters

string

$command

Return Value

void

protected string getDefaultOutput()

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

Return Value

string

void run(Container $container)

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

Parameters

Container

$container

Return Value

void

protected void runCommandInForeground(Container $container)

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

Parameters

Container

$container

Return Value

void

protected void runCommandInBackground()

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

Return Value

void

protected void callBeforeCallbacks(Container $container)

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

Parameters

Container

$container

Return Value

void

protected void callAfterCallbacks(Container $container)

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

Parameters

Container

$container

Return Value

void

string buildCommand()

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

Return Value

string

protected string mutexPath()

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

Return Value

string

bool isDue(Application $app)

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

Parameters

Application

$app

Return Value

bool

protected bool expressionPasses()

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

Return Value

bool

bool filtersPass(Application $app)

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

Parameters

Application

$app

Return Value

bool

bool runsInEnvironment(string $environment)

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

Параметры

string

$environment

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

bool

bool runsInMaintenanceMode()

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

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

bool

$this cron(string $expression)

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

Параметры

string

$expression

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

$this

$this hourly()

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

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

$this

$this hourlyAt(int $offset)

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

Параметры

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

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

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

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

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

Параметры

int	$day
string	$time

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

$this

$this monthly()

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

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

$this

$this monthlyOn(int $day = 1, string $time = '0:0')

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

Параметры

int	$day
string	$time

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

$this

$this quarterly()

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

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

$this

$this yearly()

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

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

$this

$this everyMinute()

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

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

$this

$this everyFiveMinutes()

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

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

$this

$this everyTenMinutes()

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

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

$this

$this everyThirtyMinutes()

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

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

$this

$this days(array|mixed $days)

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

Параметры

array|mixed

$days

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

$this

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

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

Параметры

string	$startTime
string	$endTime

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

$this

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

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

Параметры

string	$startTime
string	$endTime

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

$this

$this runInBackground()

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

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

$this

$this timezone(DateTimeZone|string $timezone)

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

Параметры

DateTimeZone|string

$timezone

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

$this

$this user(string $user)

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

Параметры

string

$user

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

$this

$this environments(array|mixed $environments)

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

Параметры

array|mixed

$environments

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

$this

$this evenInMaintenanceMode()

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

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

$this

$this withoutOverlapping()

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

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

$this

$this when(Closure $callback)

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

Параметры

Closure

$callback

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

$this

$this skip(Closure $callback)

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

Параметры

Closure

$callback

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

$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

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 before(Closure $callback)

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

Параметры

Closure

$callback

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

$this

$this thenPing(string $url)

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

Параметры

string

$url

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

$this

$this after(Closure $callback)

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

Параметры

Closure

$callback

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

$this

$this then(Closure $callback)

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

Параметры

Closure

$callback

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

$this

$this name(string $description)

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

Параметры

string

$description

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

$this

$this description(string $description)

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

Параметры

string

$description

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

$this

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

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

Параметры

int	$position
string	$value

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

$this

string getSummaryForDisplay()

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

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

string

string getExpression()

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

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

string

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