Spec-Zone.ru › Laravel 5.5

KeyGenerateCommand

class KeyGenerateCommand extends Command (View source)

Свойства

ConfirmableTrait

Свойства

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

Методы

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
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
Приложение getLaravel()

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

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

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

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

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

из ConfirmableTrait
Closure getDefaultConfirmCallback()

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

из ConfirmableTrait
void handle()

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

string generateRandomKey()

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

bool setKeyInEnvironmentFile(string $key)

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

void writeNewEnvironmentFileWith(string $key)

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

string keyReplacementPattern()

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

Подробности

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

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

string|array

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

string|array option(string $key = null)

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

Параметры

string $key

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

string|array

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string $default

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

string

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

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

Параметры

string $question
array $choices
string $default

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

string

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

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

Параметры

string $question
array $choices
string $default

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

string

строка secret(строка $question, bool $fallback = true)

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

Параметры

строка $question
bool $fallback

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

строка

строка choice(строка $question, массив $choices, строка $default = null, смешанный $attempts = null, bool $multiple = null)

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

Параметры

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

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

строка

void table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

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

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

void

void info(строка $string, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void line(строка $string, строка $style = null, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void comment(строка $string, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void question(строка $string, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void error(строка $string, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void warn(строка $string, null|целое число|строка $verbosity = null)

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

Параметры

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

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

void

void alert(строка $string)

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

Параметры

строка $string

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

void

protected void setVerbosity(строка|целое число $level)

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

Параметры

строка|целое число $level

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

void

protected целое число parseVerbosity(строка|целое число $level = null)

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

Параметры

строка|целое число $level

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

целое число

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

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

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

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

Параметры

строка $warning
Closure|bool|null $callback

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

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

void handle()

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

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

void

protected строка generateRandomKey()

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

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

строка

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

Spec-Zone.ru

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