DatabaseInspectionCommand

абстрактный класс DatabaseInspectionCommand расширяет Command (View source)

Трейты

CallsCommands

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	Имя и синтаксис команды консоли.	из Command
protected string	$name	Имя команды консоли.	из Command
protected string\|null	$description	Описание команды консоли.	из Command
protected string	$help	Текст справки команды консоли.	из Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из Command
protected array	$typeMappings	Карта типов столбцов базы данных.
protected Composer	$composer	Экземпляр Composer.

Методы

Команда	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) Вывести строку в качестве сообщения об ошибке.	из 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
void	trap(iterable<array-key,int>\|int $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) Создать новый экземпляр команды.
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

Команда	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() Установить зависимости команды.

Подробности

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

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

Параметры

Команда|строка

$command

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

Команда

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

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

Параметры

Команда\|строка	$command
массив	$arguments

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

int

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

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

Параметры

Команда\|строка	$command
массив	$arguments

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

int

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

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

Параметры

Команда\|строка	$command
массив	$arguments

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

int

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

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

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

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

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

массив

protected void specifyParameters()

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

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

void

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

строка|int

$name

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

bool

массив|строка|bool|null argument(string|null $key = null)

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

Параметры

строка|null

$key

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

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

массив arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка

$name

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

bool

строка|массив|bool|null option(string|null $key = null)

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

Параметры

строка|null

$key

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

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

массив options()

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

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

массив

логическое значение confirm(строка $question, логическое значение $default = false)

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

Параметры

строка	$question
логическое значение	$default

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

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

смешанное значение ask(строка $question, строка|null $default = null)

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

Параметры

строка	$question
строка\|null	$default

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

смешанное значение

смешанное значение anticipate(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

строка	$question
массив\|вызов	$choices
строка\|null	$default

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

смешанное значение

смешанное значение askWithCompletion(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

строка	$question
массив\|вызов	$choices
строка\|null	$default

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

смешанное значение

смешанное значение secret(строка $question, логическое значение $fallback = true)

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

Параметры

строка	$question
логическое значение	$fallback

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

смешанное значение

строка|массив 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 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

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

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

Parameters

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

Return Value

void

void untrap()

internal

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

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед проверкой ввода.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Содержит ли входные данные какие-либо параметры, отличные от значений по умолчанию.

Parameters

InputInterface

$input

Return Value

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Вмешать другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

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

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

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