ControllerMakeCommand
class ControllerMakeCommand extends GeneratorCommand (View source)
Свойства
| CreatesMatchingTest | |
| 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 | Сопоставление удобочитаемых уровней подробности с уровнями OutputInterface Symfony. | 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 | Имя консольной команды. | |
| protected string | $description | Описание консольной команды. | |
| 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 | Экземпляр файловой системы. | from GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | from 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)
Предложите пользователю один вариант из массива ответов. | from InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматирует входные данные в текстовую таблицу. | from InteractsWithIO |
| mixed|void | withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполняет заданный обратный вызов с отображением полосы прогресса. | from InteractsWithIO |
| void | info(string $string, int|string|null $verbosity = null)
Выводит строку как информационное сообщение. | from InteractsWithIO |
| void | line(string $string, string|null $style = null, int|string|null $verbosity = null)
Выводит строку в стандартный вывод. | from InteractsWithIO |
| void | comment(string $string, int|string|null $verbosity = null)
Выводит строку как комментарий. | from InteractsWithIO |
| void | question(string $string, int|string|null $verbosity = null)
Выводит строку как вопрос. | from InteractsWithIO |
| void | error(string $string, int|string|null $verbosity = null)
Выводит строку как сообщение об ошибке. | from InteractsWithIO |
| void | warn(string $string, int|string|null $verbosity = null)
Выводит строку как предупреждение. | from InteractsWithIO |
| void | alert(string $string, int|string|null $verbosity = null)
Выводит строку в окне предупреждения. | from InteractsWithIO |
| $this | newLine(int $count = 1)
Выводит пустую строку. | from InteractsWithIO |
| void | setInput(InputInterface $input)
Устанавливает реализацию интерфейса ввода. | from InteractsWithIO |
| void | setOutput(OutputStyle $output)
Устанавливает реализацию интерфейса вывода. | from InteractsWithIO |
| void | setVerbosity(string|int $level)
Устанавливает уровень подробности. | from InteractsWithIO |
| int | parseVerbosity(string|int|null $level = null)
Возвращает уровень подробности в терминах уровня OutputInterface Symfony. | from InteractsWithIO |
| OutputStyle | getOutput()
Возвращает реализацию вывода. | from InteractsWithIO |
| Factory | outputComponents()
Возвращает реализацию фабрики компонентов вывода. | from InteractsWithIO |
| trap($signals, $callback) Без описания | from InteractsWithSignals | |
| void | untrap()
Отменяет обработчики сигналов, установленные в обработчике команды. | from InteractsWithSignals |
| void | interact(InputInterface $input, OutputInterface $output)
Взаимодействует с пользователем до валидации ввода. | from PromptsForMissingInput |
| void | promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запрашивает у пользователя отсутствующие аргументы. | from PromptsForMissingInput |
| array | promptForMissingArgumentsUsing()
Запрашивает отсутствующие аргументы ввода, используя возвращенные вопросы. | from PromptsForMissingInput |
| void | afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполняет дальнейшее взаимодействие с пользователем, если были запрошены отсутствующие аргументы. | |
| bool | didReceiveOptions(InputInterface $input)
Определяет, содержит ли ввод какие-либо параметры, отличные от значений по умолчанию. | from PromptsForMissingInput |
| static void | macro(string $name, object|callable $macro)
Регистрирует пользовательское макро. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Добавляет другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрировано ли макро. | from Macroable |
| static void | flushMacros()
Очищает существующие макросы. | from 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)
Получить стандартное пространство имён для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | из GeneratorCommand |
| string | getPath(string $name)
Получить путь к классу назначения. | из GeneratorCommand |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | из GeneratorCommand |
| string | buildClass(string $name)
Создать класс с указанным именем. | |
| $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 = '')
Получить путь к первому каталогу представлений из конфигурации приложения. | from GeneratorCommand |
| void | addTestOptions()
Добавить стандартные параметры команды для генерации соответствующих тестов. | from CreatesMatchingTest |
| bool | handleTestCreation(string $path)
Создать соответствующий тестовый случай, если запрошено. | from CreatesMatchingTest |
| string | resolveStubPath(string $stub)
Определить полный путь к шаблону. | |
| array | buildParentReplacements()
Сформировать замены для родительского контроллера. | |
| array | buildModelReplacements(array $replace)
Сформировать значения замены для модели. | |
| string | parseModel(string $model)
Получить полное имя класса модели. | |
| array | buildFormRequestReplacements(array $replace, string $modelClass)
Сформировать значения замены для запроса формы. | |
| array | generateFormRequests(string $modelClass, string $storeRequestClass, string $updateRequestClass)
Сгенерировать запросы формы для заданной модели и классов. |
Подробности
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)
Динамически обрабатывать вызовы класса.
смешанный тип __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 строка buildClass(строка $name)
Создать класс с заданным именем.
Удалить импорт базового контроллера, если мы уже находимся в базовом пространстве имён.
protected $this replaceNamespace(строка $stub, строка $name)
Заменить пространство имён для заданного фрагмента.
protected строка getNamespace(строка $name)
Получить полное пространство имён для данного класса, без имени класса.
protected строка replaceClass(строка $stub, строка $name)
Заменить имя класса для заданного фрагмента.
protected строка sortImports(строка $stub)
Сортирует импорты по алфавиту для заданного фрагмента.
protected строка getNameInput()
Получить желаемое имя класса из ввода.
protected строка rootNamespace()
Получить корневое пространство имён для класса.
protected строка|null userProviderModel()
Получить модель для поставщика пользователей по умолчанию.
protected логическое isReservedName(строка $name)
Проверяет, является ли данное имя зарезервированным.
protected строка viewPath(строка $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения.
protected пустое addTestOptions()
Добавить стандартные параметры команды для генерации соответствующих тестов.
protected логическое handleTestCreation(строка $path)
Создать соответствующий тест-кейс, если требуется.
protected строка resolveStubPath(строка $stub)
Определить полное квалифицированное имя пути к фрагменту.
protected массив buildParentReplacements()
Создать замены для родительского контроллера.
protected массив buildModelReplacements(массив $replace)
Создать значения замены для модели.
protected строка parseModel(строка $model)
Получить полное квалифицированное имя класса модели.
protected массив buildFormRequestReplacements(массив $replace, строка $modelClass)
Создать значения замены для модели.
protected массив generateFormRequests(строка $modelClass, строка $storeRequestClass, строка $updateRequestClass)
Сгенерировать запросы формы для заданной модели и классов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Routing/Console/ControllerMakeCommand.html
