Команда

класс Command наследуется от Command (Просмотреть исходный код)

Трейты

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	Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.	из InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	из InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	из Macroable
protected Application	$laravel	Экземпляр приложения Laravel.
protected string	$signature	Имя и синтаксис команды консоли.
protected string	$name	Имя команды консоли.
protected string\|null	$description	Описание команды консоли.
protected string	$help	Текст справки по команде консоли.
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.
protected bool	$isolated	Указывает, может ли быть запущена только одна копия команды одновременно.
protected int	$isolatedExitCode	Код выхода по умолчанию для изолированных команд.
protected array	$aliases	Псевдонимы имени команды консоли.

Методы

Команда	resolveCommand(Command\|string $command) Разрешить экземпляр консольной команды для заданной команды.
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
смешанный тип	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя данные до тех пор, пока не пройдёт проверка по заданному обработавшему.	из ConfiguresPrompts
?строка	validatePrompt(mixed $value, mixed $rules) Проверить значение запроса с помощью валидатора.	из ConfiguresPrompts
Validator	getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = []) Получить экземпляр валидатора, который должен использоваться для проверки запросов.	из ConfiguresPrompts
массив	validationMessages() Получить сообщения валидации, которые должны использоваться во время проверки запросов.	из ConfiguresPrompts
массив	validationAttributes() Получить атрибуты валидации, которые должны использоваться во время проверки запросов.	из 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
смешанный тип	ask(string $question, string\|null $default = null) Задать вопрос пользователю.	из InteractsWithIO
смешанный тип	anticipate(string $question, array\|callable $choices, string\|null $default = null) Задать вопрос пользователю с автодополнением.	из InteractsWithIO
смешанный тип	askWithCompletion(string $question, array\|callable $choices, string\|null $default = null) Задать вопрос пользователю с автодополнением.	из InteractsWithIO
смешанный тип	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) Вывод строки как комментарий.	из InteractsWithIO
void	question(string $string, int\|string\|null $verbosity = null) Вывод строки как вопрос.	из InteractsWithIO
void	error(string $string, int\|string\|null $verbosity = null) Вывод строки как ошибку.	из InteractsWithIO
void	warn(string $string, int\|string\|null $verbosity = null) Вывод строки как предупреждение.	из InteractsWithIO
void	alert(string $string, int\|string\|null $verbosity = null) Вывод строки в окне уведомления.	из InteractsWithIO
$this	newLine(int $count = 1) Вывод пустой строки.	из InteractsWithIO
void	setInput(InputInterface $input) Установить реализацию интерфейса ввода.	из InteractsWithIO
void	setOutput(OutputStyle $output) Установить реализацию интерфейса вывода.	из InteractsWithIO
void	setVerbosity(string\|int $level) Установить уровень детализации.	из InteractsWithIO
int	parseVerbosity(string\|int\|null $level = null) Получить уровень детализации в терминах уровня OutputInterface Symfony.	из InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	из InteractsWithIO
Factory	outputComponents() Получить реализацию фабрики компонентов вывода.	из InteractsWithIO
trap($signals, $callback) Без описания	из InteractsWithSignals
void	untrap() Отменить обработчики сигналов, установленные в обработчике команды.	из InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействие с пользователем перед валидацией ввода.	из PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запрос у пользователя отсутствующих аргументов.	из PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запрос отсутствующих аргументов ввода, используя возвращенные вопросы.	из PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Выполнение действий после того, как пользователя попросили предоставить отсутствующие аргументы.	из PromptsForMissingInput
bool	didReceiveOptions(InputInterface $input) Является ли ввод содержит какие-либо параметры, отличающиеся от значений по умолчанию.	из PromptsForMissingInput
static void	macro(string $name, object\|callable $macro) Регистрация пользовательского макроса.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверка, зарегистрирован ли макрос.	из Macroable
static void	flushMacros() Очистка существующих макросов.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамическая обработка вызовов класса.	из Macroable

void	__construct() Создать новый экземпляр команды консоли.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.
void	configureIsolation() Настроить команду консоли для изоляции.
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.
void	fail(Throwable\|string\|null $exception = null) Принудительно завершить команду с ошибкой.
bool	isHidden() {@inheritdoc}
Command	setHidden(bool $hidden = true) {@inheritdoc}
Application	getLaravel() Получить экземпляр приложения Laravel.
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.

Подробности

protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string

$command

Return Value

Command

int call(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

int callSilent(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

int callSilently(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Parameters

Command\|string	$command
array	$arguments
OutputInterface	$output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array

$arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void configurePrompts(InputInterface $input)

Настроить отступы запроса.

Parameters

InputInterface

$input

Return Value

void

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

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

Parameters

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

Return Value

mixed

protected ?string validatePrompt(mixed $value, mixed $rules)

Проверить заданное значение запроса с помощью валидатора.

Parameters

mixed	$value
mixed	$rules

Return Value

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Parameters

mixed	$field
mixed	$value
mixed	$rules
array	$messages
array	$attributes

Return Value

Validator

protected array validationMessages()

Получить сообщения об ошибках валидации, которые следует использовать во время проверки запросов.

Return Value

array

protected array validationAttributes()

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

Return Value

array

protected void restorePrompts()

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

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

array|string|bool|null argument(string|null $key = null)

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

Параметры

string|null

$key

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

array|string|bool|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

string|array|bool|null option(string|null $key = null)

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

Параметры

string|null

$key

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

string|array|bool|null

array options()

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

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

array

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

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

Параметры

string	$question
bool	$default

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

bool

mixed ask(string $question, string|null $default = null)

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

Параметры

string	$question
string\|null	$default

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

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

Параметры

string	$question
array\|callable	$choices
string\|null	$default

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

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Параметры

string	$question
array\|callable	$choices
string\|null	$default

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

mixed

mixed secret(string $question, bool $fallback = true)

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

Параметры

string	$question
bool	$fallback

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

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Параметры

string	$question
array	$choices
string\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

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

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

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

Параметры

array	$headers
Arrayable\|array	$rows
TableStyle\|string	$tableStyle
array	$columnStyles

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

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable\|int	$totalSteps
Closure	$callback

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

mixed|void

void info(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

Параметры

string	$string
string\|null	$style
int\|string\|null	$verbosity

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

void

void comment(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void question(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void error(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void warn(string $string, int|string|null $verbosity = null)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void alert(string $string, int|string|null $verbosity = null)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

$this newLine(int $count = 1)

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

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int

$level

Return Value

void

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

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

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

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

Return Value

OutputStyle

Factory outputComponents()

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

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

	$signals
	$callback

void untrap()

internal

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

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Является ли ввод содержащим параметры, отличающиеся от значения по умолчанию.

Parameters

InputInterface

$input

Return Value

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

Добавить другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

END_OF_DOCUMENT_MARKER

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

void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

Параметры

Throwable|string|null

$exception

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

void

Исключения

Throwable

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

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