ConsoleMakeCommand

класс ConsoleMakeCommand расширяет GeneratorCommand (View source)

Свойства

статический защищённый массив	$macros	Зарегистрированные строковые макросы.	из Macroable
защищённый Application	$laravel	Экземпляр приложения Laravel.	из Command
защищённый InputInterface	$input	Реализация интерфейса ввода.	из Command
защищённый OutputStyle	$output	Реализация интерфейса вывода.	из Command
защищённый строка	$signature	Имя и сигнатура командной строки.	из Command
защищённый строка	$name	Имя команды консоли.
защищённый строка	$description	Описание команды консоли.
защищённый булево	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из Command
защищённый целое число	$verbosity	Уровень детализации вывода по умолчанию.	из Command
защищённый массив	$verbosityMap	Сопоставление удобочитаемых уровней детализации с уровнями OutputInterface Symfony.	из Command
защищённый Filesystem	$files	Экземпляр файловой системы.	из GeneratorCommand
защищённый строка	$type	Тип генерируемого класса.

Методы

static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательскую макрокоманду.	из Macroable
static void	mixin(object $mixin) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирована ли макрокоманда.	из 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	specifyParameters() Указать аргументы и параметры команды.	из Command
int	run(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
mixed	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
int	call(string $command, array $arguments = []) Вызвать другую команду консоли.	из Command
int	callSilent(string $command, array $arguments = []) Вызвать другую команду консоли без отображения вывода.	из Command
ArrayInput	createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов.	из Command
bool	hasArgument(string\|int $name) Определить, существует ли указанный аргумент.	из Command
string\|array\|null	argument(string\|null $key = null) Получить значение аргумента команды.	из Command
array	arguments() Получить все аргументы, переданные команде.	из Command
bool	hasOption(string $name) Определить, существует ли указанный параметр.	из Command
string\|array\|null	option(string\|null $key = null) Получить значение параметра команды.	из Command
array	options() Получить все параметры, переданные команде.	из Command
bool	confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя.	из Command
mixed	ask(string $question, string\|null $default = null) Задать вопрос пользователю и получить его ответ.	из Command
mixed	anticipate(string $question, array $choices, string\|null $default = null) Задать вопрос пользователю с автодополнением.	из Command
mixed	askWithCompletion(string $question, array $choices, string\|null $default = null) Задать вопрос пользователю с автодополнением.	из Command
mixed	secret(string $question, bool $fallback = true) Задать вопрос пользователю, скрывая ответ в консоли.	из Command
string	choice(string $question, array $choices, string\|null $default = null, mixed\|null $attempts = null, bool\|null $multiple = null) Предложить пользователю выбрать один вариант из массива ответов.	из Command
void	table(array $headers, Arrayable\|array $rows, string $tableStyle = 'default', array $columnStyles = []) Отформатировать ввод в текстовую таблицу.	из Command
void	info(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве информации.	из Command
void	line(string $string, string $style = null, int\|string\|null $verbosity = null) Вывести строку в стандартный вывод.	из Command
void	comment(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве комментария.	из Command
void	question(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве вопроса.	из Command
void	error(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве ошибки.	из Command

void	warn(string $string, int\|string\|null $verbosity = null) Вывести строку как предупреждение.	from Команда
void	alert(string $string) Вывести строку в всплывающем окне с предупреждением.	from Команда
void	setVerbosity(string\|int $level) Установить уровень подробности.	from Команда
int	parseVerbosity(string\|int\|null $level = null) Получить уровень подробности в терминах уровня Symfony's OutputInterface.	from Команда
array	getArguments() Получить аргументы командной строки.
array	getOptions() Получить опции командной строки.
OutputStyle	getOutput() Получить реализацию вывода.	from Команда
Приложение	getLaravel() Получить экземпляр приложения Laravel.	from Команда
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	from Команда
string	getStub() Получить шаблонный файл для генератора.
bool\|null	handle() Выполнить команду консоли.	from ГенераторКоманд
string	qualifyClass(string $name) Обработать имя класса и отформатировать его согласно корневому пространству имен.	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	getNameInput() Получить желаемое имя класса из ввода.	from ГенераторКоманд
string	rootNamespace() Получить корневое пространство имен для класса.	from ГенераторКоманд
string\|null	userProviderModel() Получить модель для поставщика пользователей по умолчанию.	from ГенераторКоманд

Details

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object

$mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

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)

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

Параметры

Filesystem

$files

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void specifyParameters()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

mixed

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

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

Параметры

string	$command
array	$arguments

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

int

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

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

Параметры

string	$command
array	$arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array

$arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

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

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

Параметры

string|null

$key

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

string|array|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

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

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

Параметры

string|null

$key

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

string|array|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 $choices, string|null $default = null)

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

string	$question
bool	$fallback

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

mixed

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

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

Параметры

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

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

string

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string	$string
string	$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)

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

Параметры

string

$string

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

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

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputStyle getOutput()

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

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

OutputStyle

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

protected string getStub()

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

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

string

bool|null handle()

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

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

bool|null

protected string qualifyClass(string $name)

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

Параметры

string

$name

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

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

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 getNameInput()

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

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

string

protected string rootNamespace()

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

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

string

protected string|null userProviderModel()

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

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

string|null

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