KeyGenerateCommand
class KeyGenerateCommand extends Command (View source)
Особенности
| ConfirmableTrait | |
| 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 | Сопоставление уровней подробности, понятных пользователю, и уровней OutputInterface Symfony. | from InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | from InteractsWithSignals |
| static protected array | $macros | Зарегистрированные макросы строк. | from Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected string | $signature | Имя и синтаксис команды консоли. | |
| protected string | $name | Имя команды консоли. | from Command |
| 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 |
Методы
| Команда | 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() Получить параметры консольной команды. | из HasParameters |
| 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)
Динамически обрабатывать вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу. | from Macroable |
| void | __construct()
Создать новый экземпляр команды консоли. | from Command |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | from Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды. | from Command |
| void | fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | from Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | from Command |
| bool | confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)
Подтвердить перед продолжением действия. | from ConfirmableTrait |
| Closure | getDefaultConfirmCallback()
Получить стандартную функцию обратного вызова подтверждения. | from ConfirmableTrait |
| void | handle()
Выполнить команду консоли. | |
| string | generateRandomKey()
Сгенерировать случайный ключ для приложения. | |
| bool | setKeyInEnvironmentFile(string $key)
Установить ключ приложения в файле среды. | |
| bool | writeNewEnvironmentFileWith(string $key)
Записать новый файл среды с заданным ключом. | |
| string | keyReplacementPattern()
Получить шаблон регулярного выражения, который сопоставит env APP_KEY с любым случайным ключом. |
Подробности
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()
Создание нового экземпляра команды консоли.
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.
bool confirmToProceed(string $warning = 'Приложение в стадии производства', Closure|bool|null $callback = null)
Подтверждение перед выполнением действия.
Этот метод запрашивает подтверждение только в производственной среде.
protected Closure getDefaultConfirmCallback()
Получить стандартную функцию обратного вызова подтверждения.
void handle()
Выполнить консольную команду.
protected string generateRandomKey()
Генерировать случайный ключ для приложения.
protected bool setKeyInEnvironmentFile(string $key)
Установить ключ приложения в файле окружения.
protected bool writeNewEnvironmentFileWith(string $key)
Записать новый файл окружения с заданным ключом.
protected string keyReplacementPattern()
Получить шаблон регулярного выражения, который будет соответствовать env APP_KEY с любым случайным ключом.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/KeyGenerateCommand.html
