ScheduleRunCommand

class ScheduleRunCommand extends Command (View source)

Свойства

CallsCommands

ConfiguresPrompts

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Производитель консольных компонентов.	из InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	из InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	из InteractsWithIO
protected int	$verbosity	Уровень подробности по умолчанию для команд вывода.	из InteractsWithIO
protected array	$verbosityMap	Сопоставление уровней подробности, понятных пользователю, и уровней OutputInterface Symfony.	из InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	из InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	из Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	из Command
protected string	$signature	Имя и синтаксис консольной команды.	из Command
protected string	$name	Имя консольной команды.
protected string	$description	Описание консольной команды.
protected string	$help	Текст справки консольной команды.	из Command
protected bool	$hidden	Указывает, следует ли отображать команду в списке команд Artisan.	из Command
protected bool	$isolated	Указывает, может ли выполняться только одна инстанция команды в данный момент.	из Command
protected int	$isolatedExitCode	Значение кода выхода по умолчанию для изолированных команд.	из Command
protected array	$aliases	Псевдонимы имени консольной команды.	из Command
protected Schedule	$schedule	Экземпляр расписания.
protected Carbon	$startedAt	Маркер времени (24 часа), когда эта команда планировщика начала работу.
protected bool	$eventsRan	Проверяет, были ли выполнены какие-либо события.
protected Dispatcher	$dispatcher	Диспечер событий.
protected ExceptionHandler	$handler	Обработчик исключений.
protected Repository	$cache	Реализация хранилища кэша.
protected string	$phpBinary	Бинарник PHP, используемый командой.

Методы

