EventMakeCommand
class EventMakeCommand extends 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 |
| $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)
Определить, существует ли класс. | |
| string | getPath(string $name)
Получить путь назначения класса. | из GeneratorCommand |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | из GeneratorCommand |
| string | buildClass(string $name)
Создать класс с заданным именем. | из GeneratorCommand |
| $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 |
| string | resolveStubPath(string $stub)
Получить полный путь к шаблону. |
Подробности
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр команды консоли для заданной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
int callSilently(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Выполнить заданную команду консоли.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
protected void configurePrompts(InputInterface $input)
Настроить подсказки по умолчанию.
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Запрашивать у пользователя, пока заданный обратный вызов проверки не пройдет.
protected ?string validatePrompt(mixed $value, mixed $rules)
Проверить заданное значение подсказки с помощью валидатора.
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который должен использоваться для проверки подсказок.
protected array validationMessages()
Получить сообщения об ошибках проверки, которые должны использоваться при проверке подсказок.
protected array validationAttributes()
Получить атрибуты проверки, которые должны использоваться при проверке подсказок.
protected void restorePrompts()
Восстановить вывод подсказок.
protected void specifyParameters()
Указать аргументы и параметры команды.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить параметры команды консоли.
bool hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент.
array|string|bool|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли заданный параметр.
string|array|bool|null option(string|null $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
mixed ask(string $question, string|null $default = null)
Запросить ввод у пользователя.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
mixed secret(string $question, bool $fallback = true)
Запросить ввод у пользователя, скрыв ответ в консоли.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю одиночный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматировать входные данные в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, продвигая полосу прогресса.
void info(string $string, int|string|null $verbosity = null)
Вывести строку как информацию.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку в стандартный вывод.
void comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий.
void question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос.
void error(string $string, int|string|null $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string, int|string|null $verbosity = null)
Вывести строку в окне предупреждения.
$this newLine(int $count = 1)
Вывести пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
Factory outputComponents()
Получить реализацию фабрики компонентов вывода.
trap($signals, $callback)
Без описания
void untrap()
| internal |
Отключить обработчики сигналов, установленные в обработчике команды.
protected void interact(InputInterface $input, OutputInterface $output)
Взаимодействовать с пользователем перед проверкой ввода.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запросить у пользователя любые отсутствующие аргументы.
protected array promptForMissingArgumentsUsing()
Запросить отсутствующие входные аргументы, используя возвращенные вопросы.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнить действия после того, как пользователя попросили предоставить отсутствующие аргументы.
protected bool didReceiveOptions(InputInterface $input)
Получить, содержит ли ввод какие-либо параметры, отличающиеся от значений по умолчанию.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Добавить другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static void flushMacros()
Очистить существующие макросы.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы класса.
void __construct(Filesystem $files)
Создать новый экземпляр команды генератора.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
protected void configureIsolation()
Настроить команду консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды.
void fail(Throwable|string|null $exception = null)
Отказаться от команды вручную.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected string getStub()
Получить шаблонный файл для генератора.
bool|null handle()
Выполнить команду консоли.
protected string qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым пространством имен.
protected string qualifyModel(string $model)
Квалифицировать заданный базовый класс модели.
protected array<int,string> possibleModels()
Получить список возможных имен моделей.
protected array<int,string> possibleEvents()
Получить список возможных имен событий.
protected string getDefaultNamespace(string $rootNamespace)
Получить пространство имен по умолчанию для класса.
protected bool alreadyExists(string $rawName)
Определить, существует ли класс.
protected string getPath(string $name)
Получить путь к целевому классу.
protected string makeDirectory(string $path)
Создать директорию для класса, если необходимо.
protected string buildClass(string $name)
Создать класс с заданным именем.
protected $this replaceNamespace(string $stub, string $name)
Заменить пространство имен для данного шаблона.
protected string getNamespace(string $name)
Получить полное имя пространства имён для данного класса без имени класса.
protected string replaceClass(string $stub, string $name)
Заменить имя класса в заданном шаблоне.
protected string sortImports(string $stub)
Сортирует импорты в алфавитном порядке для заданного шаблона.
protected string getNameInput()
Получить желаемое имя класса из ввода.
protected string rootNamespace()
Получить корневое пространство имён для класса.
protected string|null userProviderModel()
Получить модель для поставщика пользователей по умолчанию.
protected bool isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным.
protected string viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения.
protected string resolveStubPath(string $stub)
Получить полностью квалифицированный путь к шаблону.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/EventMakeCommand.html