Spec-Zone.ru › Laravel 8

ControllerMakeCommand

class ControllerMakeCommand extends GeneratorCommand (View source)

Трейты

CreatesMatchingTest
CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

 из InteractsWithIO
protected OutputStyle $output

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

 из InteractsWithIO
protected int $verbosity

Уровень подробности вывода по умолчанию.

 из InteractsWithIO
protected array $verbosityMap

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

 из InteractsWithIO
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

Методы

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

Вывести строку в окне уведомления.

 из InteractsWithIO
void newLine(int $count = 1)

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

 из InteractsWithIO
void setInput(InputInterface $input)

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

 из InteractsWithIO
void setOutput(OutputStyle $output)

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

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

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

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

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

 из InteractsWithIO
OutputStyle getOutput()

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

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

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

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

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

 из Macroable
static bool hasMacro(string $name)

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

 из Macroable
static void flushMacros()

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

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

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

 из Macroable
mixed __call(string $method, array $parameters)

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

 из Macroable
void __construct(Filesystem $files)

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

 из GeneratorCommand
void configureUsingFluentDefinition()

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

 из Command
int run(InputInterface $input, OutputInterface $output)

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

 из Command
int execute(InputInterface $input, OutputInterface $output)

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

 из Command
bool isHidden()

{@inheritdoc}

 из Command
Command setHidden(bool $hidden)

{@inheritdoc}

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
string getStub()

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

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

 из GeneratorCommand
string qualifyClass(string $name)

Обработать имя класса и отформатировать его в соответствии с корневым пространством имен.

 из GeneratorCommand
string qualifyModel(string $model)

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

 из GeneratorCommand
string getDefaultNamespace(string $rootNamespace)

Получить значение по умолчанию для пространства имен класса.
bool alreadyExists(string $rawName)

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

 из GeneratorCommand
string getPath(string $name)

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

 из GeneratorCommand
string makeDirectory(string $path)

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

 из GeneratorCommand
string buildClass(string $name)

Сгенерировать класс с заданным именем.
$this replaceNamespace(string $stub, string $name)

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

 из GeneratorCommand
string getNamespace(string $name)

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

 из GeneratorCommand
string replaceClass(string $stub, string $name)

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

 из GeneratorCommand
string sortImports(string $stub)

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

 из GeneratorCommand
string getNameInput()

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

 из GeneratorCommand
string rootNamespace()

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

 из GeneratorCommand
string|null userProviderModel()

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

 из GeneratorCommand
bool isReservedName(string $name)

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

 из GeneratorCommand
string viewPath(string $path = '')

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

 из GeneratorCommand
void addTestOptions()

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

 из CreatesMatchingTest
void handleTestCreation(string $path)

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

 из CreatesMatchingTest
string resolveStubPath(string $stub)

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

Создать замены для родительского контроллера.
array buildModelReplacements(array $replace)

Создать значения замены для модели.
string parseModel(string $model)

Получить полностью квалифицированное имя класса модели.
array buildFormRequestReplacements(array $replace, string $modelClass)

Создать значения замены для запроса формы.
array generateFormRequests($modelClass, string $storeRequestClass, string $updateRequestClass)

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

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string $command

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

Command

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

string|array|null

массив arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

строка|null $key

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

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

массив options()

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

смешанное ask(string $question, string|null $default = null)

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

Параметры

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

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

смешанное

смешанное anticipate(string $question, array|callable $choices, string|null $default = null)

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

Параметры

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

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

смешанное

смешанное askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Параметры

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

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

смешанное

смешанное secret(string $question, bool $fallback = true)

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

Параметры

строка $question
bool $fallback

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

смешанное

строка|массив choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Параметры

строка $question
массив $choices
строка|null $default
смешанное|null $attempts
bool $multiple

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

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

пустое table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

Параметры

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

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

пустое

смешанное|пустое withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable|int $totalSteps
Closure $callback

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

смешанное|пустое

пустое info(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое comment(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое question(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое error(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое warn(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

пустое

пустое alert(string $string)

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

Параметры

строка $string

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

пустое

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

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(Filesystem $files)

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

Параметры

Filesystem $files

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

void

protected void configureUsingFluentDefinition()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

int

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden)

{@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 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 void handleTestCreation(string $path)

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

Параметры

string $path

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

void

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)

Создайте значения замены модели.

Параметры

массив $replace
строка $modelClass

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

массив

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

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

Параметры

$modelClass
строка $storeRequestClass
строка $updateRequestClass

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

массив

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

Spec-Zone.ru

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