RuleMakeCommand

class RuleMakeCommand extends GeneratorCommand (View source)

Свойства

protected InputInterface	$input	Реализация интерфейса ввода.	из InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	из InteractsWithIO
protected int	$verbosity	Уровень детализации вывода команд по умолчанию.	из InteractsWithIO
protected array	$verbosityMap	Сопоставление уровней детализации вывода (человеко-читаемых) с уровнями Symfony OutputInterface.	из InteractsWithIO
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	из Command
protected string	$signature	Имя и сигнатура консольной команды.	из Command
protected string	$name	Имя консольной команды.
protected string	$description	Описание консольной команды.
protected string	$help	Текст справки консольной команды.	из Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из 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	specifyParameters() Указать аргументы и параметры команды.	из HasParameters
массив	getArguments() Получить аргументы консольной команды.	из HasParameters
массив	getOptions() Получить параметры консольной команды.
bool	hasArgument(string\|int $name) Определить, присутствует ли данный аргумент.	из InteractsWithIO
string\|массив\|null	argument(string\|null $key = null) Получить значение аргумента команды.	из InteractsWithIO
массив	arguments() Получить все аргументы, переданные команде.	из InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли данный параметр.	из InteractsWithIO
string\|массив\|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
string\|массив	choice(string $question, array $choices, string\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Предложить пользователю один выбор из массива ответов.	из InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, 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) Вывести строку как предупреждение.	from InteractsWithIO
void	alert(string $string) Вывести строку в поле предупреждения.	from InteractsWithIO
void	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
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
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	from Command
bool	isHidden() {@inheritdoc}	from Command
Command	setHidden(bool $hidden) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from Command
string	getStub() Получить шаблонный файл для генератора.
bool\|null	handle() Выполнить команду консоли.	from GeneratorCommand
string	qualifyClass(string $name) Обработать имя класса и отформатировать в соответствии с корневым именем пространства.	from GeneratorCommand
string	qualifyModel(string $model) Указать имя модели, заданной баз класса.	from GeneratorCommand
string	getDefaultNamespace(string $rootNamespace) Получить имя пространства по умолчанию для класса.
bool	alreadyExists(string $rawName) Определить, существует ли класс.	from GeneratorCommand
string	getPath(string $name) Получить путь назначения класса.	from GeneratorCommand
string	makeDirectory(string $path) Создать директорию для класса, если необходимо.	from GeneratorCommand
string	buildClass(string $name) Создать класс с заданным именем.
$this	replaceNamespace(string $stub, string $name) Заменить пространство имен для данного шаблона.	from GeneratorCommand

string	getNamespace(string $name) Получить полное имя пространства имён для заданного класса без имени класса.	из GeneratorCommand
string	replaceClass(string $stub, string $name) Заменить имя класса в заданном шаблоне.	из GeneratorCommand
string	sortImports(string $stub) Сортирует импорты в алфавитном порядке для заданного шаблона.	из GeneratorCommand
string	getNameInput() Получить желаемое имя класса из ввода.	из GeneratorCommand
string	rootNamespace() Получить корневое пространство имён для класса.	из GeneratorCommand
string\|null	userProviderModel() Получить модель для поставщика пользователей по умолчанию.	из GeneratorCommand
bool	isReservedName(string $name) Проверяет, является ли заданное имя зарезервированным.	из GeneratorCommand
string	viewPath(string $path = '') Получить путь к первому каталогу представлений из конфигурации приложения.	из GeneratorCommand

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string

$command

Return Value

Command

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

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

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

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

Parameters

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

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array

$arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

Определить, присутствует ли заданный аргумент.

Parameters

string|int

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

Определить, присутствует ли заданная опция.

Parameters

string

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

mixed|void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

void alert(string $string)

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

Parameters

string

$string

Return Value

void

void newLine(int $count = 1)

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

Parameters

int

$count

Return Value

void

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int

$level

Return Value

void

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

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

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

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

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

OutputStyle

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

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden)

{@inheritdoc}

Параметры

bool

$hidden

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

Command

Application getLaravel()

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

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

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 string getDefaultNamespace(string $rootNamespace)

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

Параметры

string

$rootNamespace

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

string

protected bool alreadyExists(string $rawName)

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

Параметры

string

$rawName

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

bool

END_OF_DOCUMENT_MARKER

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

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