EnvironmentCommand

класс EnvironmentCommand расширяет 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.	из 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

Методы

Команда	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
смешанный	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя данные до тех пор, пока обратный вызов проверки не пройдет.	из ConfiguresPrompts
?string	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

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

Подробности

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

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

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 = [])

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

Параметры

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

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

Validator

protected array validationMessages()

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

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

array

protected array validationAttributes()

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

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

array

protected void restorePrompts()

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

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

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)

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

Вывести строку в виде сообщения об ошибке.

Parameters

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

Return Value

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)

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

Parameters

InputInterface

$input

Return Value

bool

статический void macro(string $name, object|callable $macro)

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

Параметры

string	$name
object\|callable	$macro

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

void

статический void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

статический bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

статический void flushMacros()

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

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

void

статический 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

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

void handle()

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

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

void

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