Spec-Zone.ru › Laravel 5.6

KeyGenerateCommand

class KeyGenerateCommand extends Команда (Просмотр исходного кода)

Трейты

ConfirmableTrait
Macroable

Свойства

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

Методы

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

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

 from Macroable
static void mixin(object $mixin)

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

 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
bool hasArgument(string|int $name)

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

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

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

Определить, присутствует ли заданная опция.

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

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 from Command
void alert(string $string)

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

 from Command
void setVerbosity(string|int $level)

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

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

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

 from Command
array getArguments()

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

 from Command
array getOptions()

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

 from Command
OutputInterface getOutput()

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

 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)

Установить ключ приложения в файле среды.
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)

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

Parameters

object $mixin

Return Value

void

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

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

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

Parameters

string $command
array $arguments

Return Value

int

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

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

Parameters

string $command
array $arguments

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив $arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

строка|целое $name

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

bool

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

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

Параметры

строка|null $key

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

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

array arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка $name

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

bool

string|array option(string $key = null)

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

Параметры

строка $key

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

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

array options()

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

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

массив

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

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

Параметры

строка $question
bool $default

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

bool

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

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

Параметры

строка $question
строка $default

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

строка

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

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

Параметры

строка $question
массив $choices
строка $default

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

строка

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

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

Параметры

строка $question
массив $choices
строка $default

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

строка

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

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

Параметры

строка $question
bool $fallback

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

строка

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

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

Параметры

строка $question
массив $choices
строка $default
смешанный $attempts
bool $multiple

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

строка

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

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

Параметры

массив $headers
Arrayable|массив $rows
строка $tableStyle
массив $columnStyles

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

void

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

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

Параметры

строка $string
null|целое|строка $verbosity

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

void

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

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

Параметры

строка $string
строка $style
null|целое|строка $verbosity

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

void

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

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

Параметры

строка $string
null|целое|строка $verbosity

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

void

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

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

Параметры

строка $string
null|целое|строка $verbosity

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

void

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

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

Параметры

строка $string
null|целое|строка $verbosity

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

void

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

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

Параметры

строка $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 $level = null)

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

Параметры

string|int $level

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

int

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

bool confirmToProceed(string $warning = 'Application In Production!', 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.6/Illuminate/Foundation/Console/KeyGenerateCommand.html

Spec-Zone.ru

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