PolicyMakeCommand
класс PolicyMakeCommand расширяет 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's 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 |
| 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)
Предложите пользователю выбрать один вариант из массива ответов. | из 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)
Получить уровень детализации в терминах уровня Symfony's OutputInterface. | из 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)
Далее взаимодействовать с пользователем, если были запрошены недостающие аргументы. | |
| 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()
Получить модель для поставщика пользователей стражи. | |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | из GeneratorCommand |
| string | viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения. | из GeneratorCommand |
| string | replaceUserNamespace(string $stub)
Заменить имя пространства имён модели User. | |
| string | replaceModel(string $stub, 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 replaceUserNamespace(string $stub)
Замените пространство имён модели User.
protected string replaceModel(string $stub, 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/PolicyMakeCommand.html