TableCommand

class TableCommand extends 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	Сопоставление удобочитаемых уровней подробности и уровней Symfony OutputInterface.	из 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
protected array	$typeMappings	Карта типов столбцов базы данных.	из DatabaseInspectionCommand
protected Composer	$composer	Экземпляр Composer.	из 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) Получить уровень подробности в терминах уровня 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(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	columns(Table $table) Получить информацию о столбцах таблицы.
Collection	getAttributesForColumn(Column $column) Получить атрибуты для столбца таблицы.
Collection	indexes(Table $table) Получить информацию об индексах таблицы.
Collection	getAttributesForIndex(Index $index) Получить атрибуты для индекса таблицы.
Collection	foreignKeys(Table $table) Получить информацию о внешних ключах таблицы.
void	display(array $data) Отобразить информацию о таблице.
void	displayJson(array $data) Отобразить информацию о таблице в формате JSON.
void	displayForCli(array $data) Отобразить информацию о таблице в формате, подходящем для CLI.

Подробности

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

END_OF_DOCUMENT_MARKER

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

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

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

Параметры

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

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

mixed

protected void restorePrompts()

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

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

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

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

Параметры

string|null

$key

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

array|string|bool|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

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

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

Параметры

string|null

$key

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

string|array|bool|null

array options()

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

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

array

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

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

Параметры

string	$question
bool	$default

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

bool

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

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

Параметры

string	$question
string\|null	$default

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

string	$question
bool	$fallback

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

mixed

строка|массив choice(строка $question, массив $choices, строка|целое|null $default = null, смешанное|null $attempts = null, логическое $multiple = false)

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

Параметры

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

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

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

пустое значение table(массив $headers, Arrayable|массив $rows, TableStyle|строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

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

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

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

смешанное|пустое значение withProgressBar(итерируемый|целое $totalSteps, Closure $callback)

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

Параметры

итерируемый\|целое	$totalSteps
Closure	$callback

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

смешанное|пустое значение

пустое значение info(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение line(строка $string, строка|null $style = null, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение comment(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение question(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение error(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение warn(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

пустое значение alert(строка $string, целое|строка|null $verbosity = null)

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

Параметры

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

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

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

$this newLine(целое $count = 1)

Вставляет пустую строку.

Параметры

целое

$count

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

$this

пустое значение setInput(InputInterface $input)

Устанавливает реализацию интерфейса ввода.

Параметры

InputInterface

$input

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

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

пустое значение setOutput(OutputStyle $output)

Устанавливает реализацию интерфейса вывода.

Параметры

OutputStyle

$output

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

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

protected пустое значение setVerbosity(строка|целое $level)

Устанавливает уровень подробности.

Параметры

строка|целое

$level

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

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

protected целое parseVerbosity(строка|целое|null $level = null)

Получение уровня подробности в терминах уровня OutputInterface Symfony.

Параметры

строка|целое|null

$level

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

целое

OutputStyle getOutput()

Получение реализации вывода.

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

OutputStyle

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Без описания

Параметры

	$signals
	$callback

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

внутреннее

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

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

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

END_OF_DOCUMENT_MARKER

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

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Composer $composer = null)

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

Parameters

Composer

$composer

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

protected void configureIsolation()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected int execute(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool

$hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container

$laravel

Return Value

void

protected void registerTypeMappings(AbstractPlatform $platform)

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

Parameters

AbstractPlatform

$platform

Return Value

void

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

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

Parameters

AbstractPlatform	$platform
string	$database

Return Value

string

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

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

Parameters

ConnectionInterface	$connection
string	$table

Return Value

int|null

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

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

Parameters

ConnectionInterface	$connection
string	$table

Return Value

mixed

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

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

Parameters

ConnectionInterface	$connection
string	$table

Return Value

mixed

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

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

Parameters

ConnectionInterface	$connection
string	$table

Return Value

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 columns(Table $table)

Получить информацию о столбцах таблицы.

Parameters

Table

$table

Return Value

Collection

protected Collection getAttributesForColumn(Column $column)

Получить атрибуты для столбца таблицы.

Parameters

Column

$column

Return Value

Collection

protected Collection indexes(Table $table)

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

Parameters

Table

$table

Return Value

Collection

protected Collection getAttributesForIndex(Index $index)

Получить атрибуты для индекса таблицы.

Parameters

Index

$index

Return Value

Collection

protected Collection foreignKeys(Table $table)

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

Parameters

Table

$table

Return Value

Collection

protected void display(array $data)

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

Parameters

array

$data

Return Value

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/TableCommand.html