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