ConsoleMakeCommand

class ConsoleMakeCommand extends GeneratorCommand (View source)

Свойства

CreatesMatchingTest

CallsCommands

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
protected bool	$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

Методы

Command	resolveCommand(Command\|string $command) Разрешить экземпляр консольной команды для данной команды.	from CallsCommands
int	call(Command\|string $command, array $arguments = []) Вызвать другую консольную команду.	from CallsCommands
int	callSilent(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	from CallsCommands
int	callSilently(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	from CallsCommands
int	runCommand(Command\|string $command, array $arguments, OutputInterface $output) Запустить данную консольную команду.	from CallsCommands
ArrayInput	createInputFromArguments(array $arguments) Создать экземпляр входных данных из заданных аргументов.	from CallsCommands
array	context() Получить весь контекст, переданный команде.	from CallsCommands
void	configurePrompts(InputInterface $input) Настроить резервные подсказки.	from ConfiguresPrompts
mixed	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя ввод до тех пор, пока обратный вызов проверки не пройдёт.	from ConfiguresPrompts
void	restorePrompts() Восстановить вывод подсказок.	from ConfiguresPrompts
void	specifyParameters() Указать аргументы и параметры в команде.	from HasParameters
array	getArguments() Получить аргументы консольной команды.
array	getOptions() Получить параметры консольной команды.
bool	hasArgument(string\|int $name) Определить, присутствует ли данный аргумент.	from InteractsWithIO
array\|string\|bool\|null	argument(string\|null $key = null) Получить значение аргумента команды.	from InteractsWithIO
array	arguments() Получить все аргументы, переданные команде.	from InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли данный параметр.	from InteractsWithIO
string\|array\|bool\|null	option(string\|null $key = null) Получить значение параметра команды.	from InteractsWithIO
array	options() Получить все параметры, переданные команде.	from InteractsWithIO
bool	confirm(string $question, bool $default = false) Подтвердить вопрос с пользователем.	from InteractsWithIO
mixed	ask(string $question, string\|null $default = null) Запросить у пользователя ввод.	from InteractsWithIO
mixed	anticipate(string $question, array\|callable $choices, string\|null $default = null) Запросить у пользователя ввод с автодополнением.	from InteractsWithIO
mixed	askWithCompletion(string $question, array\|callable $choices, string\|null $default = null) Запросить у пользователя ввод с автодополнением.	from InteractsWithIO
mixed	secret(string $question, bool $fallback = true) Запросить у пользователя ввод, но скрыть ответ от консоли.	from 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) Выполнить действия после того, как пользователя попросили предоставить отсутствующие аргументы.	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() Настроить команду консоли с помощью определения в стиле fluent.	from Command
void	configureIsolation() Настроить команду консоли для изоляции.	from Command
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command

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) Заменить имя класса для данного шаблона.
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 ГенераторКоманда
void	addTestOptions() Добавить стандартные параметры команды для генерации соответствующих тестов.	from СоздаётСоответствующиеТесты
bool	handleTestCreation(string $path) Создать соответствующий тест-кейс, если запрошено.	from СоздаётСоответствующиеТесты

Подробности

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

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

Параметры

Command|string

$command

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

Команда

int call(Command|string $command, array $arguments = [])

Вызвать другую консольную команду.

Параметры

Command\|string	$command
array	$arguments

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

int

int callSilent(Command|string $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Command\|string	$command
array	$arguments

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

int

int callSilently(Command|string $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Command\|string	$command
array	$arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Command\|string	$command
array	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array

$arguments

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

ArrayInput

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

Настроить отступ запросов.

Параметры

InputInterface

$input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Запрашивать у пользователя данные до тех пор, пока не будет пройдена проверка.

Параметры

Closure	$prompt
bool\|string	$required
Closure\|null	$validate

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

mixed

protected void restorePrompts()

Восстановить вывод запросов.

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

void

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

Factory outputComponents()

Получение реализации фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Без описания

Параметры

	$signals
	$callback

void untrap()

internal

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

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

void

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

Взаимодействовать с пользователем перед валидацией ввода.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Указывает, содержит ли ввод какие-либо параметры, отличающиеся от значений по умолчанию.

Parameters

InputInterface

$input

Return Value

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Filesystem $files)

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

Parameters

Filesystem

$files

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

protected void configureIsolation()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool

$hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

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

protected bool isReservedName(string $name)

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

Параметры

string

$name

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

bool

protected string viewPath(string $path = '')

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

Параметры

string

$path

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

string

protected void addTestOptions()

Добавить стандартные параметры команд для генерации соответствующих тестов.

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

void

protected bool handleTestCreation(string $path)

Создать соответствующий тестовый кейс, если запрошено.

Параметры

string

$path

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

bool

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