ObserverMakeCommand
class ObserverMakeCommand extends GeneratorCommand (View source)
Свойства
| CallsCommands | |
| ConfiguresPrompts | |
| 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 | Сопоставление удобочитаемых уровней подробности с уровнями Symfony's OutputInterface. | 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 |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected bool | $isolated | Указывает, может ли выполняться только один экземпляр команды. | from Command |
| protected int | $isolatedExitCode | Значение по умолчанию для кода выхода изолированных команд. | from Command |
| protected array | $aliases | Псевдонимы имени команды консоли. | from Command |
| protected Filesystem | $files | Экземпляр файловой системы. | from GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | from 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 |
| mixed | 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 |
| 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|array | choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложите пользователю один вариант из массива ответов. | from InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматирует входные данные в текстовую таблицу. | from InteractsWithIO |
| mixed|void | withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполняет заданный обратный вызов с отображением полосы прогресса. | from InteractsWithIO |
| void | info(string $string, int|string|null $verbosity = null)
Выводит строку как информационное сообщение. | from InteractsWithIO |
| void | line(string $string, string|null $style = null, int|string|null $verbosity = null)
Выводит строку в стандартный вывод. | from InteractsWithIO |
| void | comment(string $string, int|string|null $verbosity = null)
Выводит строку как комментарий. | from InteractsWithIO |
| void | question(string $string, int|string|null $verbosity = null)
Выводит строку как вопрос. | from InteractsWithIO |
| void | error(string $string, int|string|null $verbosity = null)
Выводит строку как сообщение об ошибке. | from 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 |
| Factory | outputComponents()
Возвращает реализацию фабрики компонентов вывода. | from InteractsWithIO |
| trap($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)
Динамически обрабатывать вызовы к классу. | из 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 |
| string | replaceModel(string $stub, string $model)
Заменить модель в заданном шаблоне. | |
| string | parseModel(string $model)
Получить полное имя класса модели. | |
| 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)
Получить значение аргумента команды.
массив arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли заданный параметр.
строка|массив|bool|null option(string|null $key = null)
Получить значение параметра команды.
массив options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
смешанный тип ask(string $question, string|null $default = null)
Запросить ввод у пользователя.
смешанный тип anticipate(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
смешанный тип askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
смешанный тип secret(string $question, bool $fallback = true)
Запросить ввод у пользователя, но скрыть ответ в консоли.
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю выбор из списка ответов.
пустое значение table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматирование ввода в текстовую таблицу.
смешанный тип|пустое значение withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнение заданного обратного вызова с продвижением полосы прогресса.
пустое значение info(string $string, int|string|null $verbosity = null)
Вывести строку как информационное сообщение.
пустое значение line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку в стандартный вывод.
пустое значение comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий.
пустое значение question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос.
пустое значение error(string $string, int|string|null $verbosity = null)
Вывести строку как ошибку.
пустое значение warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение.
пустое значение 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 replaceModel(string $stub, string $model)
Заменить модель для заданного шаблона.
protected string parseModel(string $model)
Получить полное имя класса модели.
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/ObserverMakeCommand.html
