GeneratorCommand

абстрактный класс GeneratorCommand расширяет Command и реализует PromptsForMissingInput (Просмотреть исходный код)

Трейты

CallsCommands

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	Имя команды консоли.	из Command
protected string\|null	$description	Описание команды консоли.	из Command
protected string	$help	Текст справки команды консоли.	из Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из 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	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) Вывести строку в всплывающем окне.	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) Получить уровень подробности с точки зрения уровня Symfony's OutputInterface.	from InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	from InteractsWithIO
void	trap(iterable<array-key,int>\|int $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() Запрашивать отсутствующие аргументы ввода, используя возвращенные вопросы.
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) Создать новый экземпляр команды создателя контроллера.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	from Command
void	configureIsolation() Настроить команду консоли для изоляции.	from Command
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	from Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команд для команды.	from Command
bool	isHidden() {@inheritdoc}	from Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from 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 = '') Получение первого пути к директории представлений из конфигурации приложения.

Подробности

abstract protected Команда resolveCommand(Команда|string $command)

Разрешение экземпляра команды консоли для заданной команды.

Параметры

Команда|string

$command

Возвращаемое значение

Команда

int call(Команда|string $command, array $arguments = [])

Вызов другой команды консоли.

Параметры

Команда\|string	$command
array	$arguments

Возвращаемое значение

int

int callSilent(Команда|string $command, array $arguments = [])

Вызов другой команды консоли без вывода.

Параметры

Команда\|string	$command
array	$arguments

Возвращаемое значение

int

int callSilently(Команда|string $command, array $arguments = [])

Вызов другой команды консоли без вывода.

Параметры

Команда\|string	$command
array	$arguments

Возвращаемое значение

int

protected int runCommand(Команда|string $command, array $arguments, OutputInterface $output)

Выполнение заданной команды консоли.

Параметры

Команда\|string	$command
array	$arguments
OutputInterface	$output

Возвращаемое значение

int

protected ArrayInput createInputFromArguments(array $arguments)

Создание экземпляра ввода из заданных аргументов.

Параметры

array

$arguments

Возвращаемое значение

ArrayInput

protected array context()

Получение всего контекста, переданного команде.

Возвращаемое значение

array

protected void specifyParameters()

Указание аргументов и опций в команде.

Возвращаемое значение

void

protected array getArguments()

Получение аргументов команды консоли.

Возвращаемое значение

array

protected array getOptions()

Получение опций команды консоли.

Возвращаемое значение

array

bool hasArgument(string|int $name)

Определение наличия заданного аргумента.

Параметры

string|int

$name

Возвращаемое значение

bool

array|string|bool|null argument(string|null $key = null)

Получение значения аргумента команды.

Параметры

string|null

$key

Возвращаемое значение

array|string|bool|null

array arguments()

Получение всех аргументов, переданных команде.

Возвращаемое значение

array

bool hasOption(string $name)

Определение наличия заданной опции.

Параметры

string

$name

Возвращаемое значение

bool

string|array|bool|null option(string|null $key = null)

Получение значения опции команды.

Параметры

string|null

$key

Возвращаемое значение

string|array|bool|null

array options()

Получить все опции, переданные команде.

Возвращаемое значение

array

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

string	$question
bool	$default

Возвращаемое значение

bool

mixed ask(string $question, string|null $default = null)

Задать вопрос пользователю и получить ответ.

Параметры

string	$question
string\|null	$default

Возвращаемое значение

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Задать вопрос пользователю с автодополнением.

Параметры

string	$question
array\|callable	$choices
string\|null	$default

Возвращаемое значение

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Задать вопрос пользователю с автодополнением.

Параметры

string	$question
array\|callable	$choices
string\|null	$default

Возвращаемое значение

mixed

mixed secret(string $question, bool $fallback = true)

Задать вопрос пользователю, скрывая ответ в консоли.

Параметры

string	$question
bool	$fallback

Возвращаемое значение

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предложить пользователю выбрать один вариант из списка.

Параметры

string	$question
array	$choices
string\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

Возвращаемое значение

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Форматирование входных данных в текстовую таблицу.

Параметры

array	$headers
Arrayable\|array	$rows
TableStyle\|string	$tableStyle
array	$columnStyles

Возвращаемое значение

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнение заданного обратного вызова с полосой прогресса.

Параметры

iterable\|int	$totalSteps
Closure	$callback

Возвращаемое значение

mixed|void

void info(string $string, int|string|null $verbosity = null)

Вывести строку как информацию.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

string	$string
string\|null	$style
int\|string\|null	$verbosity

Возвращаемое значение

void

void comment(string $string, int|string|null $verbosity = null)

