Spec-Zone.ru › Laravel 11

EnvironmentEncryptCommand

class EnvironmentEncryptCommand extends Command (View source)

Свойства

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
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

from Command
protected bool $isolated

Указывает, может ли выполняться только одна инстанция команды в любой момент времени.

from Command
protected int $isolatedExitCode

Код завершения по умолчанию для изолированных команд.

from Command
protected array $aliases

Псевдонимы имени команды консоли.

from Command
protected Filesystem $files

Экземпляр файловой системы.

Методы

Команда 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
mixed 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()

Восстановить вывод подсказок.

from ConfiguresPrompts
void specifyParameters()

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

from HasParameters
array getArguments()

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

from HasParameters
array getOptions()

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

from HasParameters
bool hasArgument(string|int $name)

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

from InteractsWithIO
array|string|bool|null argument(string|null $key = null)

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

from InteractsWithIO
array arguments()

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

from InteractsWithIO
bool hasOption(string $name)

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

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

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

from InteractsWithIO
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Запись строки в виде выходных данных информации.

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

Запись строки в стандартный вывод.

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

Запись строки в виде выходных данных комментария.

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

Запись строки в виде выходных данных вопроса.

from 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
Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

from InteractsWithIO
trap($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)

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

из Macroable
static void flushMacros()

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

из Macroable
static mixed __callStatic(string $method, array $parameters)

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

из Macroable
mixed __call(string $method, array $parameters)

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

из Macroable
void __construct(Filesystem $files)

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

void configureUsingFluentDefinition()

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

из Command
void configureIsolation()

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

из Command
int run(InputInterface $input, OutputInterface $output)

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

из Command
int execute(InputInterface $input, OutputInterface $output)

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

из Command
CommandMutex commandIsolationMutex()

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

из Command
void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

из Command
bool isHidden()

{@inheritdoc}

из Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

из Command
Application getLaravel()

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

из Command
void setLaravel(Container $laravel)

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

из Command
void handle()

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

string parseKey(string $key)

Расшифровать ключ шифрования.

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string $command

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

Command

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

Настроить резервные варианты запросов.

Параметры

InputInterface $input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

protected ?string validatePrompt(mixed $value, mixed $rules)

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

Parameters

mixed $value
mixed $rules

Return Value

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Parameters

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

Return Value

Validator

protected array validationMessages()

Получить сообщения об ошибках валидации, которые должны использоваться во время проверки подсказок.

Return Value

array

protected array validationAttributes()

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

Return Value

array

protected void restorePrompts()

Восстановить вывод подсказок.

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

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|callable $choices, string|null $default = null)

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

Параметры

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

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

mixed

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

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

Параметры

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

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

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)

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

Параметры

OutputStyle $output

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

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

OutputStyle getOutput()

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

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

OutputStyle

Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Без описания

Параметры

$signals
$callback

void untrap()

internal

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

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

void

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

Взаимодействовать с пользователем перед валидацией входных данных.

Параметры

InputInterface $input
OutputInterface $output

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

void

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

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

Параметры

InputInterface $input
OutputInterface $output

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

void

protected array promptForMissingArgumentsUsing()

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

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

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(Filesystem $files)

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

Parameters

Filesystem $files

Return Value

void

protected void configureUsingFluentDefinition()

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

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

void

protected void configureIsolation()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected CommandMutex commandIsolationMutex()

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

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

CommandMutex

void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

Параметры

Throwable|string|null $exception

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

void

Исключения

Throwable

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

void handle()

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

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

void
END_OF_DOCUMENT_MARKER

protected string parseKey(string $key)

Обработать ключ шифрования.

Параметры

string $key

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

string

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

Spec-Zone.ru

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