ProviderMakeCommand

class ProviderMakeCommand extends GeneratorCommand (View source)

Трейты

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
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

Методы

Команда	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) Вывести строку в стандартный вывод.	из 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) Получить уровень подробности с точки зрения уровня Symfony OutputInterface.	из 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) Выполнить командную строку.	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)

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

Parameters

Command|string

$command

Return Value

Команда

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

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

END_OF_DOCUMENT_MARKER

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.

Parameters

Container

$laravel

Return Value

void

protected string getStub()

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

Return Value

string

bool|null handle()

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

Return Value

bool|null

Exceptions

FileNotFoundException

protected string qualifyClass(string $name)

Разбор имени класса и форматирование в соответствии с корневым пространством имен.

Parameters

string

$name

Return Value

string

protected string qualifyModel(string $model)

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

Parameters

string

$model

Return Value

string

protected array<int,string> possibleModels()

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

Return Value

array<int,string>

protected array<int,string> possibleEvents()

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

Return Value

array<int,string>

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string

$rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

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

Parameters

string

$rawName

Return Value

bool

protected string getPath(string $name)

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

Parameters

string

$name

Return Value

string

protected string makeDirectory(string $path)

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

Parameters

string

$path

Return Value

string

protected string buildClass(string $name)

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

Parameters

string

$name

Return Value

string

Exceptions

FileNotFoundException

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

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

Parameters

string	$stub
string	$name

Return Value

$this

protected string getNamespace(string $name)

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

Parameters

string

$name

Return Value

string

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

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

Parameters

string	$stub
string	$name

Return Value

string

protected string sortImports(string $stub)

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

Parameters

string

$stub

Return Value

string

protected string getNameInput()

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

Return Value

string

protected string rootNamespace()

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

Return Value

string

protected string|null userProviderModel()

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

Return Value

string|null

protected bool isReservedName(string $name)

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

Parameters

string

$name

Return Value

bool

protected string viewPath(string $path = '')

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

Parameters

string

$path

Return Value

string

protected string resolveStubPath(string $stub)

Разобрать полностью квалифицированный путь к шаблону.

Parameters

string

$stub

Return Value

string

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