ГенераторКоманда
класс ГенераторКоманда расширяет Команда (Просмотреть исходный код)
Трейты
| Макрообъект |
Свойства
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected InputInterface | $input | Реализация интерфейса ввода. | from Command |
| protected OutputStyle | $output | Реализация интерфейса вывода. | from Command |
| protected string | $signature | Имя и сигнатура командной строки. | from Command |
| protected string | $name | Имя команды консоли. | from Command |
| protected string | $description | Описание команды консоли. | from Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected int | $verbosity | Уровень детализации вывода команд по умолчанию. | from Command |
| protected array | $verbosityMap | Сопоставление уровней детализации (человекочитаемый вид) и Symfony OutputInterface. | from Command |
| protected Filesystem | $files | Экземпляр файловой системы. | |
| protected string | $type | Тип класса, который генерируется. |
Методы
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макро. | from Macroable |
| static void | mixin(object $mixin) Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name) Проверить, зарегистрировано ли макро. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы класса. | from Macroable |
| void | __construct(Filesystem $files) Создать новый экземпляр команды создания контроллера. | |
| void | configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent. | from Command |
| void | specifyParameters() Указать аргументы и параметры команды. | from Command |
| int | run(InputInterface $input, OutputInterface $output) Запустить консольную команду. | from Command |
| mixed | execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду. | from Command |
| int | call(string $command, array $arguments = []) Вызвать другую консольную команду. | from Command |
| int | callSilent(string $command, array $arguments = []) Вызвать другую консольную команду в беззвучном режиме. | from Command |
| ArrayInput | createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов. | from Command |
| bool | hasArgument(string|int $name) Определить, присутствует ли данный аргумент. | from Command |
| string|array|null | argument(string|null $key = null) Получить значение аргумента команды. | from Command |
| array | arguments() Получить все аргументы, переданные команде. | from Command |
| bool | hasOption(string $name) Определить, присутствует ли указанный параметр. | from Command |
| string|array|null | option(string|null $key = null) Получить значение параметра команды. | from Command |
| array | options() Получить все параметры, переданные команде. | from Command |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя. | from Command |
| string | ask(string $question, string|null $default = null) Запросить ввод у пользователя. | from Command |
| string | anticipate(string $question, array $choices, string|null $default = null) Запросить ввод у пользователя с автозаполнением. | from Command |
| string | askWithCompletion(string $question, array $choices, string|null $default = null) Запросить ввод у пользователя с автозаполнением. | from Command |
| string | secret(string $question, bool $fallback = true) Запросить ввод у пользователя, но скрыть ответ в консоли. | from Command |
| string | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null) Предоставьте пользователю единственный выбор из массива ответов. | from Command |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать входные данные в таблицу. | from Command |
| void | info(string $string, null|int|string $verbosity = null) Вывести строку как информационное сообщение. | from Command |
| void | line(string $string, string $style = null, null|int|string $verbosity = null) Вывести строку в стандартный вывод. | from Command |
| void | comment(string $string, null|int|string $verbosity = null) Вывести строку как комментарий. | from Command |
| void | question(string $string, null|int|string $verbosity = null) Вывести строку как вопрос. | from Command |
| void | error(string $string, null|int|string $verbosity = null) Вывести строку как сообщение об ошибке. | from Command |
| void | warn(string $string, null|int|string $verbosity = null) Вывести строку как предупреждение. | from Command |
| void | alert(string $string) Вывести строку в всплывающем окне оповещения. | from Command |
| void | setVerbosity(string|int $level) Установить уровень подробности. | from Command |
| int | parseVerbosity(string|int|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony. | from Command |
| array | getArguments() Получить аргументы командной строки. | |
| array | getOptions() Получить параметры командной строки. | from Command |
| OutputInterface | getOutput() Получить реализацию вывода. | from Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | from 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) Получить полное пространство имен для заданного класса, без имени класса. |
| строка | replaceClass(строка $stub, строка $name) Заменить имя класса для данного маркера. | |
| строка | getNameInput() Получить желаемое имя класса из входных данных. | |
| строка | rootNamespace() Получить корневое пространство имён для класса. |
Подробности
статический void macro(строка $name, объект|вызываемый $macro)
Зарегистрировать пользовательский макрос.
статический void mixin(объект $mixin)
Смешать другой объект в класс.
статический логическое значение hasMacro(строка $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
void __construct(Filesystem $files)
Создать новый экземпляр команды создателя контроллера.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
protected void specifyParameters()
Укажите аргументы и параметры команды.
int run(InputInterface $input, OutputInterface $output)
Запустить консольную команду.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить консольную команду.
int call(string $command, array $arguments = [])
Вызвать другую консольную команду.
int callSilent(string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
bool hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент.
string|array|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли заданный параметр.
string|array|null option(string|null $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
string ask(string $question, string|null $default = null)
Запросить ввод у пользователя.
string anticipate(string $question, array $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
string askWithCompletion(string $question, array $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
string 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, null|int|string $verbosity = null)
Вывести строку как информационное сообщение.
void line(string $string, string $style = null, null|int|string $verbosity = null)
Вывести строку в стандартный вывод.
void comment(string $string, null|int|string $verbosity = null)
Вывести строку как комментарий.
void question(string $string, null|int|string $verbosity = null)
Вывести строку как вопрос.
void error(string $string, null|int|string $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, null|int|string $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string)
Вывести строку в виде предупреждения.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить опции команды консоли.
OutputInterface getOutput()
Получить реализацию вывода.
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $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 getNameInput()
Получить желаемое имя класса из ввода.
protected string rootNamespace()
Получить корневое пространство имён для класса.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Console/GeneratorCommand.html
