GeneratorCommand
абстрактный класс GeneratorCommand расширяет Command, реализует PromptsForMissingInput (View source)
Свойства
| CallsCommands | |
| ConfiguresPrompts | |
| HasParameters | |
| InteractsWithIO | |
| InteractsWithSignals | |
| PromptsForMissingInput | |
| Macroable |
Свойства
| protected Factory internal | $components | Фабрика компонентов консоли. | from InteractsWithIO |
| protected InputInterface | $input | Реализация интерфейса ввода. | from InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | from InteractsWithIO |
| protected int | $verbosity | Уровень детализации вывода команд по умолчанию. | from InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface. | from InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | from InteractsWithSignals |
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected string | $signature | Имя и сигнатура команды консоли. | from Command |
| protected string | $name | Имя команды консоли. | from Command |
| protected string|null | $description | Описание команды консоли. | from Command |
| protected string | $help | Текст справки команды консоли. | from Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected bool | $isolated | Указывает, может ли выполняться только одна копия команды в данный момент. | from Command |
| protected int | $isolatedExitCode | Кодовое значение выхода по умолчанию для изолированных команд. | from Command |
| protected array | $aliases | Псевдонимы имен команд консоли. | from Command |
| protected Filesystem | $files | Экземпляр файловой системы. | |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. |
Методы
| Команда | 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()
Получить аргументы консольной команды. | |
| массив | getOptions()
Получить параметры консольной команды. | из HasParameters |
| 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 |
| строка|массив | 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()
Запросить отсутствующие входные аргументы, используя возвращаемые вопросы. | |
| 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)
Динамически обрабатывать вызовы класса. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса. | из Macroable |
| void | __construct(Filesystem $files)
Создать новый экземпляр команды генератора. |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения в стиле fluent. | из Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды. | из Command |
| void | fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой. | из Command |
| bool | isHidden() {@inheritdoc} | из Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | из Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | из Command |
| string | getStub()
Получить шаблон файла для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | |
| string | qualifyClass(string $name)
Разбор имени класса и форматирование в соответствии с корневым пространством имён. | |
| string | qualifyModel(string $model)
Определить заданный базовый класс модели. | |
| array<int,string> | possibleModels()
Получить список возможных имён моделей. | |
| array<int,string> | possibleEvents()
Получить список возможных имён событий. | |
| 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()
Получить модель для провайдера пользователей по умолчанию. | |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | |
| string | viewPath(string $path = '')
Получить первый путь к каталогу представлений из конфигурации приложения. |
Details
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.
abstract 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/Console/GeneratorCommand.html
