Класс ClassMakeCommand
класс ClassMakeCommand расширяет GeneratorCommand (Просмотреть исходный код)
Трейты
| CallsCommands | |
| ConfiguresPrompts | |
| HasParameters | |
| InteractsWithIO | |
| InteractsWithSignals | |
| PromptsForMissingInput | |
| Macroable |
Свойства
| protected Factory internal | $components | Фабрика компонентов консоли. | из InteractsWithIO |
| protected InputInterface | $input | Реализация интерфейса ввода. | из InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из InteractsWithIO |
| protected int | $verbosity | Уровень детализации вывода команд по умолчанию. | из InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней детализации и уровней Symfony OutputInterface. | из InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | из InteractsWithSignals |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected string | $signature | Имя и синтаксис командной строки. | из Command |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected bool | $isolated | Указывает, может ли выполняться только один экземпляр команды за раз. | из Command |
| protected int | $isolatedExitCode | Код возврата по умолчанию для изолированных команд. | из Command |
| protected array | $aliases | Псевдонимы имени команды консоли. | из Command |
| protected Filesystem | $files | Экземпляр файловой системы. | из GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | из GeneratorCommand |
Методы
| Команда | 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 |
| смешанный | 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()
Получить аргументы консольной команды. | из HasParameters |
| массив | getOptions()
Получить параметры консольной команды. | |
| 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 |
| смешанный | ask(string $question, string|null $default = null)
Задать вопрос пользователю. | из InteractsWithIO |
| смешанный | anticipate(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автозавершением. | из InteractsWithIO |
| смешанный | askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автозавершением. | из InteractsWithIO |
| смешанный | secret(string $question, bool $fallback = true)
Задать вопрос пользователю, но скрыть ответ от консоли. | из InteractsWithIO |
| string|array | 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()
Запрос отсутствующих аргументов ввода, используя возвращенные вопросы. | из PromptsForMissingInput |
| 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)
Создает новый экземпляр команды генератора. | из GeneratorCommand |
| 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()
Выполнить команду консоли. | из GeneratorCommand |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым пространством имен. | из GeneratorCommand |
| string | qualifyModel(string $model)
Отформатировать имя модели в соответствии с заданным пространством имен. | из GeneratorCommand |
| array<int,string> | possibleModels()
Получить список возможных имен моделей. | из GeneratorCommand |
| array<int,string> | possibleEvents()
Получить список возможных имен событий. | из GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace)
Получить пространство имен по умолчанию для класса. | из GeneratorCommand |
| 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)
Заменить имя класса в данном шаблоне. | из GeneratorCommand |
| 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 |
| string | resolveStubPath(string $stub)
Определить полное квалифицированное имя шаблона. |
Подробности
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.
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 = '')
Получить путь к первому каталогу представлений из конфигурации приложения.
protected string resolveStubPath(string $stub)
Получить полностью квалифицированный путь к шаблону.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/ClassMakeCommand.html