Команда
класс Команда расширяет Command (Просмотреть исходный код)
Трейты
| Macroable |
Свойства
| статический защищённый массив | $macros | Зарегистрированные строковые макросы. | из Macroable |
| защищённый Приложение | $laravel | Экземпляр приложения Laravel. | |
| защищённый InputInterface | $input | Реализация интерфейса ввода. | |
| защищённый Стиль вывода | $output | Реализация интерфейса вывода. | |
| защищённая строка | $signature | Имя и сигнатура команды консоли. | |
| защищённая строка | $name | Имя команды консоли. | |
| защищённая строка | $description | Описание команды консоли. | |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | ||
| защищённый int | $verbosity | Уровень подробности вывода команд по умолчанию. | |
| защищённый массив | $verbosityMap | Сопоставление удобочитаемых уровней подробности с уровнями OutputInterface Symfony. |
Методы
| 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() Создать новый экземпляр команды консоли. | |
| 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) Создать экземпляр ввода из заданных аргументов. | |
| bool | hasArgument(string|int $name) Определить, присутствует ли данный аргумент. | |
| string|array|null | argument(string|null $key = null) Получить значение аргумента команды. | |
| array | arguments() Получить все переданные аргументы команды. | |
| bool | hasOption(string $name) Определить, присутствует ли данная опция. | |
| string|array|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 $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) Получить уровень подробности в терминах уровня Symfony's OutputInterface. | |
| 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)
Смешать другой объект в класс.
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|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли заданная опция.
string|array|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 $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.
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.7/Illuminate/Console/Command.html
