Spec-Zone.ru › Laravel 8

GeneratorCommand

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

Трейты

CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

Реализация интерфейса ввода.

 из InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

 из InteractsWithIO
protected int $verbosity

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

 из InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней детализации и OutputInterface Symfony.

 из InteractsWithIO
static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected Application $laravel

Экземпляр приложения Laravel.

 из Command
protected string $signature

Имя и сигнатура команды консоли.

 из Command
protected string $name

Имя команды консоли.

 из Command
protected string $description

Описание команды консоли.

 из Command
protected string $help

Текст справки команды консоли.

 из Command
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

 из Command
protected Filesystem $files

Экземпляр файловой системы.
protected string $type

Тип генерируемого класса.
protected string[] $reservedNames

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

Методы

Команда resolveCommand(Command|string $command)

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

 из CallsCommands
int call(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilently(Command|string $command, array $arguments = [])

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

 из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

 из CallsCommands
массив context()

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

 из CallsCommands
void specifyParameters()

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

 из HasParameters
массив getArguments()

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

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

 из HasParameters
bool hasArgument(string|int $name)

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

 из InteractsWithIO
string|массив|null argument(string|null $key = null)

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

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

 из InteractsWithIO
string|массив|bool|null option(string|null $key = null)

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

 из InteractsWithIO
массив options()

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

 из InteractsWithIO
bool confirm(string $question, bool $default = false)

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

 из InteractsWithIO
mixed ask(string $question, string|null $default = null)

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

 из InteractsWithIO
mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

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

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

 из InteractsWithIO
string|массив choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

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

 из InteractsWithIO
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса.

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

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

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

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

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

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

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

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

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

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

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

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

 из InteractsWithIO
void alert(string $string)

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

 from InteractsWithIO
void newLine(int $count = 1)

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

 from InteractsWithIO
void setInput(InputInterface $input)

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

 from InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

 from InteractsWithIO
void setVerbosity(string|int $level)

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

 from InteractsWithIO
int parseVerbosity(string|int|null $level = null)

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

 from InteractsWithIO
OutputStyle getOutput()

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

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

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

 from Macroable
static void mixin(object $mixin, bool $replace = true)

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

 from Macroable
static bool hasMacro(string $name)

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

 from Macroable
static void flushMacros()

Очистить существующие макросы.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

 from Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

 from Macroable
void __construct(Filesystem $files)

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

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

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

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

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

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

 from Command
bool isHidden()

{@inheritdoc}

 from Command
Command setHidden(bool $hidden)

{@inheritdoc}

 from Command
Application getLaravel()

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

 from Command
void setLaravel(Container $laravel)

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

 from Command
string getStub()

Получить шаблонный файл для генератора.
bool|null handle()

Выполнить команду консоли.
string qualifyClass(string $name)

Обработать имя класса и отформатировать в соответствии с корневым пространством имен.
string qualifyModel(string $model)

Определить заданный базовый класс модели.
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 sortImports(string $stub)

Сортирует импорты по алфавиту для данного шаблона.
string getNameInput()

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

Получить корневое пространство имен для класса.
string|null userProviderModel()

Получить модель для поставщика пользователей по умолчанию.
bool isReservedName(string $name)

Проверяет, является ли данное имя зарезервированным.
string viewPath(string $path = '')

Получить первый путь к каталогу представлений из конфигурации приложения.

Подробности

абстрактный защищённый Команда resolveCommand(Команда|строка $command)

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

Параметры

Команда|строка $command

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

Команда

целое число call(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

целое число callSilent(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

целое число callSilently(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

защищённый целое число runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

Команда|строка $command
массив $arguments
OutputInterface $output

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

целое число

защищённый ArrayInput createInputFromArguments(массив $arguments)

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

Параметры

массив $arguments

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

ArrayInput

защищённый массив context()

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

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

массив

защищённый void specifyParameters()

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

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

void

защищённый массив getArguments()

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

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

массив

защищённый массив getOptions()

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

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

массив

логическое значение hasArgument(строка|целое число $name)

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

Параметры

строка|целое число $name

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

логическое значение

строка|массив|null argument(строка|null $key = null)

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

Параметры

строка|null $key

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

строка|массив|null

массив arguments()

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

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

массив

логическое значение hasOption(строка $name)

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

Параметры

строка $name

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

логическое значение

строка|массив|логическое значение|null option(строка|null $key = null)

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

Параметры

строка|null $key

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

строка|массив|логическое значение|null

массив options()

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

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

массив

логическое значение confirm(строка $question, логическое значение $default = false)

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

Параметры

строка $question
логическое значение $default

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

логическое значение

смешанный тип ask(строка $question, строка|null $default = null)

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

Параметры

строка $question
строка|null $default

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

смешанный тип

смешанный тип anticipate(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

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

смешанный тип

смешанный тип askWithCompletion(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

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

смешанный тип

смешанный тип secret(строка $question, логическое значение $fallback = true)

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

Параметры

строка $question
логическое значение $fallback

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

смешанный тип

строка|массив choice(строка $question, массив $choices, строка|null $default = null, смешанный тип|null $attempts = null, логическое значение $multiple = false)

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

Параметры

строка $question
массив $choices
строка|null $default
смешанный тип|null $attempts
логическое значение $multiple

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

строка|массив
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

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable|int $totalSteps
Closure $callback

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

mixed|void

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

Вывод строки как информация.

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

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

void newLine(int $count = 1)

Вывод пустой строки.

Параметры

int $count

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

void

void setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle $output

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

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

OutputStyle getOutput()

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

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

OutputStyle

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

Добавление другого объекта в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверка регистрации макроса.

Параметры

string $name

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

bool

static void flushMacros()

Очистка существующих макросов.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException
END_OF_DOCUMENT_MARKER

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Filesystem $files)

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

Parameters

Filesystem $files

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

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

Exceptions

FileNotFoundException

protected string qualifyClass(string $name)

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

Parameters

string $name

Return Value

string

protected string qualifyModel(string $model)

Квалифицировать заданный базовый класс модели.

Parameters

string $model

Return Value

string

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string $rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

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

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

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

Parameters

string $name

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

Exceptions

FileNotFoundException

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 sortImports(string $stub)

Сортирует импорты для данного фрагмента в алфавитном порядке.

Параметры

string $stub

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

string

protected string getNameInput()

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

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

string

protected string rootNamespace()

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

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

string

protected string|null userProviderModel()

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

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

string|null

protected bool isReservedName(string $name)

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

Параметры

string $name

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

bool

protected string viewPath(string $path = '')

Получить путь к первому каталогу представлений из конфигурации приложения.

Параметры

string $path

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

string

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

Spec-Zone.ru

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