ShowCommand

class ShowCommand extends DatabaseInspectionCommand (View source)

Трейты

CallsCommands

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	from InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	from InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	from InteractsWithIO
protected int	$verbosity	Уровень детализации вывода команд по умолчанию.	from InteractsWithIO
protected array	$verbosityMap	Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.	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 array	$typeMappings	Карта типов столбцов базы данных.	from DatabaseInspectionCommand
protected Composer	$composer	Экземпляр Composer.	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	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) Вывести строку как ошибку.	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
void	trap(iterable<array-key,int>\|int $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(Composer $composer = null) Создать новый экземпляр команды.	from DatabaseInspectionCommand
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
bool	isHidden() {@inheritdoc}	from Command

Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команды
Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
void	registerTypeMappings(AbstractPlatform $platform) Зарегистрировать пользовательские сопоставления типов Doctrine для команд проверки базы данных.	из Команды проверки базы данных
string	getPlatformName(AbstractPlatform $platform, string $database) Получить удобочитаемое имя платформы для заданной платформы.	из Команды проверки базы данных
int\|null	getTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы в байтах.	из Команды проверки базы данных
mixed	getMySQLTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы MySQL в байтах.	из Команды проверки базы данных
mixed	getPostgresTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы Postgres в байтах.	из Команды проверки базы данных
mixed	getSqliteTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы SQLite в байтах.	из Команды проверки базы данных
int\|null	getConnectionCount(Интерфейс подключения $connection) Получить количество открытых подключений к базе данных.	из Команды проверки базы данных
array	getConfigFromDatabase(string $database) Получить конфигурацию подключения к заданной базе данных.	из Команды проверки базы данных
bool	ensureDependenciesExist() Убедиться в наличии зависимостей для команд базы данных.	из Команды проверки базы данных
void	installDependencies() Установить зависимости команды.	из Команды проверки базы данных
int	handle(Интерфейс разрешения подключений $connections) Выполнить команду консоли.
Коллекция	tables(Интерфейс подключения $connection, AbstractSchemaManager $schema) Получить информацию о таблицах в базе данных.
Коллекция	collectViews(Интерфейс подключения $connection, AbstractSchemaManager $schema) Получить информацию о представлениях в базе данных.
void	display(array $data) Отобразить информацию о базе данных.
void	displayJson(array $data) Отобразить информацию о базе данных в формате JSON.
void	displayForCli(array $data) Отобразить информацию о базе данных в формате для командной строки.

Подробности

abstract protected Команда resolveCommand(Command|string $command)

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

Parameters

Команда|string

$command

Return Value

Команда

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

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

Parameters

Команда\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

Команда\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

Команда\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

Команда\|string	$command
array	$arguments
OutputInterface	$output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array

$arguments

Return Value

ArrayInput

END_OF_DOCUMENT_MARKER

protected array context()

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

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

array

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)

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

Параметры

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

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обработчик для заданных сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

Значение результата

void

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

END_OF_DOCUMENT_MARKER

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)

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

Parameters

ConnectionInterface

$connection

Return Value

int|null

protected array getConfigFromDatabase(string $database)

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

Parameters

string

$database

Return Value

array

protected bool ensureDependenciesExist()

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

Return Value

bool

protected void installDependencies()

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

Return Value

void

Exceptions

ProcessSignaledException

int handle(ConnectionResolverInterface $connections)

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

Parameters

ConnectionResolverInterface

$connections

Return Value

int

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

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

Parameters

ConnectionInterface	$connection
AbstractSchemaManager	$schema

Return Value

Collection

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

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

Parameters

ConnectionInterface	$connection
AbstractSchemaManager	$schema

Return Value

Collection

protected void display(array $data)

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

Parameters

array

$data

Return Value

void

protected void displayJson(array $data)

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

Parameters

array

$data

Return Value

void

protected void displayForCli(array $data)

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

Parameters

array

$data

Return Value

void

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