KeyGenerateCommand

class KeyGenerateCommand extends Command (View source)

Трейты

ConfirmableTrait

CallsCommands

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	Имя и подпись командной строки консольной команды.
protected string	$name	Имя консольной команды.	from Command
protected string	$description	Описание консольной команды.
protected string	$help	Текст справки консольной команды.	from Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
static protected string\|null deprecated	$defaultName	Имя консольной команды.

Методы

Команда	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	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
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
строка\|массив	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) Вывести строку как ошибку.	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
void	trap(iterable<array-key,int>\|int $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) Выполнить действия после того, как пользователя попросили ввести недостающие аргументы.	from PromptsForMissingInput
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) Динамическая обработка вызовов класса.	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
bool	isHidden() {@inheritdoc}	from Command

Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команды
Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
bool	confirmToProceed(string $warning = 'Приложение в рабочей среде', Closure\|bool\|null $callback = null) Подтвердить перед выполнением действия.	из Тракта подтверждения
Closure	getDefaultConfirmCallback() Получить стандартную функцию обратного вызова для подтверждения.	из Тракта подтверждения
void	handle() Выполнить консольную команду.
string	generateRandomKey() Сгенерировать случайный ключ для приложения.
bool	setKeyInEnvironmentFile(string $key) Установить ключ приложения в файле среды.
bool	writeNewEnvironmentFileWith(string $key) Создать новый файл среды с заданным ключом.
string	keyReplacementPattern() Получить шаблон регулярного выражения, который соответствует env APP_KEY с любым случайным ключом.

Подробности

abstract protected Команда resolveCommand(Command|string $command)

Разрешить экземпляр консольной команды для заданной команды.

Параметры

Команда|строка

$command

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

Команда

int call(Command|string $command, array $arguments = [])

Вызвать другую консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilent(Command|string $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

int callSilently(Command|string $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

Создать экземпляр ввода из заданных аргументов.

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

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

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

массив

protected void specifyParameters()

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

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

void

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

массив|строка|bool|null argument(string|null $key = null)

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

Параметры

строка|null

$key

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

массив|строка|bool|null

массив arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка

$name

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

bool

строка|массив|bool|null option(string|null $key = null)

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

Параметры

строка|null

$key

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

строка|массив|bool|null

массив options()

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

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

массив

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Parameters

string	$question
bool	$default

Return Value

bool

mixed ask(string $question, string|null $default = null)

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

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

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

mixed|void

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

Вывод строки в качестве информации.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

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

Return Value

void

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

Вывод строки в качестве комментария.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

Вывод строки в всплывающем окне.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

$this newLine(int $count = 1)

Вывод пустой строки.

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

Установка реализации интерфейса ввода.

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

Установка реализации интерфейса вывода.

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Parameters

string|int

$level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

Получить реализацию вывода.

Return Value

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обработчик, который будет выполняться при возникновении указанного сигнала(ов).

Parameters

iterable<array-key,int>\|int	$signals
	$callback

Return Value

void

void untrap()

internal

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

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Parameters

string	$name
object\|callable	$macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Включить другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Return Value

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct()

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

Return Value

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

Return Value

void

protected void configureIsolation()

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

Return Value

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()

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

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

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

Command

Application getLaravel()

Получить экземпляр приложения Laravel.

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

bool confirmToProceed(string $warning = 'Приложение в режиме производства', Closure|bool|null $callback = null)

Подтвердить выполнение действия.

Этот метод запрашивает подтверждение только в режиме производства.

Параметры

string	$warning
Closure\|bool\|null	$callback

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

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

void handle()

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

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

void

protected string generateRandomKey()

Сгенерировать случайный ключ для приложения.

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

string

protected bool setKeyInEnvironmentFile(string $key)

Установить ключ приложения в файле окружения.

Параметры

string

$key

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

bool

protected bool writeNewEnvironmentFileWith(string $key)

Создать новый файл окружения с заданным ключом.

Параметры

string

$key

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

bool

protected string keyReplacementPattern()

Получить шаблон регулярного выражения, который будет соответствовать env APP_KEY любым случайным ключом.

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

string

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