Вывести строку как комментарий.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void question(string $string, int|string|null $verbosity = null)

Вывести строку как вопрос.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void error(string $string, int|string|null $verbosity = null)

Вывести строку как ошибку.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void warn(string $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void alert(string $string, int|string|null $verbosity = null)

Вывести строку в всплывающем окне.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

$this newLine(int $count = 1)

Вставить пустую строку.

Параметры

int

$count

Возвращаемое значение

$this

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface

$input

Возвращаемое значение

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle

$output

Возвращаемое значение

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

Возвращаемое значение

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

Параметры

string|int|null

$level

Возвращаемое значение

int

OutputStyle getOutput()

Получить реализацию вывода.

Возвращаемое значение

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполнен при возникновении данного сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

Возвращаемое значение

void

void untrap()

internal

Отменить обработчики сигналов, установленные в обработчике команды.

Возвращаемое значение

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед проверкой входных данных.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected array promptForMissingArgumentsUsing()

Запросить отсутствующие входные аргументы, используя возвращенные вопросы.

Возвращаемое значение

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнить действия после того, как пользователя попросили предоставить отсутствующие аргументы.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected bool didReceiveOptions(InputInterface $input)

Является ли входной поток содержащим опции, отличающиеся от значений по умолчанию.

Параметры

InputInterface

$input

Возвращаемое значение

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Параметры

string

$name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

void __construct(Filesystem $files)

Создать новый экземпляр команды создателя контроллера.

Параметры

Filesystem

$files

Возвращаемое значение

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения Fluent.

Возвращаемое значение

void

protected void configureIsolation()

Настроить команду консоли для изоляции.

Возвращаемое значение

void

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

int

protected int execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

int

protected CommandMutex commandIsolationMutex()

Получить экземпляр мьютекса изоляции команд для команды.

Результат

CommandMutex

bool isHidden()

{@inheritdoc}

Результат

bool

Команда setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

Результат

Команда

Приложение getLaravel()

Получить экземпляр приложения Laravel.

Результат

Приложение

void setLaravel(Контейнер $laravel)

Установить экземпляр приложения Laravel.

Параметры

Контейнер

$laravel

Результат

void

abstract protected string getStub()

Получить шаблонный файл для генератора.

Результат

string

bool|null handle()

Выполнить консольную команду.

Результат

bool|null

Исключения

FileNotFoundException

protected string qualifyClass(string $name)

Обработать имя класса и отформатировать его в соответствии с корневым пространством имен.

Параметры

string

$name

Результат

string

protected string qualifyModel(string $model)

Уточнить данное имя модели.

Параметры

string

$model

Результат

string

protected array<int,string> possibleModels()

Получить список возможных имен моделей.

Результат

array<int,string>

protected array<int,string> possibleEvents()

Получить список возможных имен событий.

Результат

array<int,string>

protected string getDefaultNamespace(string $rootNamespace)

Получить пространство имен по умолчанию для класса.

Параметры

string

$rootNamespace

Результат

string

protected bool alreadyExists(string $rawName)

Определить, существует ли класс.

Параметры

string

$rawName

Результат

bool

protected string getPath(string $name)

Получить путь назначения класса.

Параметры

string

$name

Результат

string

protected string makeDirectory(string $path)

Создать директорию для класса, если необходимо.

Параметры

string

$path

Результат

string

protected string buildClass(string $name)

Создать класс с заданным именем.

Параметры

string

$name

Результат

string

Исключения

FileNotFoundException

protected $this replaceNamespace(string $stub, string $name)

Заменить пространство имен для заданного шаблона.

Параметры

string	$stub
string	$name

Результат

$this

protected string getNamespace(string $name)

Получить полное пространство имен для данного класса без имени класса.

Параметры

string

$name

Результат

string

protected string replaceClass(string $stub, string $name)

Заменить имя класса для данного шаблона.

Параметры

string	$stub
string	$name

Результат

string

protected string sortImports(string $stub)

Сортирует импорты по алфавиту для данного шаблона.

Параметры

string

$stub

Результат

string

protected string getNameInput()

Получить желаемое имя класса из ввода.

Результат

string

protected string rootNamespace()

Получить корневое пространство имен для класса.

Результат

string

protected string|null userProviderModel()

Получить модель для поставщика пользователей по умолчанию.

Результат

string|null

END_OF_DOCUMENT_MARKER

protected bool isReservedName(string $name)

Проверяет, является ли данное имя зарезервированным.

Параметры

string

$name

Значение возврата

bool

protected string viewPath(string $path = '')

Получить путь к первому каталогу представлений из конфигурации приложения.

Параметры

string

$path

Значение возврата

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Console/GeneratorCommand.html