Spec-Zone.ru › Laravel 5.1

GeneratorCommand

class GeneratorCommand extends Command (View source)

Свойства

protected Application $laravel Экземпляр приложения Laravel. from Command
protected InputInterface $input Реализация интерфейса ввода. from Command
protected OutputStyle $output Реализация интерфейса вывода. from Command
protected string $signature Имя и сигнатура команды консоли. from Command
protected string $name Имя команды консоли. from Command
protected string $description Описание команды консоли. from 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
string|array argument(string $key = null)

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

из Command
string|array option(string $key = null)

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

из 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 $style = 'default')

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

из Command
void info(string $string)

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

из Command
void line(string $string)

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

из Command
void comment(string $string)

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

из Command
void question(string $string)

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

из Command
void error(string $string)

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

из Command
void warn(string $string)

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

из Command
array getArguments()

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

array getOptions()

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

из Command
OutputInterface getOutput()

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

из Command
Application getLaravel()

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

из Command
void setLaravel(Application $laravel)

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

из Command
string getStub()

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

bool|null fire()

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

bool alreadyExists(string $rawName)

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

string getPath(string $name)

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

string parseName(string $name)

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

string getDefaultNamespace(string $rootNamespace)

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

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

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

Подробности

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

string|array argument(string $key = null)

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

Параметры

string $key

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

string|array

string|array option(string $key = null)

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

Параметры

string $key

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

string|array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string $default

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

string

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

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

Параметры

string $question
array $choices
string $default

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

string

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

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

Параметры

string $question
array $choices
string $default

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

string

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

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

Параметры

string $question
bool $fallback

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

string

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

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

Параметры

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

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

string

void table(array $headers, Arrayable|array $rows, string $style = 'default')

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

Параметры

array $headers
Arrayable|array $rows
string $style

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

void

void info(string $string)

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

Параметры

string $string

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

void

void line(string $string)

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

Параметры

string $string

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

void

void comment(string $string)

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

Параметры

string $string

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

void

void question(string $string)

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

Параметры

string $string

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

void

void error(string $string)

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

Parameters

string $string

Return Value

void

void warn(string $string)

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

Parameters

string $string

Return Value

void

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(Application $laravel)

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

Parameters

Application $laravel

Return Value

void

abstract protected string getStub()

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

Return Value

string

bool|null fire()

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

Return Value

bool|null

protected bool alreadyExists(string $rawName)

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

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

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

Parameters

string $name

Return Value

string

protected string parseName(string $name)

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

Parameters

string $name

Return Value

string

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string $rootNamespace

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

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

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

Return Value

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API