Spec-Zone.ru › Laravel 9

ControllerMakeCommand

class ControllerMakeCommand extends GeneratorCommand (View source)

Свойства

CreatesMatchingTest
CallsCommands
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

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

from InteractsWithIO
protected InputInterface $input

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

from InteractsWithIO
protected OutputStyle $output

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

from InteractsWithIO
protected int $verbosity

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

from InteractsWithIO
protected array $verbosityMap

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

from InteractsWithIO
protected Signals|null $signals

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

from InteractsWithSignals
static protected array $macros

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

from Macroable
protected Application $laravel

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

from Command
protected string $signature

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

from Command
protected string $name

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

protected string $description

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

protected string $help

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

from Command
protected bool $hidden

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

from Command
protected Filesystem $files

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

from GeneratorCommand
protected string $type

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

protected string[] $reservedNames

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

from 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
смешанный тип ask(string $question, string|null $default = null)

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

из InteractsWithIO
смешанный тип anticipate(string $question, array|callable $choices, string|null $default = null)

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

из InteractsWithIO
смешанный тип askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

из InteractsWithIO
смешанный тип 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
смешанный тип|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)

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

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.

из Команды
строка getStub()

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

bool|null handle()

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

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

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

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

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

из Команды генерации
массив<int,строка> possibleModels()

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

из Команды генерации
массив<int,строка> possibleEvents()

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

из Команды генерации
строка getDefaultNamespace(строка $rootNamespace)

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

bool alreadyExists(строка $rawName)

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

из Команды генерации
строка getPath(строка $name)

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

из Команды генерации
строка makeDirectory(строка $path)

Создать директорию для класса, если необходимо.

из Команды генерации
строка buildClass(строка $name)

Создать класс с заданным именем.

$this replaceNamespace(строка $stub, строка $name)

Заменить пространство имен для данного шаблона.

из Команды генерации
строка getNamespace(строка $name)

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

из Команды генерации
строка replaceClass(строка $stub, строка $name)

Заменить имя класса для данного шаблона.

из Команды генерации
строка sortImports(строка $stub)

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

из Команды генерации
строка getNameInput()

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

из Команды генерации
строка rootNamespace()

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

из Команды генерации
строка|null userProviderModel()

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

из Команды генерации
bool isReservedName(строка $name)

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

из Команды генерации
строка viewPath(строка $path = '')

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

из Команды генерации
void addTestOptions()

Добавить стандартные параметры команды для генерации соответствующих тестов.

из Создаёт Соответствующие Тесты
bool handleTestCreation(строка $path)

Создать соответствующий тестовый случай, если запрошено.

из Создаёт Соответствующие Тесты
строка resolveStubPath(строка $stub)

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

массив buildParentReplacements()

Создать замены для родительского контроллера.

массив buildModelReplacements(массив $replace)

Создать значения замещения для модели.

строка parseModel(строка $model)

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

массив buildFormRequestReplacements(массив $replace, строка $modelClass)

Создать значения замещения для запросов формы.

массив generateFormRequests(строка $modelClass, строка $storeRequestClass, строка $updateRequestClass)

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

Подробности

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

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

Параметры

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

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

Команда

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

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

Параметры

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

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

целое число
END_OF_DOCUMENT_MARKER

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

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

Parameters

string $question
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
bool $fallback

Return Value

mixed

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

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

Parameters

string $question
array $choices
string|int|null $default
mixed|null $attempts
bool $multiple

Return Value

string|array

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

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

Parameters

array $headers
Arrayable|array $rows
TableStyle|string $tableStyle
array $columnStyles

Return Value

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, 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

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

protected void addTestOptions()

Добавить стандартные опции команды для генерации соответствующих тестов.

Значение возвращаемого значения

void

protected bool handleTestCreation(string $path)

Создать соответствующий тестовый случай, если это запрошено.

Параметры

string $path

Значение возвращаемого значения

bool

protected string resolveStubPath(string $stub)

Определить полностью квалифицированный путь к шаблону.

Параметры

string $stub

Значение возвращаемого значения

string

protected array buildParentReplacements()

Сформировать замены для родительского контроллера.

Значение возвращаемого значения

array

protected array buildModelReplacements(array $replace)

Сформировать значения замены для модели.

Параметры

array $replace

Значение возвращаемого значения

array

protected string parseModel(string $model)

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

Параметры

string $model

Значение возвращаемого значения

string

Исключения

InvalidArgumentException

protected array buildFormRequestReplacements(array $replace, string $modelClass)

Сформировать значения замены для модели.

Параметры

array $replace
string $modelClass

Значение возвращаемого значения

array

protected array generateFormRequests(string $modelClass, string $storeRequestClass, string $updateRequestClass)

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

Параметры

string $modelClass
string $storeRequestClass
string $updateRequestClass

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

array

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

Spec-Zone.ru

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