GeneratorCommand

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

Свойства

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

Методы

void	__construct(Filesystem $files) Создать новый экземпляр команды создания контроллера.
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
bool	hasArgument(string\|int $name) Определить, присутствует ли указанный аргумент.	из Command
string\|array	argument(string\|null $key = null) Получить значение аргумента команды.	из Command
array	arguments() Получить все аргументы, переданные команде.	из Command
bool	hasOption(string $name) Определить, присутствует ли указанный параметр.	из Command
string\|array	option(string $key = null) Получить значение параметра команды.	из Command
array	options() Получить все параметры, переданные команде.	из Command
bool	confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя.	из Command
string	ask(string $question, string $default = null) Запросить ввод у пользователя.	из Command
string	anticipate(string $question, array $choices, string $default = null) Запросить ввод у пользователя с автодополнением.	из Command
string	askWithCompletion(string $question, array $choices, string $default = null) Запросить ввод у пользователя с автодополнением.	из Command
string	secret(string $question, bool $fallback = true) Запросить ввод у пользователя, но скрыть ответ в консоли.	из Command
string	choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null) Предложить пользователю выбрать один вариант из массива ответов.	из Command
void	table(array $headers, Arrayable\|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу.	из Command
void	info(string $string, null\|int\|string $verbosity = null) Вывести строку как информацию.	из Command
void	line(string $string, string $style = null, null\|int\|string $verbosity = null) Вывести строку в стандартный вывод.	из Command
void	comment(string $string, null\|int\|string $verbosity = null) Вывести строку как комментарий.	из Command
void	question(string $string, null\|int\|string $verbosity = null) Вывести строку как вопрос.	из Command
void	error(string $string, null\|int\|string $verbosity = null) Вывести строку как ошибку.	из Command
void	warn(string $string, null\|int\|string $verbosity = null) Вывести строку как предупреждение.	из Command
void	alert(string $string) Вывести строку в всплывающем окне.	из Command
void	setVerbosity(string\|int $level) Установить уровень подробности.	из Command
int	parseVerbosity(string\|int $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	из Command
array	getArguments() Получить аргументы команды консоли.
array	getOptions() Получить параметры команды консоли.	из Command
OutputInterface	getOutput() Получить реализацию вывода.	из Command
Application	getLaravel() Получить экземпляр приложения Laravel.	из Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	из Command

string	getStub() Получить шаблонный файл для генератора.
bool\|null	handle() Выполнить команду консоли.
string	qualifyClass(string $name) Обработать имя класса и отформатировать его в соответствии с корневым пространством имён.
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	getNameInput() Получить желаемое имя класса из ввода.
string	rootNamespace() Получить корневое пространство имён для класса.

Подробности

void __construct(Filesystem $files)

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

Parameters

Filesystem

$files

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

protected void specifyParameters()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

mixed

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

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

Parameters

string	$command
array	$arguments

Return Value

int

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

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

Parameters

string	$command
array	$arguments

Return Value

int

bool hasArgument(string|int $name)

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

Parameters

string|int

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string

$name

Return Value

bool

string|array option(string $key = null)

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

Parameters

string

$key

Return Value

string|array

array options()

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

Return Value

array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string	$default

Return Value

string

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

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

Parameters

string	$question
array	$choices
string	$default

Return Value

string

END_OF_DOCUMENT_MARKER

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

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

Parameters

string	$question
array	$choices
string	$default

Return Value

string

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

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

Parameters

string	$question
bool	$fallback

Return Value

string

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

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

Parameters

string	$question
array	$choices
string	$default
mixed	$attempts
bool	$multiple

Return Value

string

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

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

void alert(string $string)

Вывести строку в окне оповещения.

Parameters

string

$string

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int

$level

Return Value

void

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

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

Parameters

string|int

$level

Return Value

int

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputInterface getOutput()

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

Return Value

OutputInterface

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container

$laravel

Return Value

void

abstract protected string getStub()

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

Return Value

string

bool|null handle()

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

Return Value

bool|null

protected string qualifyClass(string $name)

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

Parameters

string

$name

Return Value

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

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