Spec-Zone.ru › Laravel 5.7

GeneratorCommand

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

Свойства

Macroable

Свойства

статический защищённый массив $macros Зарегистрированные строковые макросы. из Macroable
защищённый Application $laravel Экземпляр приложения Laravel. из Command
защищённый InputInterface $input Реализация интерфейса ввода. из Command
защищённый OutputStyle $output Реализация интерфейса вывода. из Command
защищённая строка $signature Имя и подпись командной строки. из Command
защищённая строка $name Имя командной строки. из Command
защищённая строка $description Описание командной строки. из Command
защищённый bool $hidden Указывает, следует ли отображать команду в списке команд Artisan. из Command
защищённый int $verbosity Уровень детализации вывода по умолчанию. из Command
защищённый массив $verbosityMap Сопоставление удобочитаемых уровней детализации с Symfony's OutputInterface. из Command
защищённый Filesystem $files Экземпляр файловой системы.
защищённая строка $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)

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

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)

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

из Command
void alert(string $string)

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

из Command
void setVerbosity(string|int $level)

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

из Command
int parseVerbosity(string|int|null $level = null)

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

из Command
array getArguments()

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

array getOptions()

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

из Command
OutputStyle 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()

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

string|null userProviderModel()

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

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin)

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

Параметры

object $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

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)

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

Параметры

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

abstract 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/Console/GeneratorCommand.html

Spec-Zone.ru

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