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