ShowModelCommand
class ShowModelCommand extends DatabaseInspectionCommand (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 | Подпись команды консоли. | |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected array | $typeMappings | Карта типов столбцов базы данных. | из DatabaseInspectionCommand |
| protected Composer | $composer | Экземпляр Composer. | из DatabaseInspectionCommand |
| static protected string|null deprecated | $defaultName | Имя команды консоли. | |
| 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 | 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)
Создать новый экземпляр команды. | из 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 |
| Команда | 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() Установить зависимости команды. | из Команды проверки базы данных |
| void | handle() Выполнить команду консоли. | |
| Collection | getPolicy(Модель $model) Получить первую политику, связанную с этой моделью. | |
| Collection | getAttributes(Модель $model) Получить атрибуты столбцов для данной модели. | |
| Collection | getVirtualAttributes(Модель $model, Column[] $columns) Получить виртуальные (не столбцовые) атрибуты для данной модели. | |
| Collection | getRelations(Модель $model) Получить отношения из данной модели. | |
| Collection | getObservers(Модель $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) Получить тип преобразования для данного столбца. | |
| Collection | getCastsWithDates(Модель $model) Получить преобразования модели, включая преобразования дат. | |
| string | getColumnType(Column $column) Получить тип данного столбца. | |
| mixed|null | getColumnDefault(Column $column, Модель $model) Получить значение по умолчанию для данного столбца. | |
| bool | attributeIsHidden(string $attribute, Модель $model) Определить, скрыт ли данный атрибут. |
| bool | columnIsUnique(string $column, Index[] $indexes)
Определить, является ли заданный атрибут уникальным. | |
| string | qualifyModel(string $model)
Квалифицировать заданное имя базового класса модели. |
Подробности
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр команды консоли для данной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
int callSilently(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Запустить заданную команду консоли.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
protected void specifyParameters()
Указать аргументы и параметры команды.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить параметры команды консоли.
bool hasArgument(string|int $name)
Определить, присутствует ли данный аргумент.
array|string|bool|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данный параметр.
string|array|bool|null option(string|null $key = null)
Получить значение параметра команды.
array 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)
Запросить у пользователя ввод, но скрыть ответ в консоли.
строка|массив choice(строка $question, массив $choices, строка|целое|null $default = null, смешанный|null $attempts = null, булево $multiple = false)
Предложить пользователю единственный выбор из массива ответов.
пусто table(массив $headers, Arrayable|массив $rows, TableStyle|строка $tableStyle = 'default', массив $columnStyles = [])
Форматировать входные данные в текстовую таблицу.
смешанный|пусто withProgressBar(iterable|целое $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, продвигая полосу прогресса.
пусто info(строка $string, целое|строка|null $verbosity = null)
Вывести строку как информацию.
пусто line(строка $string, строка|null $style = null, целое|строка|null $verbosity = null)
Вывести строку в стандартный вывод.
пусто comment(строка $string, целое|строка|null $verbosity = null)
Вывести строку как комментарий.
пусто question(строка $string, целое|строка|null $verbosity = null)
Вывести строку как вопрос.
пусто error(строка $string, целое|строка|null $verbosity = null)
Вывести строку как ошибку.
пусто warn(строка $string, целое|строка|null $verbosity = null)
Вывести строку как предупреждение.
пусто alert(строка $string, целое|строка|null $verbosity = null)
Вывести строку в окне предупреждения.
$this newLine(целое $count = 1)
Написать пустую строку.
пусто setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
пусто setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected пусто setVerbosity(строка|целое $level)
Установить уровень подробности.
protected целое parseVerbosity(строка|целое|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
пусто trap(iterable<array-key,int>|целое $signals, $callback)
Определить обратный вызов, который будет выполнен при возникновении указанного(ых) сигнала(ов).
пусто untrap()
| internal |
Убрать обработчики сигналов, установленные в обработчике команды.
protected пусто 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()
Настроить команду консоли с помощью определения fluent.
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()
Установить зависимости команды.
void handle()
Выполнить команду консоли.
protected Collection getPolicy(Model $model)
Получить первую политику, связанную с этой моделью.
protected Collection getAttributes(Model $model)
Получить атрибуты столбца для заданной модели.
protected Collection getVirtualAttributes(Model $model, Column[] $columns)
Получить виртуальные (не столбец) атрибуты для данной модели.
protected Collection getRelations(Model $model)
Получить отношения из заданной модели.
protected Collection getObservers(Model $model)
Получить наблюдателей, отслеживающих эту модель.
protected void display(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели.
protected void displayJson(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели как JSON.
protected void displayCli(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $observers)
Отобразить информацию о модели для консоли.
protected string|null getCastType(string $column, Model $model)
Получить тип преобразования для заданного столбца.
protected Collection getCastsWithDates(Model $model)
Получить преобразования модели, включая преобразования дат.
protected string getColumnType(Column $column)
Получить тип заданного столбца.
protected mixed|null getColumnDefault(Column $column, Model $model)
Получить значение по умолчанию для заданного столбца.
protected bool attributeIsHidden(string $attribute, Model $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/9.x/Illuminate/Foundation/Console/ShowModelCommand.html