ConsoleMakeCommand
class ConsoleMakeCommand extends GeneratorCommand (View source)
Трейты
| CallsCommands | |
| HasParameters | |
| InteractsWithIO | |
| Macroable |
Свойства
| protected InputInterface | $input | Реализация интерфейса ввода. | из InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из InteractsWithIO |
| protected int | $verbosity | Уровень детализации вывода по умолчанию. | из InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней детализации с уровнями Symfony's OutputInterface. | из InteractsWithIO |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected string | $signature | Имя и синтаксис командной строки. | из Command |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string|null | $help | Текст справки по команде консоли. | из Command |
| $hidden | Указывает, следует ли отображать команду в списке команд Artisan. | из Command | |
| protected Filesystem | $files | Экземпляр файловой системы. | из GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected array | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | из GeneratorCommand |
Методы
| Команда | resolveCommand(Command|string $command)
Разрешить экземпляр консольной команды для заданной команды. | из CallsCommands |
| int | call(Command|string $command, array $arguments = [])
Вызвать другую консольную команду. | из CallsCommands |
| int | callSilent(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()
Получить аргументы консольной команды. | |
| массив | getOptions()
Получить параметры консольной команды. | |
| bool | hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент. | из InteractsWithIO |
| string|массив|null | argument(string|null $key = null)
Получить значение аргумента команды. | из InteractsWithIO |
| массив | arguments()
Получить все аргументы, переданные команде. | из InteractsWithIO |
| bool | hasOption(string $name)
Определить, присутствует ли заданный параметр. | из InteractsWithIO |
| string|массив|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|массив | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю выбрать один вариант из массива ответов. | из InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу. | из 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)
Вывести строку в всплывающем окне. | из 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 |
| 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 mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу. | из Macroable |
| void | __construct(Filesystem $files)
Создать новый экземпляр команды создания контроллера. | из GeneratorCommand |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| isHidden() {@inheritdoc} | из Command | |
| setHidden(bool $hidden) {@inheritdoc} | из Command | |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | из Command |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | из GeneratorCommand |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства. | из GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace)
Получить стандартное пространство имен для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | из GeneratorCommand |
| string | getPath(string $name)
Получить путь класса назначения. | из GeneratorCommand |
| string | makeDirectory(string $path)
Создать каталог для класса, если необходимо. | из GeneratorCommand |
| string | buildClass(string $name)
Создать класс с заданным именем. | из GeneratorCommand |
| $this | replaceNamespace(string $stub, string $name)
Заменить пространство имен для заданного шаблона. | из GeneratorCommand |
| string | getNamespace(string $name)
Получить полное имя пространства для заданного класса, без имени класса. | из GeneratorCommand |
| string | replaceClass(string $stub, string $name)
Заменить имя класса для заданного шаблона. | |
| string | sortImports(string $stub)
Сортирует импорты по алфавиту для данного шаблона. | из GeneratorCommand |
| string | getNameInput()
Получить желаемое имя класса из ввода. | из GeneratorCommand |
| string | rootNamespace()
Получить корневое пространство имен для класса. | из GeneratorCommand |
| string|null | userProviderModel()
Получить модель для модели поставщика пользователей по умолчанию. | из GeneratorCommand |
| bool | isReservedName(string $name) Проверяет, является ли данное имя зарезервированным. | из 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 = [])
Вызвать другую команду консоли без вывода.
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)
Определить, присутствует ли указанный аргумент.
string|array|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 = 'default', массив $columnStyles = [])
Форматировать ввод в текстовую таблицу.
пустое значение 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)
Вывести строку в всплывающем окне.
пустое значение setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
пустое значение setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected пустое значение setVerbosity(строка|целое число $level)
Установить уровень подробности.
protected целое число parseVerbosity(строка|целое число|null $level = null)
Получить уровень подробности с точки зрения уровня Symfony's OutputInterface.
OutputStyle getOutput()
Получить реализацию вывода.
статический пустое значение macro(строка $name, объект|вызываемый $macro)
Зарегистрировать пользовательскую макрокоманду.
статический пустое значение mixin(объект $mixin, логическое $replace = true)
Смешать другой объект в класс.
статический логическое значение hasMacro(строка $name)
Проверяет, зарегистрирована ли макрокоманда.
статический смешанный __callStatic(строка $method, массив $parameters)
Динамически обрабатывать вызовы класса.
смешанный __call(строка $method, массив $parameters)
Динамически обрабатывать вызовы класса.
void __construct(Filesystem $files)
Создать новый экземпляр команды генератора контроллера.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения Fluent.
int run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
isHidden()
{@inheritdoc}
setHidden(bool $hidden)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected string getStub()
Получить шаблонный файл для генератора.
bool|null handle()
Выполнить команду консоли.
protected string qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства имён.
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/7.x/Illuminate/Foundation/Console/ConsoleMakeCommand.html
