Spec-Zone.ru › Laravel 9

RequestMakeCommand

класс RequestMakeCommand расширяет GeneratorCommand (Просмотреть исходный код)

Трейты

CallsCommands
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

Фабрика компонентов консоли.

из InteractsWithIO
protected InputInterface $input

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

из InteractsWithIO
protected OutputStyle $output

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

из InteractsWithIO
protected int $verbosity

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

из InteractsWithIO
protected array $verbosityMap

Сопоставление между удобочитаемыми уровнями детализации и уровнями Symfony's OutputInterface.

из InteractsWithIO
protected Signals|null $signals

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

из InteractsWithSignals
static protected array $macros

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

из Macroable
protected Application $laravel

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

из Command
protected string $signature

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

из Command
protected string $name

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

protected string $description

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

protected string $help

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

из Command
protected bool $hidden

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

из Command
protected Filesystem $files

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

из GeneratorCommand
protected string $type

Тип генерируемого класса.

protected string[] $reservedNames

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

из GeneratorCommand
static protected string|null deprecated $defaultName

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

Методы

Команда 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()

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

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

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

bool hasArgument(string|int $name)

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

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

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

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

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

из InteractsWithIO
bool hasOption(string $name)

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

из InteractsWithIO
строка|массив|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
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

из InteractsWithIO
void table(array $headers, Arrayable|array $rows, TableStyle|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)

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

from InteractsWithIO
void alert(string $string, int|string|null $verbosity = null)

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

from InteractsWithIO
$this 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
void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполнен при возникновении данного сигнала(ов).

from InteractsWithSignals
void untrap()

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

from InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед валидацией ввода.

from PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

from PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

from PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

from PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

Содержит ли входной сигнал какие-либо опции, отличающиеся от значений по умолчанию?

from PromptsForMissingInput
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)

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

from GeneratorCommand
void configureUsingFluentDefinition()

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

from Command
void configureIsolation()

Настроить команду консоли для изоляции.

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

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

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

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

from Command
CommandMutex commandIsolationMutex()

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

from Command
bool isHidden()

{@inheritdoc}

from Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

from Command
Приложение getLaravel()

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

из Команды
void setLaravel(Контейнер $laravel)

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

из Команды
string getStub()

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

bool|null handle()

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

из Команды генерации
string qualifyClass(string $name)

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

из Команды генерации
string qualifyModel(string $model)

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

из Команды генерации
array<int,string> possibleModels()

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

из Команды генерации
array<int,string> possibleEvents()

Получить список возможных имён событий.

из Команды генерации
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 = '')

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

из Команды генерации
string resolveStubPath(string $stub)

Определить полный путь к шаблону.

Подробности

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

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

Параметры

Команда|string $command

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

Команда

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

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

Параметры

Команда|string $command
массив $arguments

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

int

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

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

Параметры

Команда|string $command
массив $arguments

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

int

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

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

Параметры

Команда|string $command
массив $arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Команда|string $command
массив $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив $arguments

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

ArrayInput

protected array context()

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

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

массив

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

массив

protected array getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

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

array arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка $name

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

bool

string|array|bool|null option(string|null $key = null)

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

Параметры

строка|null $key

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

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

array options()

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

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

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

строка $question
bool $fallback

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

mixed

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

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

Параметры

строка $question
массив $choices
строка|int|null $default
mixed|null $attempts
bool $multiple

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

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

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

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

Параметры

массив $headers
Arrayable|массив $rows
TableStyle|строка $tableStyle
массив $columnStyles

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

void

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

Выполнить заданный callback с отображением прогресс-бара.

Параметры

iterable|int $totalSteps
Closure $callback

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

mixed|void

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

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

Параметры

строка $string
int|строка|null $verbosity

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

void

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

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

Параметры

строка $string
строка|null $style
int|строка|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, int|string|null $verbosity = null)

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

Параметры

string $string
int|string|null $verbosity

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

void

$this newLine(int $count = 1)

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

Параметры

int $count

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

$this

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

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполнен при возникновении заданного сигнала(ов).

Параметры

iterable<array-key,int>|int $signals
$callback

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

void

void untrap()

internal

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед проверкой ввода.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected array promptForMissingArgumentsUsing()

Запрос отсутствующих аргументов ввода с использованием возвращенных вопросов.

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

void

protected bool didReceiveOptions(InputInterface $input)

Является ли входной сигнал содержащим какие-либо параметры, отличные от стандартных значений.

Параметры

InputInterface $input

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

bool

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

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

Настроить команду консоли для изоляции.

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected CommandMutex commandIsolationMutex()

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

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool $hidden

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

Command

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

protected string getStub()

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

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

string

bool|null handle()

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

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

bool|null

Исключения

FileNotFoundException

protected string qualifyClass(string $name)

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

Параметры

string $name

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

string

protected string qualifyModel(string $model)

Квалифицировать переданное имя модели по основе.

Параметры

string $model

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

string

protected array<int,string> possibleModels()

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

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

array<int,string>

protected array<int,string> possibleEvents()

Получить список возможных имен событий.

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

array<int,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
END_OF_DOCUMENT_MARKER

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)

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

Parameters

string $stub

Return Value

string

protected string getNameInput()

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

Return Value

string

protected string rootNamespace()

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

Return Value

string

protected string|null userProviderModel()

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

Return Value

string|null

protected bool isReservedName(string $name)

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

Parameters

string $name

Return Value

bool

protected string viewPath(string $path = '')

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

Parameters

string $path

Return Value

string

protected string resolveStubPath(string $stub)

Получить полный путь к шаблону.

Parameters

string $stub

Return Value

string

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

Spec-Zone.ru

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