Spec-Zone.ru › Laravel 5.8

KeyGenerateCommand

class KeyGenerateCommand extends Command (View source)

Свойства

ConfirmableTrait
Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
protected Application $laravel Экземпляр приложения Laravel. from Command
protected InputInterface $input Реализация интерфейса ввода. from Command
protected OutputStyle $output Реализация интерфейса вывода. from Command
protected string $signature Имя и сигнатура консольной команды.
protected string $name Имя консольной команды. from Command
protected string $description Описание консольной команды.
protected bool $hidden Указывает, должна ли команда отображаться в списке команд Artisan. from Command
protected int $verbosity Уровень подробности вывода команд по умолчанию. from Command
protected array $verbosityMap Сопоставление удобочитаемых уровней подробности и интерфейса Symfony OutputInterface. from Command

Методы

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

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

 from Command
int run(InputInterface $input, OutputInterface $output)

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

 from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

 from Command
ArrayInput createInputFromArguments(array $arguments)

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

 from Command
array context()

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

 from Command
bool hasArgument(string|int $name)

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

 from Command
string|array|null argument(string|null $key = null)

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

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

 from Command
string|array|bool|null option(string|null $key = null)

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Вывести данные в виде таблицы.

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

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

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

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

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

Вывести строку как комментарий.

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

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

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

Вывести строку в качестве сообщения об ошибке.

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

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

 from Command
void alert(string $string)

Вывести строку в качестве предупреждения (в виде всплывающего окна).

 from Command
void setVerbosity(string|int $level)

Установить уровень детализации.

 from Command
int parseVerbosity(string|int|null $level = null)

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

 from Command
isHidden()

{@inheritdoc}

 from Command
setHidden($hidden)

{@inheritdoc}

 from Command
массив getArguments()

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

 из Команды
массив getOptions()

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

 из Команды
Стиль вывода getOutput()

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

 из Команды
Приложение getLaravel()

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

 из Команды
void setLaravel(Контейнер $laravel)

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

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

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

 из Атрибут подтверждения
Closure getDefaultConfirmCallback()

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

 from ConfirmableTrait
void handle()

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

Сгенерировать случайный ключ для приложения.
bool setKeyInEnvironmentFile(string $key)

Установить ключ приложения в файле окружения.
void writeNewEnvironmentFileWith(string $key)

Записать новый файл окружения с заданным ключом.
string keyReplacementPattern()

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

Details

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)

Смешать другой объект в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void specifyParameters()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected mixed execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

mixed

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

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

Параметры

string $command
array $arguments

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

int

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

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

Параметры

string $command
array $arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

string|array|null argument(string|null $key = null)

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

Параметры

string|null $key

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

string|array|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

string|array|bool|null option(string|null $key = null)

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

Параметры

string|null $key

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

string|array|bool|null

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

Предложить пользователю один вариант из списка ответов.

Параметры

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

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

string

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

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

Параметры

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

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

void

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

Вывести строку как информационное сообщение.

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

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

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

void

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

Вывести строку как комментарий.

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

Вывести строку в виде сообщения об ошибке.

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

void alert(string $string)

Вывести строку в виде всплывающего сообщения.

Параметры

string $string

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

void

protected void setVerbosity(string|int $level)

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

Параметры

string|int $level

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

void

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

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

Параметры

string|int|null $level

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

int

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

$hidden

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputStyle getOutput()

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

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

OutputStyle

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 void writeNewEnvironmentFileWith(string $key)

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

Параметры

string $key

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

void

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/5.8/Illuminate/Foundation/Console/KeyGenerateCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API