ShowModelCommand
class ShowModelCommand extends DatabaseInspectionCommand (View source)
Трейты
| CallsCommands | |
| ConfiguresPrompts | |
| 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 | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | from Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected bool | $isolated | Указывает, может ли одновременно выполняться только одна копия команды. | from Command |
| protected int | $isolatedExitCode | Код выхода по умолчанию для изолированных команд. | from Command |
| protected array | $aliases | Псевдонимы имени команды консоли. | from Command |
| protected array | $typeMappings | Карта типов столбцов базы данных. | from DatabaseInspectionCommand |
| protected Composer | $composer | Экземпляр Composer. | from DatabaseInspectionCommand |
| protected array | $relationMethods | Методы, которые можно вызвать в модели для указания связи. |
Методы
| Команда | 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)
Запустить команду консоли. | from Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команд для команды. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | from Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | from Command |
| void | registerTypeMappings(AbstractPlatform $platform)
Зарегистрировать настраиваемые сопоставления типов Doctrine для команд проверки БД. | from DatabaseInspectionCommand |
| string | getPlatformName(AbstractPlatform $platform, string $database)
Получить удобочитаемое имя платформы для данной платформы. | from DatabaseInspectionCommand |
| int|null | getTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы в байтах. | from DatabaseInspectionCommand |
| mixed | getMySQLTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы MySQL в байтах. | from DatabaseInspectionCommand |
| mixed | getPostgresTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы Postgres в байтах. | from DatabaseInspectionCommand |
| mixed | getSqliteTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы SQLite в байтах. | from DatabaseInspectionCommand |
| int|null | getConnectionCount(ConnectionInterface $connection)
Получить количество открытых подключений для базы данных. | from DatabaseInspectionCommand |
| array | getConfigFromDatabase(string $database)
Получить детали конфигурации подключения для указанного подключения. | from DatabaseInspectionCommand |
| bool | ensureDependenciesExist()
Убедиться в наличии зависимостей для команд базы данных. | from DatabaseInspectionCommand |
| void | installDependencies()
Установить зависимости команды. | from DatabaseInspectionCommand |
| int | handle()
Выполнить команду консоли. | |
| string | getPolicy(Model $model)
Получить первую политику, связанную с этой моделью. | |
| Collection | getAttributes(Model $model)
Получить атрибуты столбцов для данной модели. | |
| Collection | getVirtualAttributes(Model $model, Column[] $columns)
Получить виртуальные (не столбец) атрибуты для данной модели. | |
| Collection | getRelations(Model $model)
Получить отношения из заданной модели. | |
| Collection | getObservers(Model $model)
Получить наблюдателей, отслеживающих эту модель. | |
| void | display(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели. | |
| void | displayJson(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели в формате JSON. | |
| void | displayCli(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели для консоли. | |
| string|null | getCastType(string $column, Model $model)
Получить тип преобразования для заданного столбца. |
| Коллекция | getCastsWithDates(Модель $model)
Получить атрибуты модели, включая атрибуты даты. | |
| строка | getColumnType(Column $column)
Получить тип заданного столбца. | |
| смешанное|null | getColumnDefault(Column $column, Модель $model)
Получить значение по умолчанию для заданного столбца. | |
| логическое | attributeIsHidden(строка $attribute, Модель $model)
Определить, скрыт ли заданный атрибут. | |
| логическое | columnIsUnique(строка $column, Index[] $indexes)
Определить, является ли заданный атрибут уникальным. | |
| строка | qualifyModel(строка $model)
Определить полное имя заданной модели. |
Подробности
abstract protected Команда resolveCommand(Команда|строка $command)
Разрешить экземпляр команды консоли для данной команды.
целое число call(Команда|строка $command, массив $arguments = [])
Вызвать другую команду консоли.
целое число callSilent(Команда|строка $command, массив $arguments = [])
Вызвать другую команду консоли без вывода.
целое число callSilently(Команда|строка $command, массив $arguments = [])
Вызвать другую команду консоли без вывода.
protected целое число runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)
Выполнить заданную команду консоли.
protected ArrayInput createInputFromArguments(массив $arguments)
Создать экземпляр ввода из заданных аргументов.
protected массив context()
Получить весь контекст, переданный команде.
protected пустое значение configurePrompts(InputInterface $input)
Настроить отступы вывода запроса.
protected смешанное promptUntilValid(Closure $prompt, bool|строка $required, Closure|null $validate)
Запрашивать у пользователя, пока не будет пройден заданный обратный вызов валидации.
protected пустое значение restorePrompts()
Восстановить вывод запросов.
protected пустое значение specifyParameters()
Указать аргументы и параметры команды.
protected массив getArguments()
Получить аргументы команды консоли.
protected массив getOptions()
Получить параметры команды консоли.
логическое hasArgument(строка|целое число $name)
Определить, присутствует ли данный аргумент.
массив|строка|логическое|null argument(строка|null $key = null)
Получить значение аргумента команды.
массив arguments()
Получить все аргументы, переданные команде.
логическое hasOption(строка $name)
Определить, присутствует ли данный параметр.
строка|массив|логическое|null option(строка|null $key = null)
Получить значение параметра команды.
массив options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
mixed ask(string $question, string|null $default = null)
Запросить ввод от пользователя.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Запросить ввод от пользователя с автозаполнением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить ввод от пользователя с автозаполнением.
mixed secret(string $question, bool $fallback = true)
Запросить ввод от пользователя, но скрыть ответ из консоли.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю единственный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, одновременно продвигая индикатор прогресса.
void info(string $string, int|string|null $verbosity = null)
Вывести строку как информацию.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку как стандартный вывод.
void comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий.
void question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос.
void error(string $string, int|string|null $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string, int|string|null $verbosity = null)
Вывести строку в окне сообщения об ошибке.
$this newLine(int $count = 1)
Напечатать пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
Factory outputComponents()
Получить реализацию фабрики компонентов вывода.
trap($signals, $callback)
Без описания
void untrap()
| internal |
Отменить обработчики сигналов, установленные в обработчике команды.
protected void interact(InputInterface $input, OutputInterface $output)
Взаимодействовать с пользователем до валидации ввода.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запросить у пользователя отсутствующие аргументы.
protected array promptForMissingArgumentsUsing()
Запрашивать отсутствующие аргументы ввода, используя возвращаемые вопросы.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнить действия после запроса у пользователя отсутствующих аргументов.
protected bool didReceiveOptions(InputInterface $input)
Указывает, содержит ли ввод какие-либо параметры, отличающиеся от значений по умолчанию.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin, bool $replace = true)
Вставить другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
void __construct(Composer $composer = null)
Создать новый экземпляр команды.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения с плавным переходом.
protected void configureIsolation()
Настроить команду консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команд для команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected void registerTypeMappings(AbstractPlatform $platform)
Зарегистрировать пользовательские сопоставления типов Doctrine для команд проверки.
protected string getPlatformName(AbstractPlatform $platform, string $database)
Получить удобочитаемое имя платформы для заданной платформы.
protected int|null getTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы в байтах.
protected mixed getMySQLTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы MySQL в байтах.
protected mixed getPostgresTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы Postgres в байтах.
protected mixed getSqliteTableSize(ConnectionInterface $connection, string $table)
Получить размер таблицы SQLite в байтах.
protected int|null getConnectionCount(ConnectionInterface $connection)
Получить количество открытых подключений к базе данных.
protected array getConfigFromDatabase(string $database)
Получить сведения о конфигурации подключения для заданного подключения.
protected bool ensureDependenciesExist()
Убедиться в наличии зависимостей для команд базы данных.
protected void installDependencies()
Установить зависимости команды.
int handle()
Выполнить команду консоли.
protected string getPolicy(Model $model)
Получить первую политику, связанную с этой моделью.
protected Collection getAttributes(Model $model)
Получить атрибуты столбцов для заданной модели.
protected Коллекция getVirtualAttributes(Модель $model, Column[] $columns)
Получить виртуальные (не являющиеся столбцами) атрибуты для данной модели.
protected void display(string $class, string $database, string $table, string $policy, Коллекция $attributes, Коллекция $relations, Коллекция $observers)
Отобразить информацию о модели.
protected void displayJson(string $class, string $database, string $table, string $policy, Коллекция $attributes, Коллекция $relations, Коллекция $observers)
Отобразить информацию о модели в формате JSON.
protected void displayCli(string $class, string $database, string $table, string $policy, Коллекция $attributes, Коллекция $relations, Коллекция $observers)
Отобразить информацию о модели в консоли.
protected string|null getCastType(string $column, Модель $model)
Получить тип преобразования для указанного столбца.
protected Коллекция getCastsWithDates(Модель $model)
Получить преобразования модели, включая преобразования дат.
protected string getColumnType(Column $column)
Получить тип заданного столбца.
protected mixed|null getColumnDefault(Column $column, Модель $model)
Получить значение по умолчанию для указанного столбца.
protected bool attributeIsHidden(string $attribute, Модель $model)
Определить, скрыт ли данный атрибут.
protected bool columnIsUnique(string $column, Index[] $indexes)
Определить, является ли данный атрибут уникальным.
protected string qualifyModel(string $model)
Указать полное имя класса заданной модели.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Console/ShowModelCommand.html