ShowCommand

класс ShowCommand расширяет DatabaseInspectionCommand (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	Имя и подпись консольной команды.
protected string	$name	Имя консольной команды.	из Command
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
?строка	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
string	getConnectionName(ConnectionInterface $connection, string $database) Получает удобочитаемое имя для заданного подключения.	из DatabaseInspectionCommand
int\|null	getConnectionCount(ConnectionInterface $connection) Получает количество открытых подключений для базы данных.	из DatabaseInspectionCommand
array	getConfigFromDatabase(string $database) Получает данные конфигурации подключения для заданного подключения.	из DatabaseInspectionCommand
string	withoutTablePrefix(ConnectionInterface $connection, string $table) Удаляет префикс таблицы из имени таблицы, если он существует.	из DatabaseInspectionCommand
int	handle(ConnectionResolverInterface $connections) Выполняет команду консоли.
Collection	tables(ConnectionInterface $connection, Builder $schema) Получает информацию о таблицах в базе данных.
Collection	views(ConnectionInterface $connection, Builder $schema) Получает информацию о представлениях в базе данных.
Collection	types(ConnectionInterface $connection, Builder $schema) Получает информацию об определяемых пользователем типах в базе данных.
void	display(array $data) Отображает информацию о базе данных.
void	displayJson(array $data) Отображает информацию о базе данных в формате JSON.
void	displayForCli(array $data) Отображает информацию о базе данных в формате, предназначенном для командной строки.

Подробности

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)

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

Параметры

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

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

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

Параметры

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

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

mixed

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

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

Параметры

mixed	$value
mixed	$rules

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

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

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)

Описание отсутствует

Параметры

	$signals
	$callback

void untrap()

internal

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

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

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

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

Ручное завершение команды с ошибкой.

Параметры

Throwable|string|null

$exception

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

void

Исключения

Throwable

bool isHidden()

{@inheritdoc}

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

bool

END_OF_DOCUMENT_MARKER

Команда setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

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

Команда

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

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

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

Приложение

void setLaravel(Контейнер $laravel)

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

Параметры

Контейнер

$laravel

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

void

protected string getConnectionName(Интерфейс подключения $connection, string $database)

Получить удобочитаемое имя для данного подключения.

Параметры

Интерфейс подключения	$connection
string	$database

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

string

protected int|null getConnectionCount(Интерфейс подключения $connection)

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

Параметры

Интерфейс подключения

$connection

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

int|null

protected array getConfigFromDatabase(string $database)

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

Параметры

string

$database

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

array

protected string withoutTablePrefix(Интерфейс подключения $connection, string $table)

Удалить префикс таблицы из имени таблицы, если он существует.

Параметры

Интерфейс подключения	$connection
string	$table

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

string

int handle(Интерфейс разрешения подключения $connections)

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

Параметры

Интерфейс разрешения подключения

$connections

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

int

protected Коллекция tables(Интерфейс подключения $connection, Строитель $schema)

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

Параметры

Интерфейс подключения	$connection
Строитель	$schema

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

Коллекция

protected Коллекция views(Интерфейс подключения $connection, Строитель $schema)

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

Параметры

Интерфейс подключения	$connection
Строитель	$schema

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

Коллекция

protected Коллекция types(Интерфейс подключения $connection, Строитель $schema)

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

Параметры

Интерфейс подключения	$connection
Строитель	$schema

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

Коллекция

protected void display(array $data)

Отобразить информацию о базе данных.

Параметры

array

$data

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

void

protected void displayJson(array $data)

Отобразить информацию о базе данных в формате JSON.

Параметры

array

$data

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

void

protected void displayForCli(array $data)

Отобразить информацию о базе данных в формате для командной строки.

Параметры

array

$data

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

void

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