AboutCommand
class AboutCommand extends Command (View source)
Свойства
| CallsCommands | |
| HasParameters | |
| InteractsWithIO | |
| InteractsWithSignals | |
| PromptsForMissingInput | |
| Macroable |
Свойства
| protected Factory internal | $components | Производитель компонентов консоли. | из InteractsWithIO |
| protected InputInterface | $input | Реализация интерфейса ввода. | из InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из InteractsWithIO |
| protected int | $verbosity | Уровень подробности по умолчанию для команд вывода. | из InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface. | из InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | из InteractsWithSignals |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected string | $signature | Подпись команды консоли. | |
| protected string | $name | Имя команды консоли. | из Command |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| static protected string|null deprecated | $defaultName | Имя команды консоли. | |
| protected Composer | $composer | Экземпляр Composer. | |
| static protected array | $data | Данные для отображения. | |
| static protected array | $customDataResolvers | Зарегистрированные вызываемые объекты, добавляющие пользовательские данные в вывод команды. |
Методы
| Команда | 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 | specifyParameters()
Указать аргументы и параметры команды. | из HasParameters |
| массив | getArguments()
Получить аргументы консольной команды. | из HasParameters |
| массив | getOptions()
Получить параметры консольной команды. | из HasParameters |
| bool | hasArgument(string|int $name)
Определить, существует ли заданный аргумент. | из InteractsWithIO |
| массив|строка|bool|null | argument(string|null $key = null)
Получить значение аргумента команды. | из InteractsWithIO |
| массив | arguments()
Получить все аргументы, переданные команде. | из InteractsWithIO |
| bool | hasOption(string $name)
Определить, существует ли заданный параметр. | из InteractsWithIO |
| строка|массив|bool|null | option(string|null $key = null)
Получить значение параметра команды. | из InteractsWithIO |
| массив | options()
Получить все параметры, переданные команде. | из InteractsWithIO |
| bool | confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя. | из InteractsWithIO |
| mixed | ask(string $question, string|null $default = null)
Запросить ввод у пользователя. | из InteractsWithIO |
| mixed | anticipate(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автозавершением. | из InteractsWithIO |
| mixed | askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автозавершением. | из InteractsWithIO |
| mixed | secret(string $question, bool $fallback = true)
Запросить ввод у пользователя, но скрыть ответ из консоли. | из InteractsWithIO |
| строка|массив | choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю один вариант из массива ответов. | из InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу. | из InteractsWithIO |
| mixed|void | withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, продвигая полосу прогресса. | из InteractsWithIO |
| void | info(string $string, int|string|null $verbosity = null)
Вывести строку как информацию. | из InteractsWithIO |
| void | line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку в стандартный вывод. | из InteractsWithIO |
| void | comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий. | из InteractsWithIO |
| void | question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос. | из 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 |
| void | trap(iterable<array-key,int>|int $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)
Проверяет, зарегистрировано ли макро. | from Macroable |
| static void | flushMacros()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обработать вызовы к классу. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обработать вызовы к классу. | from Macroable |
| void | __construct(Composer $composer)
Создать новый экземпляр команды. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | from Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Command |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Команда | setHidden(bool $hidden = true) {@inheritdoc} | из Команды |
| Приложение | getLaravel() Получить экземпляр приложения Laravel. | из Команды |
| void | setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel. | из Команды |
| int | handle() Выполнить консольную команду. | |
| void | display(Коллекция $data) Отобразить информацию об приложении. | |
| void | displayDetail(Коллекция $data) Отобразить информацию об приложении в виде подробностей. | |
| void | displayJson(Коллекция $data) Отобразить информацию об приложении в формате JSON. | |
| void | gatherApplicationInformation() Собрать информацию об приложении. | |
| bool | hasPhpFiles(string $path) Определить, содержит ли данный каталог файлы PHP. | |
| static void | add(string $section, callable|string|array $data, string $value = null) Добавить дополнительные данные в вывод команды "about". | |
| static void | addToSection(string $section, callable|string|array $data, string $value = null) Добавить дополнительные данные в вывод команды "about". | |
| array | sections() Получить разделы, предоставленные команде. |
Подробности
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр консольной команды для заданной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую консольную команду.
int callSilent(Command|string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
int callSilently(Command|string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Выполнить заданную консольную команду.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр входных данных из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
protected void specifyParameters()
Указать аргументы и параметры команды.
protected array getArguments()
Получить аргументы консольной команды.
protected array getOptions()
Получить параметры консольной команды.
bool hasArgument(string|int $name)
Определить, существует ли заданный аргумент.
array|string|bool|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|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить ввод у пользователя с автодополнением.
mixed secret(string $question, bool $fallback = true)
Запросить ввод у пользователя, но скрыть ответ из консоли.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю единственный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса.
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, int|string|null $verbosity = null)
Вывести строку в окне оповещения.
$this newLine(int $count = 1)
Написать пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
void trap(iterable<array-key,int>|int $signals, $callback)
Определить обратный вызов, который будет выполнен при возникновении заданного сигнала(ов).
void untrap()
| internal |
Отменить обработчики сигналов, установленные в обработчике команды.
protected void interact(InputInterface $input, OutputInterface $output)
Взаимодействие с пользователем перед проверкой ввода.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запросить у пользователя отсутствующие аргументы.
protected array promptForMissingArgumentsUsing()
Запрос отсутствующих аргументов ввода с использованием возвращенных вопросов.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнить действия после того, как пользователя попросили предоставить отсутствующие аргументы.
protected bool didReceiveOptions(InputInterface $input)
Наличие ввода каких-либо опций, отличающихся от значений по умолчанию.
static void macro(string $name, object|callable $macro)
Регистрация пользовательского макроса.
static void mixin(object $mixin, bool $replace = true)
Включение другого объекта в класс.
static bool hasMacro(string $name)
Проверка регистрации макроса.
static void flushMacros()
Очистка существующих макросов.
static mixed __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса.
mixed __call(string $method, array $parameters)
Динамическая обработка вызовов класса.
void __construct(Composer $composer)
Создание нового экземпляра команды.
protected void configureUsingFluentDefinition()
Настройка консольной команды с помощью определения fluent.
protected void configureIsolation()
Настройка консольной команды для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запуск консольной команды.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнение консольной команды.
protected CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
int handle()
Выполнить консольную команду.
protected void display(Collection $data)
Отобразить информацию об приложении.
protected void displayDetail(Collection $data)
Отобразить информацию об приложении в виде детализации.
protected void displayJson(Collection $data)
Отобразить информацию об приложении в формате JSON.
protected void gatherApplicationInformation()
Собрать информацию об приложении.
protected bool hasPhpFiles(string $path)
Определить, содержит ли заданный каталог файлы PHP.
static void add(string $section, callable|string|array $data, string $value = null)
Добавить дополнительные данные в вывод команды "about".
static protected void addToSection(string $section, callable|string|array $data, string $value = null)
Добавить дополнительные данные в вывод команды "about".
protected array sections()
Получить разделы, предоставленные команде.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Foundation/Console/AboutCommand.html
