Spec-Zone.ru › Laravel 11

RuleMakeCommand

класс RuleMakeCommand расширяет GeneratorCommand (View source)

Трейты

CallsCommands
ConfiguresPrompts
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 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 bool $isolated

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

из Command
protected int $isolatedExitCode

Код возврата по умолчанию для изолированных команд.

из Command
protected array $aliases

Псевдонимы имени команды консоли.

из 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 configurePrompts(InputInterface $input)

Настроить отступы подсказок.

из ConfiguresPrompts
смешанный promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

из ConfiguresPrompts
?string validatePrompt(mixed $value, mixed $rules)

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

из ConfiguresPrompts
Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

из ConfiguresPrompts
массив validationMessages()

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

из ConfiguresPrompts
массив validationAttributes()

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

из ConfiguresPrompts
void restorePrompts()

Восстановить вывод подсказок.

из ConfiguresPrompts
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
string|array 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)

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

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

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

из InteractsWithIO
$this 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
Factory outputComponents()

Получение реализации фабрики компонентов вывода.

из InteractsWithIO
trap($signals, $callback)

Без описания

из InteractsWithSignals
void untrap()

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

из InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

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

из PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

из PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

из PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

из PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

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

из PromptsForMissingInput
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
void configureIsolation()

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

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

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

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

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

из Command
CommandMutex commandIsolationMutex()

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

из Command
void fail(Throwable|string|null $exception = null)

Отклонить команду вручную.

из Command
bool isHidden()

{@inheritdoc}

из Command
Command setHidden(bool $hidden = true)

{@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
array<int,string> possibleModels()

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

из GeneratorCommand
array<int,string> possibleEvents()

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

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

Подробности

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 configurePrompts(InputInterface $input)

Настроить отступы подсказок.

Параметры

InputInterface $input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

protected ?string validatePrompt(mixed $value, mixed $rules)

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

Параметры

mixed $value
mixed $rules

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

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Параметры

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

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

Validator

protected array validationMessages()

Получить сообщения об ошибках проверки, которые должны использоваться при проверке подсказок.

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

array

protected array validationAttributes()

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

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

array

protected void restorePrompts()

Восстановить вывод подсказок.

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

array|string|bool|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

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

void

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

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

Параметры

iterable|int $totalSteps
Closure $callback

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

mixed|void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
string|null $style
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Нет описания

Параметры

$signals
$callback

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)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

Parameters

Throwable|string|null $exception

Return Value

void

Exceptions

Throwable

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

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

Exceptions

FileNotFoundException

protected string qualifyClass(string $name)

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

Parameters

string $name

Return Value

string

protected string qualifyModel(string $model)

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

Parameters

string $model

Return Value

string

protected array<int,string> possibleModels()

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

Return Value

array<int,string>

protected array<int,string> possibleEvents()

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

Return Value

array<int,string>

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string $rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

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

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

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

Parameters

string $name

Return Value

string

protected string makeDirectory(string $path)

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

Parameters

string $path

Return Value

string

protected string buildClass(string $name)

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

Parameters

string $name

Return Value

string

Exceptions

FileNotFoundException

protected $this replaceNamespace(string $stub, string $name)

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

Parameters

string $stub
string $name

Return Value

$this

protected string getNamespace(string $name)

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

Parameters

string $name

Return Value

string

protected string replaceClass(string $stub, string $name)

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

Parameters

string $stub
string $name

Return Value

string

protected string sortImports(string $stub)

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

Параметры

string $stub

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

string

protected string getNameInput()

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

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

string

protected string rootNamespace()

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

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

string

protected string|null userProviderModel()

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

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

string|null

protected bool isReservedName(string $name)

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

Параметры

string $name

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

bool

protected string viewPath(string $path = '')

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

Параметры

string $path

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

string

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

Spec-Zone.ru

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