ConfigShowCommand

class ConfigShowCommand extends Команда (Просмотр исходного кода)

Особенности

Выполнение команд

Настройка запросов

Имеет параметры

Взаимодействие с вводом/выводом

Взаимодействие с сигналами

Макросы

Запросы для отсутствующего ввода

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	from InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	from InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	from InteractsWithIO
protected int	$verbosity	Уровень подробности вывода по умолчанию для команд.	from InteractsWithIO
protected array	$verbosityMap	Сопоставление удобочитаемых уровней подробности с уровнями OutputInterface Symfony.	from InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	from InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	from Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	from Command
protected string	$signature	Сигнатура команды консоли.
protected string	$name	Имя команды консоли.	from Command
protected string	$description	Описание команды консоли.
protected string	$help	Текст справки команды консоли.	from Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
protected bool	$isolated	Указывает, может ли выполняться только один экземпляр команды в данный момент.	from Command
protected int	$isolatedExitCode	Код выхода по умолчанию для изолированных команд.	from Command
protected array	$aliases	Псевдонимы имени команды консоли.	from 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
mixed	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() Восстановить вывод подсказок.	from ConfiguresPrompts
void	specifyParameters() Указать аргументы и опции команды.	from HasParameters
array	getArguments() Получить аргументы командной строки.	from HasParameters
array	getOptions() Получить опции командной строки.	from HasParameters
bool	hasArgument(string\|int $name) Определить, присутствует ли указанный аргумент.	from InteractsWithIO
array\|string\|bool\|null	argument(string\|null $key = null) Получить значение аргумента команды.	from InteractsWithIO
array	arguments() Получить все переданные аргументы команды.	from InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли указанная опция.	from InteractsWithIO
string\|array\|bool\|null	option(string\|null $key = null) Получить значение опции команды.	from InteractsWithIO
array	options() Получить все переданные опции команды.	from InteractsWithIO
bool	confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя.	from InteractsWithIO
mixed	ask(string $question, string\|null $default = null) Запросить ввод у пользователя.	from InteractsWithIO
mixed	anticipate(string $question, array\|callable $choices, string\|null $default = null) Запросить ввод у пользователя с автозаполнением.	from InteractsWithIO
mixed	askWithCompletion(string $question, array\|callable $choices, string\|null $default = null) Запросить ввод у пользователя с автозаполнением.	from InteractsWithIO
mixed	secret(string $question, bool $fallback = true) Запросить у пользователя ввод, скрыв ответ в консоли.	from InteractsWithIO

string\|array	choice(string $question, array $choices, string\|int\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Дайте пользователю один выбор из массива ответов.	from InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, TableStyle\|string $tableStyle = 'default', array $columnStyles = []) Форматирование ввода в текстовую таблицу.	from InteractsWithIO
mixed\|void	withProgressBar(iterable\|int $totalSteps, Closure $callback) Выполните заданный обратный вызов, одновременно продвигая полосу прогресса.	from InteractsWithIO
void	info(string $string, int\|string\|null $verbosity = null) Запись строки в виде выходных данных информации.	from InteractsWithIO
void	line(string $string, string\|null $style = null, int\|string\|null $verbosity = null) Запись строки в стандартный вывод.	from 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() Создать новый экземпляр команды консоли.	from Command
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
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	from Command
void	fail(Throwable\|string\|null $exception = null) Принудительно завершить команду с ошибкой.	from Command
bool	isHidden() {@inheritdoc}	from Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from Command
int	handle() Выполнить команду консоли.

void	render(string $name) Отобразить значения конфигурации.
void	title(string $title, string\|null $subtitle = null) Отобразить заголовок.
string	formatKey(string $key) Отформатировать заданный ключ конфигурации.
string	formatValue(mixed $value) Отформатировать заданное значение конфигурации.

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string

$command

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

Command

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

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

Параметры

Command\|string	$command
array	$arguments

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

int

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

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

Параметры

Command\|string	$command
array	$arguments

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

int

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

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

Параметры

Command\|string	$command
array	$arguments

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

int

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

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

Параметры

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

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array

$arguments

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

ArrayInput

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

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

Параметры

InputInterface

$input

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

void

END_OF_DOCUMENT_MARKER

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

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int

$name

Return Value

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)

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

Параметры

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

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

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

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

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

Параметры

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

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

void

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

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

Параметры

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

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

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

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

строка	$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

смешанный тип __call(строка $method, массив $parameters)

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

Параметры

строка	$method
массив	$parameters

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

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

Исключения

BadMethodCallException

пустое значение __construct()

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

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

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

защищенный пустое значение configureUsingFluentDefinition()

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

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

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

защищенный пустое значение configureIsolation()

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

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

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

целое число run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищенный целое число execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищенный CommandMutex commandIsolationMutex()

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

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

CommandMutex

пустое значение fail(Throwable|строка|null $exception = null)

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

Параметры

Throwable|строка|null

$exception

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

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

Исключения

Throwable

логическое значение isHidden()

{@inheritdoc}

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

логическое значение

Команда setHidden(логическое значение $hidden = true)

{@inheritdoc}

Параметры

логическое значение

$hidden

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

Команда

Приложение getLaravel()

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

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

Приложение

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

int handle()

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

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

int

void render(string $name)

Отобразить значения конфигурации.

Параметры

string

$name

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

void

void title(string $title, string|null $subtitle = null)

Отобразить заголовок.

Параметры

string	$title
string\|null	$subtitle

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

void

protected string formatKey(string $key)

Отформатировать заданный ключ конфигурации.

Параметры

string

$key

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

string

protected string formatValue(mixed $value)

Отформатировать заданное значение конфигурации.

Параметры

mixed

$value

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

string

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