ScopeMakeCommand
класс ScopeMakeCommand расширяет GeneratorCommand (View source)
Свойства
| 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 |
| mixed | promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Подсказывать пользователю, пока не будет пройден заданный обратный вызов валидации. | из 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 |
| 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)
Вывести строку в стандартный вывод. | 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)
Выполнить действия после запроса у пользователя отсутствующих аргументов. | from PromptsForMissingInput |
| 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)
Динамически обработать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обработать вызовы класса. | from Macroable |
| void | __construct(Filesystem $files)
Создать новый экземпляр команды-создателя контроллера. | from GeneratorCommand |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения с плавным переходом. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Выполнить командную строку. | from Команда |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Команда |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команд для команды. | from Команда |
| bool | isHidden() {@inheritdoc} | from Команда |
| Команда | setHidden(bool $hidden = true) {@inheritdoc} | from Команда |
| Приложение | getLaravel()
Получить экземпляр приложения Laravel. | from Команда |
| void | setLaravel(Контейнер $laravel)
Установить экземпляр приложения Laravel. | from Команда |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | from ГенераторКоманд |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства. | from ГенераторКоманд |
| string | qualifyModel(string $model)
Квалифицировать заданное базовое имя класса модели. | from ГенераторКоманд |
| array<int,string> | possibleModels()
Получить список возможных имён моделей. | from ГенераторКоманд |
| array<int,string> | possibleEvents()
Получить список возможных имён событий. | from ГенераторКоманд |
| string | getDefaultNamespace(string $rootNamespace)
Получить имя пространства по умолчанию для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | from ГенераторКоманд |
| string | getPath(string $name)
Получить путь к классу назначения. | from ГенераторКоманд |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | from ГенераторКоманд |
| string | buildClass(string $name)
Создать класс с заданным именем. | from ГенераторКоманд |
| $this | replaceNamespace(string $stub, string $name)
Заменить имя пространства для заданного шаблона. | from ГенераторКоманд |
| string | getNamespace(string $name)
Получить полное имя пространства для заданного класса, без имени класса. | from ГенераторКоманд |
| string | replaceClass(string $stub, string $name)
Заменить имя класса для заданного шаблона. | from ГенераторКоманд |
| string | sortImports(string $stub)
Сортирует импорты по алфавиту для данного шаблона. | from ГенераторКоманд |
| string | getNameInput()
Получить желаемое имя класса из входных данных. | from ГенераторКоманд |
| string | rootNamespace()
Получить корневое пространство имён для класса. | from ГенераторКоманд |
| string|null | userProviderModel()
Получить модель для поставщика пользователей по умолчанию. | from ГенераторКоманд |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | from ГенераторКоманд |
| string | viewPath(string $path = '')
Получить первый путь к каталогу представления из конфигурации приложения. | from ГенераторКоманд |
| 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 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()
Получение экземпляра мьютекса изоляции команды для команды.
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/10.x/Illuminate/Foundation/Console/ScopeMakeCommand.html