Команда	resolveCommand(Command\|string $command) Разрешить экземпляр консольной команды для заданной команды.	из CallsCommands
int	call(Command\|string $command, array $arguments = []) Вызвать другую консольную команду.	из CallsCommands
int	callSilent(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	из CallsCommands
int	callSilently(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	из CallsCommands
int	runCommand(Command\|string $command, array $arguments, OutputInterface $output) Выполнить заданную консольную команду.	из CallsCommands
ArrayInput	createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов.	из CallsCommands
массив	context() Получить весь контекст, переданный команде.	из CallsCommands
void	configurePrompts(InputInterface $input) Настроить отключения подсказок.	из ConfiguresPrompts
mixed	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Выводить подсказки пользователю до тех пор, пока не будет пройден заданный вызов проверки.	из ConfiguresPrompts
void	restorePrompts() Восстановить вывод подсказок.	из ConfiguresPrompts
void	specifyParameters() Указать аргументы и параметры команды.	из HasParameters
массив	getArguments() Получить аргументы консольной команды.	из HasParameters
массив	getOptions() Получить параметры консольной команды.	из HasParameters
bool	hasArgument(string\|int $name) Определить, присутствует ли заданный аргумент.	из InteractsWithIO
массив\|строка\|bool\|null	argument(string\|null $key = null) Получить значение аргумента команды.	из InteractsWithIO
массив	arguments() Получить все аргументы, переданные команде.	из InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли заданный параметр.	из InteractsWithIO
строка\|массив\|bool\|null	option(string\|null $key = null) Получить значение параметра команды.	из InteractsWithIO
массив	options() Получить все параметры, переданные команде.	из InteractsWithIO
bool	confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя.	из InteractsWithIO
mixed	ask(string $question, string\|null $default = null) Задать вопрос пользователю для получения ввода.	из InteractsWithIO
mixed	anticipate(string $question, array\|callable $choices, string\|null $default = null) Задать вопрос пользователю для ввода с автозавершением.	из InteractsWithIO
mixed	askWithCompletion(string $question, array\|callable $choices, string\|null $default = null) Задать вопрос пользователю для ввода с автозавершением.	из InteractsWithIO
mixed	secret(string $question, bool $fallback = true) Задать вопрос пользователю для ввода, но скрыть ответ в консоли.	из InteractsWithIO
строка\|массив	choice(string $question, array $choices, string\|int\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Предложить пользователю один вариант ответа из массива ответов.	из InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, TableStyle\|string $tableStyle = 'default', array $columnStyles = []) Форматировать входные данные в текстовую таблицу.	из InteractsWithIO
mixed\|void	withProgressBar(iterable\|int $totalSteps, Closure $callback) Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса.	из InteractsWithIO
void	info(string $string, int\|string\|null $verbosity = null) Вывести строку как информацию.	из InteractsWithIO
void	line(string $string, string\|null $style = null, int\|string\|null $verbosity = null) Вывести строку как стандартный вывод.	из InteractsWithIO

void	comment(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве комментария.	from InteractsWithIO
void	question(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве вопроса.	from InteractsWithIO
void	error(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве сообщения об ошибке.	from InteractsWithIO
void	warn(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве предупреждения.	from InteractsWithIO
void	alert(string $string, int\|string\|null $verbosity = null) Вывести строку в всплывающем окне с предупреждением.	from InteractsWithIO
$this	newLine(int $count = 1) Вывести пустую строку.	from InteractsWithIO
void	setInput(InputInterface $input) Установить реализацию интерфейса ввода.	from InteractsWithIO
void	setOutput(OutputStyle $output) Установить реализацию интерфейса вывода.	from InteractsWithIO
void	setVerbosity(string\|int $level) Установить уровень подробности.	from InteractsWithIO
int	parseVerbosity(string\|int\|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	from InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	from InteractsWithIO
Factory	outputComponents() Получить реализацию фабрики компонентов вывода.	from InteractsWithIO
trap($signals, $callback) Без описания	from InteractsWithSignals
void	untrap() Отменить обработку сигналов, заданных в обработчике команды.	from InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействовать с пользователем до валидации ввода.	from PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запросить у пользователя отсутствующие аргументы.	from PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запрос отсутствующих аргументов ввода с использованием возвращаемых вопросов.	from PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Выполнить действия после запроса отсутствующих аргументов у пользователя.	from PromptsForMissingInput
bool	didReceiveOptions(InputInterface $input) Содержит ли входные данные какие-либо параметры, отличающиеся от значений по умолчанию?	from PromptsForMissingInput
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
void	__construct() Создать новый экземпляр команды.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	from Command
void	configureIsolation() Настроить команду консоли для изоляции.	from Command
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	from Command

БлокировкаКоманд	commandIsolationMutex() Получить экземпляр блокировки изоляции команд для команды.	из Команды
bool	isHidden() {@inheritdoc}	из Команды
Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команды
Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
void	handle(Расписание $schedule, ДиспечерСобытий $dispatcher, Репозиторий $cache, ОбработчикИсключений $handler) Выполнить консольную команду.
void	runSingleServerEvent(Событие $event) Выполнить данное событие отдельного сервера.
void	runEvent(Событие $event) Выполнить данное событие.
void	repeatEvents(Event> $events) Выполнить данные повторяющиеся события.
bool	shouldInterrupt() Определить, должно ли выполняться прерывание выполнения расписания.
void	clearInterruptSignal() Убедиться, что сигнал прерывания очищен.

Подробности

abstract protected Команда resolveCommand(Команда|string $command)

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

Параметры

Команда|строка

$command

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

Команда

int call(Команда|строка $command, array $arguments = [])

Вызвать другую консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilent(Команда|строка $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilently(Команда|строка $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

protected int runCommand(Команда|строка $command, array $arguments, OutputInterface $output)

Выполнить заданную консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

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

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

массив

protected void configurePrompts(InputInterface $input)

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

Параметры

InputInterface

$input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure	$prompt
bool\|string	$required
Closure\|null	$validate

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

mixed

protected void restorePrompts()

Восстановить вывод подсказок.

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

void

protected void specifyParameters()

Указать аргументы и параметры команды.

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

void

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

массив|строка|bool|null argument(string|null $key = null)

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

Параметры

string|null

$key

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

массив|строка|bool|null

массив arguments()

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

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

массив

bool hasOption(string $name)

Определить, присутствует ли данный параметр.

Параметры

строка

$name

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

bool

строка|массив|bool|null option(string|null $key = null)

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

Параметры

строка|null

$key

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

строка|массив|bool|null

массив options()

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

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

массив

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

строка	$question
bool	$default

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

bool

смешанный тип ask(string $question, string|null $default = null)

Запросить у пользователя ввод.

Параметры

строка	$question
строка\|null	$default

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

смешанный тип

смешанный тип anticipate(string $question, array|callable $choices, string|null $default = null)

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

Параметры

строка	$question
массив\|вызываемый объект	$choices
строка\|null	$default

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

смешанный тип

смешанный тип askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Параметры

строка	$question
массив\|вызываемый объект	$choices
строка\|null	$default

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

смешанный тип

смешанный тип secret(string $question, bool $fallback = true)

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

Параметры

строка	$question
bool	$fallback

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

смешанный тип

строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предложить пользователю один вариант из списка ответов.

Параметры

строка	$question
массив	$choices
строка\|целое число\|null	$default
смешанный тип\|null	$attempts
bool	$multiple

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

строка|массив

пустое значение table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Форматировать ввод в текстовую таблицу.

Параметры

массив	$headers
Arrayable\|массив	$rows
TableStyle\|строка	$tableStyle
массив	$columnStyles

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

пустое значение

смешанный тип|пустое значение withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable\|целое число	$totalSteps
Closure	$callback

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

смешанный тип|пустое значение

пустое значение info(string $string, int|string|null $verbosity = null)

Вывести строку как информационное сообщение.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение line(string $string, string|null $style = null, int|string|null $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

строка	$string
строка\|null	$style
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение comment(string $string, int|string|null $verbosity = null)

Вывести строку как комментарий.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение question(string $string, int|string|null $verbosity = null)

Вывести строку как вопрос.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение error(string $string, int|string|null $verbosity = null)

Вывести строку как ошибку.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение warn(string $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

пустое значение alert(string $string, int|string|null $verbosity = null)

Вывести строку в окне предупреждения.

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

пустое значение

$this newLine(int $count = 1)

Написать пустую строку.

Параметры

int

$count

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

$this

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface

$input

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

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle

$output

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

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

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

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности с точки зрения уровня OutputInterface Symfony.

Параметры

string|int|null

$level

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

int

OutputStyle getOutput()

Получить реализацию вывода.

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

OutputStyle

Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Без описания

Параметры

	$signals
	$callback

void untrap()

внутренний

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействие с пользователем перед проверкой ввода.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

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

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

Является ли входной поток содержит какие-либо параметры, которые отличаются от значений по умолчанию.

Параметры

InputInterface

$input

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

bool

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

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения в стиле fluent.

Значение возвращаемого значения

void

protected void configureIsolation()

Настроить команду консоли для изоляции.

Значение возвращаемого значения

void

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

int

protected int execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Значение возвращаемого значения

int

protected CommandMutex commandIsolationMutex()

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

Значение возвращаемого значения

CommandMutex

bool isHidden()

{@inheritdoc}

Значение возвращаемого значения

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

Значение возвращаемого значения

Command

Application getLaravel()

Получить экземпляр приложения Laravel.

Значение возвращаемого значения

Application

void setLaravel(Container $laravel)

Установить экземпляр приложения Laravel.

Параметры

Container

$laravel

Значение возвращаемого значения

void

void handle(Schedule $schedule, Dispatcher $dispatcher, Repository $cache, ExceptionHandler $handler)

Выполнить команду консоли.

Параметры

Schedule	$schedule
Dispatcher	$dispatcher
Repository	$cache
ExceptionHandler	$handler

Значение возвращаемого значения

void

protected void runSingleServerEvent(Event $event)

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

Параметры

Event

$event

Значение возвращаемого значения

void

protected void runEvent(Event $event)

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

Параметры

Event

$event

Значение возвращаемого значения

void

protected void repeatEvents(Event> $events)

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

Параметры

Event>

$events

Значение возвращаемого значения

void

protected bool shouldInterrupt()

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

Значение возвращаемого значения

bool

protected void clearInterruptSignal()

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

Значение возвращаемого значения

void

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