Spec-Zone.ru › Laravel 5.2

GeneratorCommand

class GeneratorCommand extends 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 Filesystem $files Экземпляр файловой системы.
protected string $type Тип генерируемого класса.

Методы

void __construct(Filesystem $files)

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

void configureUsingFluentDefinition()

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

from Command
void specifyParameters()

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

from Command
int run(InputInterface $input, OutputInterface $output)

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

from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

from Command
void info(string $string)

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

from Command
void line(string $string)

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

from Command
void comment(string $string)

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

from Command
void question(string $string)

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

from Command
void error(string $string)

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

from Command
void warn(string $string)

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

from Command
array getArguments()

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

array getOptions()

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

from Command
OutputInterface getOutput()

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

from Command
Application getLaravel()

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

from Command
void setLaravel(Application $laravel)

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

from 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.2/Illuminate/Console/GeneratorCommand.html

Spec-Zone.ru

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