ShowCommand

class ShowCommand extends DatabaseInspectionCommand (View source)

Трейты

CallsCommands

ConfiguresPrompts

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	The console components factory.	from InteractsWithIO
protected InputInterface	$input	The input interface implementation.	from InteractsWithIO
protected OutputStyle	$output	The output interface implementation.	from InteractsWithIO
protected int	$verbosity	The default verbosity of output commands.	from InteractsWithIO
protected array	$verbosityMap	The mapping between human readable verbosity levels and Symfony's OutputInterface.	from InteractsWithIO
protected Signals\|null	$signals	The signal registrar instance.	from InteractsWithSignals
static protected array	$macros	The registered string macros.	from Macroable
protected Application	$laravel	The Laravel application instance.	from Command
protected string	$signature	The name and signature of the console command.
protected string	$name	The console command name.	from Command
protected string	$description	The console command description.
protected string	$help	The console command help text.	from Command
protected bool	$hidden	Indicates whether the command should be shown in the Artisan command list.	from Command
protected bool	$isolated	Indicates whether only one instance of the command can run at any given time.	from Command
protected int	$isolatedExitCode	The default exit code for isolated commands.	from Command
protected array	$aliases	The console command name aliases.	from Command
protected array	$typeMappings	A map of database column types.	from DatabaseInspectionCommand
protected Composer	$composer	The Composer instance.	from DatabaseInspectionCommand

Методы

Команда	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) Вывести строку как комментарий.	из 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) Получить уровень подробности в терминах уровня Symfony's OutputInterface.	из 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(Composer $composer = null) Создать новый экземпляр команды.	из DatabaseInspectionCommand
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	из Command
void	configureIsolation() Настроить команду консоли для изоляции.	из Command

int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	из Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	из Command
bool	isHidden() {@inheritdoc}	из Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	из Command
Application	getLaravel() Получить экземпляр приложения Laravel.	из Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	из Command
void	registerTypeMappings(AbstractPlatform $platform) Зарегистрировать пользовательские сопоставления типов Doctrine для команд проверки баз данных.	из DatabaseInspectionCommand
string	getPlatformName(AbstractPlatform $platform, string $database) Получить удобочитаемое имя платформы для заданной платформы.	из DatabaseInspectionCommand
int\|null	getTableSize(ConnectionInterface $connection, string $table) Получить размер таблицы в байтах.	из DatabaseInspectionCommand
mixed	getMySQLTableSize(ConnectionInterface $connection, string $table) Получить размер таблицы MySQL в байтах.	из DatabaseInspectionCommand
mixed	getPostgresTableSize(ConnectionInterface $connection, string $table) Получить размер таблицы Postgres в байтах.	из DatabaseInspectionCommand
mixed	getSqliteTableSize(ConnectionInterface $connection, string $table) Получить размер таблицы SQLite в байтах.	из DatabaseInspectionCommand
int\|null	getConnectionCount(ConnectionInterface $connection) Получить количество открытых подключений для базы данных.	из DatabaseInspectionCommand
array	getConfigFromDatabase(string $database) Получить детали конфигурации подключения для заданного подключения.	из DatabaseInspectionCommand
bool	ensureDependenciesExist() Убедиться, что зависимости команд базы данных доступны.	из DatabaseInspectionCommand
void	installDependencies() Установить зависимости команды.	из DatabaseInspectionCommand
int	handle(ConnectionResolverInterface $connections) Выполнить команду консоли.
Collection	tables(ConnectionInterface $connection, AbstractSchemaManager $schema) Получить информацию о таблицах в базе данных.
Collection	collectViews(ConnectionInterface $connection, AbstractSchemaManager $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)

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

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

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

Parameters

string|null

$key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

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

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

Parameters

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

Return Value

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

END_OF_DOCUMENT_MARKER

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)

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

Параметры

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

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

void

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

Вывести строку в всплывающем окне.

Параметры

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

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

void

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

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(Composer $composer = null)

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

Параметры

Composer

$composer

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

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

protected void registerTypeMappings(AbstractPlatform $platform)

Регистрация пользовательских сопоставлений типов Doctrine для команд проверки.

Параметры

AbstractPlatform

$platform

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

void

protected string getPlatformName(AbstractPlatform $platform, string $database)

Получить удобочитаемое имя платформы для данной платформы.

Параметры

AbstractPlatform	$platform
string	$database

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

string

protected int|null getTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы в байтах.

Параметры

ConnectionInterface	$connection
string	$table

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

int|null

protected mixed getMySQLTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы MySQL в байтах.

Параметры

ConnectionInterface	$connection
string	$table

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

mixed

protected mixed getPostgresTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы Postgres в байтах.

Параметры

ConnectionInterface	$connection
string	$table

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

mixed

protected mixed getSqliteTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы SQLite в байтах.

Параметры

ConnectionInterface	$connection
string	$table

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

mixed

protected int|null getConnectionCount(ConnectionInterface $connection)

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

Параметры

ConnectionInterface

$connection

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

int|null

protected array getConfigFromDatabase(string $database)

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

Параметры

string

$database

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

array

protected bool ensureDependenciesExist()

Убедиться, что зависимости команд базы данных доступны.

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

bool

protected void installDependencies()

Установить зависимости команды.

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

void

Исключения

ProcessSignaledException

int handle(ConnectionResolverInterface $connections)

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

Параметры

ConnectionResolverInterface

$connections

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

int

protected Collection tables(ConnectionInterface $connection, AbstractSchemaManager $schema)

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

Параметры

ConnectionInterface	$connection
AbstractSchemaManager	$schema

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

Collection

protected Collection collectViews(ConnectionInterface $connection, AbstractSchemaManager $schema)

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

Параметры

ConnectionInterface	$connection
AbstractSchemaManager	$schema

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

Collection

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/10.x/Illuminate/Database/Console/ShowCommand.html