Команда генерации
абстрактный класс GeneratorCommand расширяет Command (Просмотреть исходный код)
Трейты
| Вызов команд | |
| Имеет параметры | |
| Взаимодействие с вводом/выводом | |
| Macroable |
Свойства
| protected InputInterface | $input | Реализация интерфейса ввода. | из Взаимодействие с вводом/выводом |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из Взаимодействие с вводом/выводом |
| protected int | $verbosity | Уровень детализации вывода по умолчанию. | из Взаимодействие с вводом/выводом |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface. | из Взаимодействие с вводом/выводом |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Команда |
| protected string | $signature | Имя и сигнатура команды консоли. | из Команда |
| protected string | $name | Имя команды консоли. | из Команда |
| protected string|null | $description | Описание команды консоли. | из Команда |
| protected string|null | $help | Текст справки команды консоли. | из Команда |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Команда | |
| protected Filesystem | $files | Экземпляр файловой системы. | |
| protected string | $type | Тип генерируемого класса. |
Методы
| Команда | 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()
Получить параметры команды консоли. | из HasParameters |
| 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|null $multiple = null)
Предложить пользователю выбрать один вариант из массива ответов. | из 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)
Создать новый экземпляр команды-создателя контроллера. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | из Command |
| mixed | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| isHidden() {@inheritdoc} | из Command | |
| setHidden($hidden) {@inheritdoc} | из Command | |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | из Command |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства. | |
| string | getDefaultNamespace(string $rootNamespace)
Получить имя пространства по умолчанию для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | |
| string | getPath(string $name)
Получить путь к целевому классу. | |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | |
| string | buildClass(string $name)
Построить класс с заданным именем. | |
| $this | replaceNamespace(string $stub, string $name)
Заменить имя пространства для заданного шаблона. | |
| string | getNamespace(string $name)
Получить полное имя пространства для данного класса без имени класса. | |
| string | replaceClass(string $stub, string $name)
Заменить имя класса для заданного шаблона. | |
| string | sortImports(string $stub)
Сортирует импорты по алфавиту для данного шаблона. | |
| string | getNameInput()
Получить желаемое имя класса из входных данных. | |
| string | rootNamespace()
Получить корневое имя пространства для класса. | |
| string|null | userProviderModel()
Получить модель для модели поставщика пользователей по умолчанию. |
Подробности
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)
Задать вопрос пользователю, скрыв ответ в консоли.
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)
Предложить пользователю один вариант ответа из массива.
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматировать входные данные в текстовую таблицу.
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)
Вывести строку в всплывающем окне предупреждения.
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()
Получить реализацию вывода.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макрос.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
void __construct(Filesystem $files)
Создать новый экземпляр команды контроллера.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
isHidden()
{@inheritdoc}
setHidden($hidden)
{@inheritdoc}
Приложение getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Контейнер $laravel)
Установить экземпляр приложения Laravel.
abstract 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()
Получить модель для поставщика пользователей по умолчанию.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Console/GeneratorCommand.html
