DocsCommand
class DocsCommand extends Команда (Просмотреть исходный код)
Трейты
| ВызываетКоманды | |
| НастраиваетПодсказки | |
| СодержитПараметры | |
| ВзаимодействуетСВводомВыводом | |
| ВзаимодействуетССигналами | |
| ЗапрашиваетОтсутствующийВвод | |
| Макроспособный |
Свойства
| protected Фабрика внутренний | $components | Фабрика компонентов консоли. | из ВзаимодействуетСВводомВыводом |
| protected InputInterface | $input | Реализация интерфейса ввода. | из ВзаимодействуетСВводомВыводом |
| protected СтильВывода | $output | Реализация интерфейса вывода. | из ВзаимодействуетСВводомВыводом |
| protected int | $verbosity | Уровень детализации вывода по умолчанию для команд. | из ВзаимодействуетСВводомВыводом |
| protected array | $verbosityMap | Сопоставление уровней детализации, читаемых человеком, и уровней Symfony OutputInterface. | из ВзаимодействуетСВводомВыводом |
| protected Сигналы|null | $signals | Экземпляр регистратора сигналов. | из ВзаимодействуетССигналами |
| static protected array | $macros | Зарегистрированные макросы строк. | из Макроспособный |
| protected Приложение | $laravel | Экземпляр приложения Laravel. | из Команда |
| protected string | $signature | Имя и сигнатура команды консоли. | |
| protected string | $name | Имя команды консоли. | из Команда |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Команда | |
| protected bool | $isolated | Указывает, может ли выполняться только один экземпляр команды в данный момент. | из Команда |
| protected int | $isolatedExitCode | Код выхода по умолчанию для изолированных команд. | из Команда |
| protected array | $aliases | Псевдонимы имени команды консоли. | из Команда |
| protected Фабрика | $http | Экземпляр HTTP-клиента. | |
| protected Репозиторий | $cache | Реализация репозитория кеша. | |
| protected callable|null | $urlOpener | Пользовательский открыватель URL. | |
| protected string|null | $version | Пользовательская версия документации для открытия. | |
| protected string | $systemOsFamily | Семейство операционных систем. |
Методы
| Команда | resolveCommand(Команда|строка $command)
Разрешить экземпляр консольной команды для заданной команды. | из CallsCommands |
| целое число | call(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду. | из CallsCommands |
| целое число | callSilent(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду без вывода. | из CallsCommands |
| целое число | callSilently(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду без вывода. | из CallsCommands |
| целое число | runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)
Запустить заданную консольную команду. | из CallsCommands |
| ArrayInput | createInputFromArguments(массив $arguments)
Создать экземпляр ввода из заданных аргументов. | из CallsCommands |
| массив | context()
Получить весь контекст, переданный команде. | из CallsCommands |
| void | configurePrompts(InputInterface $input)
Настроить отступы подсказок. | из ConfiguresPrompts |
| смешанный | promptUntilValid(Closure $prompt, bool|строка $required, Closure|null $validate)
Выводить подсказки пользователю, пока не выполнится заданный обратный вызов проверки. | из ConfiguresPrompts |
| void | restorePrompts()
Восстановить вывод подсказок. | из ConfiguresPrompts |
| void | specifyParameters()
Указать аргументы и параметры команды. | из HasParameters |
| массив | getArguments()
Получить аргументы консольной команды. | из HasParameters |
| массив | getOptions()
Получить параметры консольной команды. | из HasParameters |
| bool | hasArgument(строка|целое число $name)
Определить, присутствует ли заданный аргумент. | из InteractsWithIO |
| массив|строка|bool|null | argument(строка|null $key = null)
Получить значение аргумента команды. | из InteractsWithIO |
| массив | arguments()
Получить все аргументы, переданные команде. | из InteractsWithIO |
| bool | hasOption(строка $name)
Определить, присутствует ли заданный параметр. | из InteractsWithIO |
| строка|массив|bool|null | option(строка|null $key = null)
Получить значение параметра команды. | из InteractsWithIO |
| массив | options()
Получить все параметры, переданные команде. | из InteractsWithIO |
| bool | confirm(строка $question, bool $default = false)
Подтвердить вопрос у пользователя. | из InteractsWithIO |
| смешанный | ask(строка $question, строка|null $default = null)
Задать вопрос пользователю. | из InteractsWithIO |
| смешанный | anticipate(строка $question, массив|вызываемый $choices, строка|null $default = null)
Задать вопрос пользователю с автозавершением. | из InteractsWithIO |
| смешанный | askWithCompletion(строка $question, массив|вызываемый $choices, строка|null $default = null)
Задать вопрос пользователю с автозавершением. | из InteractsWithIO |
| смешанный | secret(строка $question, bool $fallback = true)
Задать вопрос пользователю, но скрыть ответ в консоли. | из InteractsWithIO |
| строка|массив | choice(строка $question, массив $choices, строка|целое число|null $default = null, смешанный|null $attempts = null, bool $multiple = false)
Предложить пользователю выбрать один вариант из массива ответов. | из InteractsWithIO |
| void | table(массив $headers, Arrayable|массив $rows, TableStyle|строка $tableStyle = 'default', массив $columnStyles = [])
Форматировать ввод в текстовую таблицу. | из InteractsWithIO |
| смешанный|void | withProgressBar(iterable|целое число $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса. | из InteractsWithIO |
| void | info(строка $string, целое число|строка|null $verbosity = null)
Записать строку в качестве информации. | из 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)
Проверка наличия зарегистрированного макро. | 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()
Создать новый экземпляр команды консоли. | from Command |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить консольную команду. | from Команда |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить консольную команду. | from Команда |
| CommandMutex | commandIsolationMutex()
Получить экземпляр мьютекса изоляции команд для команды. | from Команда |
| bool | isHidden() {@inheritdoc} | from Команда |
| Команда | setHidden(bool $hidden = true) {@inheritdoc} | from Команда |
| Приложение | getLaravel()
Получить экземпляр приложения Laravel. | from Команда |
| void | setLaravel(Контейнер $laravel)
Установить экземпляр приложения Laravel. | from Команда |
| void | configure()
Настроить текущую команду. | |
| int | handle(Фабрика $http, Репозиторий $cache)
Выполнить консольную команду. | |
| void | openUrl()
Открыть URL документации. | |
| string | url()
URL страницы документации. | |
| string | page()
Открываемая страница. | |
| string|null | resolvePage()
Определение страницы для открытия. | |
| bool | didNotRequestPage()
Определение, запрашивал ли пользователь конкретную страницу при вызове команды. | |
| string|null | askForPage()
Запрос у пользователя, какую страницу он хочет открыть. | |
| string|null | askForPageViaCustomStrategy()
Запрос у пользователя, какую страницу он хочет открыть с помощью пользовательской стратегии. | |
| string|null | askForPageViaAutocomplete()
Запрос у пользователя, какую страницу он хочет открыть с автодополнением. | |
| string|null | guessPage($search)
Предположение о странице, которую пользователь пытается открыть. | |
| string|null | section(string $page)
Раздел, который пользователь специально запросил открыть. | |
| bool | didNotRequestSection()
Определение, запрашивал ли пользователь конкретный раздел при вызове команды. | |
| string|null | guessSection(string $page)
Предположение о разделе, который пользователь пытается открыть. | |
| void | open(string $url)
Открыть URL в браузере пользователя. | |
| void | openViaCustomStrategy(string $url)
Открыть URL с помощью пользовательской стратегии. | |
| void | openViaBuiltInStrategy(string $url)
Открыть URL с помощью встроенной стратегии. | |
| Коллекция | sectionsFor(string $page)
Доступные разделы для страницы. | |
| Коллекция | pages()
Доступные страницы для открытия. | |
| Коллекция | docs()
Получение индекса документации в виде коллекции. | |
| void | refreshDocs()
Обновить кэшированную копию индекса документации. | |
| Ответ | fetchDocs()
Получение индекса документации с веб-сайта Laravel. | |
| string | version()
Определение версии документации для открытия. | |
| string | searchQuery()
Запрос поиска, предоставленный пользователем. | |
| bool | isSearching()
Определение, предназначена ли команда для выполнения поиска. | |
| $this | setVersion(string $version)
Установить версию документации. | |
| $this | setUrlOpener(callable|null $opener)
Установить пользовательскую функцию открытия URL. | |
| $this | setSystemOsFamily(string $family)
Установить семейство операционной системы системы. |
Подробное описание
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 configurePrompts(InputInterface $input)
Настроить отступы запросов.
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Запрашивать у пользователя, пока не будет выполнено заданное условие валидации.
protected void restorePrompts()
Восстановить вывод запросов.
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()
Получить реализацию вывода.
Factory outputComponents()
Получить реализацию фабрики компонентов вывода.
trap($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()
Создание нового экземпляра команды консоли.
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.
protected void configure()
Настройка текущей команды.
int handle(Factory $http, Repository $cache)
Выполнение команды консоли.
protected void openUrl()
Открыть URL документации.
protected string url()
URL страницы документации.
protected string page()
Страница, которую открывает пользователь.
protected string|null resolvePage()
Определение страницы для открытия.
protected bool didNotRequestPage()
Определение, запросил ли пользователь конкретную страницу при вызове команды.
protected string|null askForPage()
Запрос у пользователя, какую страницу он хочет открыть.
protected string|null askForPageViaCustomStrategy()
Запрос у пользователя, какую страницу он хочет открыть, используя пользовательскую стратегию.
protected string|null askForPageViaAutocomplete()
Запрос у пользователя, какую страницу он хочет открыть, используя автодополнение.
protected string|null guessPage($search)
Предположение о странице, которую пытается открыть пользователь.
protected string|null section(string $page)
Раздел, который пользователь специально запросил для открытия.
protected bool didNotRequestSection()
Определение, запросил ли пользователь конкретный раздел при вызове команды.
protected string|null guessSection(string $page)
Предположение о разделе, который пытается открыть пользователь.
protected void open(string $url)
Открыть URL в браузере пользователя.
protected void openViaCustomStrategy(string $url)
Открыть URL с помощью пользовательской стратегии.
protected void openViaBuiltInStrategy(string $url)
Открыть URL с помощью встроенной стратегии.
Коллекция sectionsFor(string $page)
Доступные разделы для страницы.
Коллекция pages()
Доступные страницы для открытия.
Коллекция docs()
Получить индекс документации как коллекцию.
protected void refreshDocs()
Обновить кэшированную копию индекса документации.
protected Ответ fetchDocs()
Получить индекс документации с веб-сайта Laravel.
protected string version()
Определение версии документации для открытия.
protected string searchQuery()
Запрос поиска, предоставленный пользователем.
protected bool isSearching()
Определение, предназначена ли команда для выполнения поиска.
$this setVersion(string $version)
Установить версию документации.
$this setUrlOpener(callable|null $opener)
Установить пользовательский открыватель URL.
$this setSystemOsFamily(string $family)
Установить семейство операционных систем системы.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Foundation/Console/DocsCommand.html
