ИнтерфейсMakeCommand
класс InterfaceMakeCommand расширяет GeneratorCommand (Просмотреть исходный код)
Трейты
| 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 | Имя и синтаксис команды консоли. | из Command |
| 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 Filesystem | $files | Экземпляр файловой системы. | из GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | из GeneratorCommand |
Методы
| Команда | 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 |
| ?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() Получить параметры консольной команды. | |
| 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 |
| 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)
Динамически обрабатывает вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу. | from Macroable |
| void | __construct(Filesystem $files)
Создать новый экземпляр команды генерации. | from GeneratorCommand |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | from Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды. | from Command |
| void | fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой. | 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 |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | from GeneratorCommand |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым пространством имен. | from GeneratorCommand |
| string | qualifyModel(string $model)
Определить указанный модель класса базовое имя. | from GeneratorCommand |
| array<int,string> | possibleModels()
Получить список возможных имён моделей. | from GeneratorCommand |
| array<int,string> | possibleEvents()
Получить список возможных имён событий. | from GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace)
Получить пространство имён по умолчанию для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | from GeneratorCommand |
| string | getPath(string $name)
Получить путь к классу назначения. | from GeneratorCommand |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | from GeneratorCommand |
| string | buildClass(string $name)
Создать класс с заданным именем. | from GeneratorCommand |
| $this | replaceNamespace(string $stub, string $name)
Заменить пространство имен для данного шаблона. | from GeneratorCommand |
| string | getNamespace(string $name)
Получить полное пространство имен для заданного класса, без имени класса. | from GeneratorCommand |
| string | replaceClass(string $stub, string $name)
Заменить имя класса для данного шаблона. | from GeneratorCommand |
| string | sortImports(string $stub)
Сортирует импорты для данного шаблона в алфавитном порядке. | from GeneratorCommand |
| string | getNameInput()
Получить желаемое имя класса из ввода. | from GeneratorCommand |
| string | rootNamespace()
Получить корневое пространство имен для класса. | from GeneratorCommand |
| string|null | userProviderModel()
Получить модель для поставщика пользователей по умолчанию. | from GeneratorCommand |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | from GeneratorCommand |
| string | viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения. | из GeneratorCommand |
Подробности
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 configurePrompts(InputInterface $input)
Настроить резервные варианты подсказок.
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Выводить подсказки пользователю, пока не будет выполнено указанное условие валидации.
protected ?string validatePrompt(mixed $value, mixed $rules)
Проверить значение подсказки с использованием валидатора.
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки подсказок.
protected array validationMessages()
Получить сообщения валидации, которые должны использоваться при проверке подсказок.
protected array validationAttributes()
Получить атрибуты валидации, которые следует использовать при проверке подсказок.
protected void restorePrompts()
Восстановить вывод подсказок.
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)
Запросить ввод у пользователя, скрыв ответ в консоли.
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(Filesystem $files)
Создать новый экземпляр команды генератора.
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 getStub()
Получить шаблонный файл для генератора.
bool|null handle()
Выполнить консольную команду.
protected string qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым пространством имён.
protected string qualifyModel(string $model)
Указать полное имя класса модели.
protected array<int,string> possibleModels()
Получить список возможных имён моделей.
protected array<int,string> possibleEvents()
Получить список возможных имён событий.
protected string getDefaultNamespace(string $rootNamespace)
Получить по умолчанию пространство имён для класса.
protected bool alreadyExists(string $rawName)
Определить, существует ли класс.
protected string getPath(string $name)
Получить путь к целевому классу.
protected string makeDirectory(string $path)
Создать директорию для класса, если необходимо.
protected string buildClass(string $name)
Создать класс с заданным именем.
protected $this replaceNamespace(string $stub, string $name)
Заменить пространство имён для данного шаблона.
protected string getNamespace(string $name)
Получить полное пространство имён для данного класса, без имени класса.
protected string replaceClass(string $stub, string $name)
Заменить имя класса для данного шаблона.
protected string sortImports(string $stub)
Сортирует импорты для данного фрагмента в алфавитном порядке.
protected string getNameInput()
Получить желаемое имя класса из ввода.
protected string rootNamespace()
Получить корневое пространство имен для класса.
protected string|null userProviderModel()
Получить модель для поставщика пользователей по умолчанию.
protected bool isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным.
protected string viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/InterfaceMakeCommand.html
