ShowModelCommand
класс ShowModelCommand расширяет DatabaseInspectionCommand (Просмотреть исходный код)
Трейты
| 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 | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected bool | $isolated | Указывает, может ли выполняться только один экземпляр команды в данный момент. | из Command |
| protected int | $isolatedExitCode | Код завершения по умолчанию для изолированных команд. | из Command |
| protected array | $aliases | Псевдонимы имен команд консоли. | из Command |
| 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 |
| смешанный | promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate) Запрашивать у пользователя данные до тех пор, пока обратный вызов проверки не пройдет. | из ConfiguresPrompts |
| ?string | validatePrompt(mixed $value, mixed $rules) Проверить заданное значение подсказки с помощью валидатора. | из ConfiguresPrompts |
| Validator | getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = []) Получить экземпляр валидатора, который должен использоваться для проверки подсказок. | из ConfiguresPrompts |
| массив | validationMessages() Получить сообщения об ошибках валидации, которые должны использоваться при проверке подсказок. | из ConfiguresPrompts |
| массив | validationAttributes() Получить атрибуты валидации, которые должны использоваться при проверке подсказок. | из 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 |
| смешанный | ask(string $question, string|null $default = null) Запросить у пользователя ввод. | из InteractsWithIO |
| смешанный | anticipate(string $question, array|callable $choices, string|null $default = null) Запросить у пользователя ввод с автозаполнением. | из InteractsWithIO |
| смешанный | askWithCompletion(string $question, array|callable $choices, string|null $default = null) Запросить у пользователя ввод с автозаполнением. | из InteractsWithIO |
| смешанный | secret(string $question, bool $fallback = true) Запросить у пользователя ввод, но скрыть ответ в консоли. | из InteractsWithIO |
| string|array | 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()
Создать новый экземпляр команды консоли. | из Command |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения Fluent. | из Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | из Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды. | из Command |
| void | fail(Throwable|string|null $exception = null)
Отказать команду вручную. | из Command |
| bool | isHidden() {@inheritdoc} | из Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | из Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | из Command |
| string | getConnectionName(ConnectionInterface $connection, string $database)
Получить удобочитаемое имя для заданного соединения. | из DatabaseInspectionCommand |
| int|null | getConnectionCount(ConnectionInterface $connection)
Получить количество открытых соединений для базы данных. | из DatabaseInspectionCommand |
| array | getConfigFromDatabase(string $database)
Получить подробности конфигурации соединения для заданного соединения. | из DatabaseInspectionCommand |
| string | withoutTablePrefix(ConnectionInterface $connection, string $table)
Удалить префикс таблицы из имени таблицы, если он существует. | из DatabaseInspectionCommand |
| int | handle()
Выполнить команду консоли. | |
| string | getPolicy(Model $model)
Получить первую политику, связанную с этой моделью. | |
| Collection | getAttributes(Model $model)
Получить атрибуты столбцов для данной модели. | |
| Collection | getVirtualAttributes(Model $model, array $columns)
Получить виртуальные (не столбцы) атрибуты для данной модели. | |
| Collection | getRelations(Model $model)
Получить отношения из данной модели. | |
| Collection | getEvents(Model $model)
Получить события, которые отправляет модель. | |
| Collection | getObservers(Model $model)
Получить наблюдателей, отслеживающих эту модель. | |
| void | display(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели. | |
| void | displayJson(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели в формате JSON. | |
| void | displayCli(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели для командной строки. | |
| string|null | getCastType(string $column, Model $model)
Получить тип преобразования для заданного столбца. |
| Коллекция | getCastsWithDates(Модель $model)
Получить преобразования модели, включая преобразования дат. | |
| смешанный|null | getColumnDefault(массив $column, Модель $model)
Получить значение по умолчанию для заданного столбца. | |
| bool | attributeIsHidden(строка $attribute, Модель $model)
Определить, скрыт ли заданный атрибут. | |
| bool | columnIsUnique(строка $column, массив $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|string $required, Closure|null $validate)
Предложить пользователю, пока не будет выполнено заданное условие проверки.
protected ?строка validatePrompt(смешанный $value, смешанный $rules)
Проверить заданное значение подсказки с помощью валидатора.
protected Валидатор getPromptValidatorInstance(смешанный $field, смешанный $value, смешанный $rules, массив $messages = [], массив $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки подсказок.
protected массив validationMessages()
Получить сообщения об ошибках валидации, которые следует использовать при проверке подсказок.
protected массив validationAttributes()
Получить атрибуты валидации, которые следует использовать при проверке подсказок.
protected пустое значение restorePrompts()
Восстановить вывод подсказок.
protected пустое значение specifyParameters()
Указать аргументы и параметры команды.
protected массив getArguments()
Получить аргументы команды консоли.
protected массив getOptions()
Получить параметры команды консоли.
bool hasArgument(строка|целое число $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)
Запросить ввод у пользователя, скрывая ответ в консоли.
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()
Создать новый экземпляр команды консоли.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
protected void configureIsolation()
Настроить команду консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команд для команды.
void fail(Throwable|string|null $exception = null)
Принудительно завершить выполнение команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected string getConnectionName(ConnectionInterface $connection, string $database)
Получить удобочитаемое имя для данного подключения.
protected int|null getConnectionCount(ConnectionInterface $connection)
Получить количество открытых подключений для базы данных.
protected array getConfigFromDatabase(string $database)
Получить детали конфигурации подключения для заданного подключения.
protected string withoutTablePrefix(ConnectionInterface $connection, string $table)
Удалить префикс таблицы из имени таблицы, если он существует.
int handle()
Выполнить команду консоли.
protected string getPolicy(Model $model)
Получить первую политику, связанную с этой моделью.
protected Collection getAttributes(Model $model)
Получить атрибуты столбцов для данной модели.
protected Collection getVirtualAttributes(Model $model, array $columns)
Получить виртуальные (не столбцовые) атрибуты для данной модели.
protected Collection getRelations(Model $model)
Получить отношения из заданной модели.
protected Collection getEvents(Model $model)
Получить события, которые отправляет модель.
protected Collection getObservers(Model $model)
Получить наблюдателей, отслеживающих эту модель.
protected void display(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели.
protected void displayJson(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели в формате JSON.
protected void displayCli(string $class, string $database, string $table, string $policy, Collection $attributes, Collection $relations, Collection $events, Collection $observers)
Отобразить информацию о модели в командной строке.
protected string|null getCastType(string $column, Model $model)
Получить тип преобразования для заданного столбца.
protected Collection getCastsWithDates(Model $model)
Получить типы преобразования модели, включая любые преобразования дат.
protected mixed|null getColumnDefault(array $column, Model $model)
Получить значение по умолчанию для заданного столбца.
protected bool attributeIsHidden(string $attribute, Model $model)
Определить, скрыт ли заданный атрибут.
protected bool columnIsUnique(string $column, array $indexes)
Определить, является ли заданный атрибут уникальным.
protected string qualifyModel(string $model)
Определить заданный класс модели.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/ShowModelCommand.html