EnvironmentCommand
class EnvironmentCommand extends Command (View source)
Особенности
| 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 | Имя и сигнатура командной строки. | from Command |
| protected string | $name | Имя командной строки. | |
| protected string | $description | Описание командной строки. | |
| $hidden | Указывает, должно ли отображаться команд в списке Artisan. | from Command | |
| protected int | $verbosity | Уровень подробности вывода по умолчанию. | from Command |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности с уровнями OutputInterface Symfony. | from Command |
Методы
| 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) Вывести строку в всплывающем окне. | из Command |
| void | setVerbosity(string|int $level) Установить уровень подробности. | из Command |
| int | parseVerbosity(string|int $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony. | из Command |
| array | getArguments() Получить аргументы командной строки. | из Command |
| array | getOptions() Получить параметры командной строки. | из Command |
| OutputInterface | getOutput() Получить реализацию вывода. | из Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | из Command |
| void | handle() Выполнить команду консоли. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin)
Добавить другой объект в класс.
static bool hasMacro(string $name)
Проверить, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обработать вызовы к классу.
void __construct()
Создать новый экземпляр команды консоли.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
protected void specifyParameters()
Указать аргументы и параметры команды.
int run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
int call(string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(string $command, array $arguments = [])
Вызвать другую команду консоли в бесшумном режиме.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
bool hasArgument(string|int $name)
Определить, существует ли заданный аргумент.
string|array argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данный параметр.
string|array option(string $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
string ask(string $question, string $default = null)
Запросить ввод от пользователя.
string anticipate(string $question, array $choices, string $default = null)
Запросить ввод от пользователя с автозаполнением.
string askWithCompletion(string $question, array $choices, string $default = null)
Запросить ввод от пользователя с автозаполнением.
string secret(string $question, bool $fallback = true)
Запросить ввод от пользователя, скрывая ответ в консоли.
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)
Предложить пользователю один вариант из массива ответов.
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматировать входные данные в текстовую таблицу.
void info(string $string, null|int|string $verbosity = null)
Вывести строку как информацию.
void line(string $string, string $style = null, null|int|string $verbosity = null)
Вывести строку как стандартный вывод.
void comment(string $string, null|int|string $verbosity = null)
Вывести строку как комментарий.
void question(string $string, null|int|string $verbosity = null)
Вывести строку как вопрос.
void error(string $string, null|int|string $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, null|int|string $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string)
Вывести строку в всплывающем окне.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int $level = null)
Получить уровень подробности с точки зрения уровня OutputInterface Symfony.
protected array getArguments()
Получить аргументы командной строки.
protected array getOptions()
Получить параметры команды консоли.
OutputInterface getOutput()
Получить реализацию вывода.
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
void handle()
Выполнить команду консоли.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Foundation/Console/EnvironmentCommand.html
