Spec-Zone.ru › Laravel 7

ComponentMakeCommand

class ComponentMakeCommand extends GeneratorCommand (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

Имя командной строки.
protected string $description

Описание командной строки.
protected string|null $help

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

 из Command
protected bool $hidden

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

 из Command
protected Filesystem $files

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

 из GeneratorCommand
protected string $type

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

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

 из GeneratorCommand

Методы

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

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

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

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

 из CallsCommands
int callSilent(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
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 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)

Получить уровень подробности с точки зрения уровня Symfony's OutputInterface.

 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 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
int run(InputInterface $input, OutputInterface $output)

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

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

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

 from Command
isHidden()

{@inheritdoc}

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

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

 from GeneratorCommand
string getDefaultNamespace(string $rootNamespace)

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

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

 from GeneratorCommand
string getPath(string $name)

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

 from GeneratorCommand
string makeDirectory(string $path)

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

 from GeneratorCommand
string buildClass(string $name)

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

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

 from GeneratorCommand
string getNamespace(string $name)

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

 from GeneratorCommand
string replaceClass(string $stub, string $name)

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

 from GeneratorCommand
string sortImports(string $stub)

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

 from GeneratorCommand
string getNameInput()

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

 from GeneratorCommand
string rootNamespace()

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

 from GeneratorCommand
string|null userProviderModel()

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

 из GeneratorCommand
bool isReservedName(string $name)

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

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

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

 из GeneratorCommand
void writeView()

Записать представление для компонента.
string getView()

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

Подробности

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

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

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string|null $key

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

string|array|bool|null

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

void line(string $string, string|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 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 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

isHidden()

{@inheritdoc}

setHidden(bool $hidden)

{@inheritdoc}

Parameters

bool $hidden

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

protected string getStub()

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

Return Value

string

bool|null handle()

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

Return Value

bool|null

protected string qualifyClass(string $name)

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

Parameters

string $name

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

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

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

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

string|null

protected bool isReservedName(string $name)

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

Параметры

string $name

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

bool

protected string viewPath(string $path = '')

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

Параметры

string $path

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

string

protected void writeView()

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

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

void

protected string getView()

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

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

string view

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

Spec-Zone.ru

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