CallbackEvent

class CallbackEvent extends Event (View source)

Свойства

string	$command	Строка команды.	from Event
string	$expression	Выражение cron, определяющее частоту события.	from Event
DateTimeZone\|string	$timezone	Часовой пояс, в котором следует оценивать дату.	from Event
string	$user	Пользователь, от имени которого должна выполняться команда.	from Event
array	$environments	Список сред, в которых должна выполняться команда.	from Event
bool	$evenInMaintenanceMode	Указывает, должна ли команда выполняться в режиме технического обслуживания.	from Event
bool	$withoutOverlapping	Указывает, должна ли команда не перекрывать себя.	from Event
protected Closure	$filter	Обратный вызов фильтра.	from Event
protected Closure	$reject	Обратный вызов отклонения.	from Event
string	$output	Расположение, куда следует отправлять вывод.	from Event
protected bool	$shouldAppendOutput	Указывает, следует ли добавлять вывод.	from Event
protected array	$beforeCallbacks	Массив обратных вызовов, которые должны выполняться перед запуском события.	from Event
protected array	$afterCallbacks	Массив обратных вызовов, которые должны выполняться после завершения события.	from Event
string	$description	Описание события, понятное для человека.	from Event
protected string	$callback	Обратный вызов для вызова.
protected array	$parameters	Параметры для передачи методу.

Методы

void	__construct(string $callback, array $parameters = []) Создать новый экземпляр события.
string	getDefaultOutput() Получить стандартный вывод в зависимости от ОС.	из Event
void	run(Container $container) Запустить данное событие.
void	runCommandInBackground() Запустить команду в фоновом режиме с помощью exec.	из Event
void	runCommandInForeground(Container $container) Запустить команду в переднем плане.	из Event
void	callBeforeCallbacks(Container $container) Вызвать все коллбэки "before" для события.	из Event
void	callAfterCallbacks(Container $container) Вызвать все коллбэки "after" для события.	из Event
string	buildCommand() Построить строку команды.	из Event
string	mutexPath() Получить путь к мьютексу для запланированной команды.
bool	isDue(Application $app) Определить, следует ли запускать данное событие на основе выражения Cron.	из Event
bool	expressionPasses() Определить, проходит ли выражение Cron.	из Event
bool	filtersPass(Application $app) Определить, проходят ли фильтры для события.	из Event
bool	runsInEnvironment(string $environment) Определить, запускается ли событие в данной среде.	из Event
bool	runsInMaintenanceMode() Определить, запускается ли событие в режиме обслуживания.	из Event
$this	cron(string $expression) Выражение Cron, представляющее частоту события.	из Event
$this	hourly() Запланировать событие для ежечасного запуска.	из Event
$this	daily() Запланировать событие для ежедневного запуска.	из Event
$this	at(string $time) Запланировать команду на заданное время.	из Event
$this	dailyAt(string $time) Запланировать событие для ежедневного запуска в заданное время (10:00, 19:30 и т.д.).	из Event
$this	twiceDaily(int $first = 1, int $second = 13) Запланировать событие для запуска дважды в день.	из Event
$this	weekdays() Запланировать событие для запуска только по будням.	из Event
$this	mondays() Запланировать событие для запуска только по понедельникам.	из Event
$this	tuesdays() Запланировать событие для запуска только по вторникам.	из Event
$this	wednesdays() Запланировать событие для запуска только по средам.	из Event
$this	thursdays() Запланировать событие для запуска только по четвергам.	из Event
$this	fridays() Запланировать событие для запуска только по пятницам.	из Event
$this	saturdays() Запланировать событие для запуска только по субботам.	из Event
$this	sundays() Запланировать событие для запуска только по воскресеньям.	из Event
$this	weekly() Запланировать событие для еженедельного запуска.	из Event
$this	weeklyOn(int $day, string $time = '0:0') Запланировать событие для еженедельного запуска в заданный день и время.	из Event
$this	monthly() Запланировать событие для ежемесячного запуска.	из Event
$this	yearly() Запланировать событие для ежегодного запуска.	из Event
$this	everyMinute() Запланировать событие для запуска каждую минуту.	из Event
$this	everyFiveMinutes() Запланировать событие для запуска каждые пять минут.	из Event

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

Details

void __construct(string $callback, array $parameters = [])

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

Parameters

string	$callback
array	$parameters

Return Value

void

protected string getDefaultOutput()

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

Return Value

string

void run(Container $container)

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

Parameters

Container

$container

Return Value

void

Exceptions

Exception

protected void runCommandInBackground()

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

Return Value

void

protected void runCommandInForeground(Container $container)

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

Параметры

Container

$container

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

void

protected void callBeforeCallbacks(Container $container)

Вызвать все обратные вызовы «перед» событием.

Параметры

Container

$container

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

void

protected void callAfterCallbacks(Container $container)

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

Параметры

Container

$container

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

void

string buildCommand()

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

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

string

protected string mutexPath()

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

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

string

bool isDue(Application $app)

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

Параметры

Application

$app

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

bool

protected bool expressionPasses()

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

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

bool

protected bool filtersPass(Application $app)

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

Параметры

Application

$app

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

bool

bool runsInEnvironment(string $environment)

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

Параметры

string

$environment

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

bool

bool runsInMaintenanceMode()

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

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

bool

$this cron(string $expression)

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

Параметры

string

$expression

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

$this

$this hourly()

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

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

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

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

Parameters

int	$day
string	$time

Return Value

$this

$this monthly()

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

Return Value

$this

$this yearly()

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

Return Value

$this

$this everyMinute()

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

Return Value

$this

$this everyFiveMinutes()

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

Return Value

$this

$this everyTenMinutes()

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

Return Value

$this

$this everyThirtyMinutes()

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

Return Value

$this

$this days(array|mixed $days)

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

Parameters

array|mixed

$days

Return Value

$this

$this timezone(DateTimeZone|string $timezone)

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

Parameters

DateTimeZone|string

$timezone

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

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

Return Value

$this

$this when(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

$this skip(Closure $callback)

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

Parameters

Closure

$callback

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)

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

Parameters

array|mixed

$addresses

Return Value

$this

Exceptions

LogicException

protected void emailOutput(Mailer $mailer, array $addresses)

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

Parameters

Mailer	$mailer
array	$addresses

Return Value

void

protected string getEmailSubject()

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

Return Value

string

$this pingBefore(string $url)

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

Parameters

string

$url

Return Value

$this

$this before(Closure $callback)

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

Parameters

Closure

$callback

Return Value

$this

$this thenPing(string $url)

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

Parameters

string

$url

Return Value

$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

protected void removeMutex()

Удалить файл мьютекса из диска.

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

void

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