RouteListCommand
класс RouteListCommand расширяет Command (Просмотреть исходный код)
Трейты
| CallsCommands | |
| HasParameters | |
| InteractsWithIO | |
| Macroable |
Свойства
| protected InputInterface | $input | Реализация интерфейса ввода. | из InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из InteractsWithIO |
| protected int | $verbosity | Уровень подробности вывода по умолчанию для команд. | из InteractsWithIO |
| protected array | $verbosityMap | Сопоставление уровней подробности, читаемых человеком, и уровней OutputInterface Symfony. | из InteractsWithIO |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected string | $signature | Имя и сигнатура команды консоли. | из Command |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string|null | $help | Текст справки команды консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected Router | $router | Экземпляр маршрутизатора. | |
| protected array | $headers | Заголовки таблицы для команды. | |
| protected array | $compactColumns | Столбцы для отображения при использовании флага «compact». |
Методы
| Command | resolveCommand(Command|string $command) Разрешить экземпляр консольной команды для данной команды. | from CallsCommands |
| int | call(Command|string $command, array $arguments = []) Вызвать другую консольную команду. | from CallsCommands |
| int | callSilent(Command|string $command, array $arguments = []) Вызвать другую консольную команду без вывода. | from CallsCommands |
| int | runCommand(Command|string $command, array $arguments, OutputInterface $output) Запустить заданную консольную команду. | from CallsCommands |
| ArrayInput | createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов. | from CallsCommands |
| array | context() Получить весь контекст, переданный команде. | from CallsCommands |
| void | specifyParameters() Указать аргументы и опции команды. | from HasParameters |
| array | getArguments() Получить аргументы консольной команды. | from HasParameters |
| array | getOptions() Получить опции консольной команды. | |
| bool | hasArgument(string|int $name) Определить, присутствует ли данный аргумент. | from InteractsWithIO |
| string|array|null | argument(string|null $key = null) Получить значение аргумента команды. | from InteractsWithIO |
| array | arguments() Получить все аргументы, переданные команде. | from InteractsWithIO |
| bool | hasOption(string $name) Определить, присутствует ли данная опция. | from InteractsWithIO |
| string|array|bool|null | option(string|null $key = null) Получить значение опции команды. | from InteractsWithIO |
| array | options() Получить все опции, переданные команде. | from InteractsWithIO |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя. | from InteractsWithIO |
| mixed | ask(string $question, string|null $default = null) Запросить ввод у пользователя. | from InteractsWithIO |
| mixed | anticipate(string $question, array|callable $choices, string|null $default = null) Запросить у пользователя ввод с автодополнением. | from InteractsWithIO |
| mixed | askWithCompletion(string $question, array|callable $choices, string|null $default = null) Запросить у пользователя ввод с автодополнением. | from InteractsWithIO |
| mixed | secret(string $question, bool $fallback = true) Запросить у пользователя ввод, но скрыть ответ в консоли. | from InteractsWithIO |
| string | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null) Предложить пользователю один вариант из массива ответов. | from InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу. | from InteractsWithIO |
| void | info(string $string, int|string|null $verbosity = null) Вывести строку как информацию. | from 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) Вывести строку в окне оповещения. | from InteractsWithIO |
| void | setInput(InputInterface $input)
Установить реализацию интерфейса ввода. | из InteractsWithIO |
| void | setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода. | из InteractsWithIO |
| void | setVerbosity(string|int $level)
Установить уровень подробности. | из InteractsWithIO |
| int | parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony. | из InteractsWithIO |
| OutputStyle | getOutput()
Получить реализацию вывода. | из InteractsWithIO |
| static void | macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро. | из Macroable |
| static void | mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс. | из Macroable |
| static bool | hasMacro(string $name)
Проверяет, зарегистрировано ли макро. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу. | из Macroable |
| void | __construct(Router $router)
Создать новый экземпляр команды маршрута. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения Fluent. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| mixed | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Command |
| isHidden() {@inheritdoc} | из Command | |
| setHidden($hidden) {@inheritdoc} | из Command | |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | из Command |
| void | handle()
Выполнить команду консоли. | |
| array | getRoutes()
Скомпилировать маршруты в отображаемый формат. | |
| array | getRouteInformation(Route $route)
Получить информацию о маршруте для заданного маршрута. | |
| array | sortRoutes(string $sort, array $routes)
Отсортировать маршруты по заданному элементу. | |
| array | pluckColumns(array $routes)
Удалить ненужные столбцы из маршрутов. | |
| void | displayRoutes(array $routes)
Отобразить информацию о маршрутах в консоли. | |
| string | getMiddleware(Route $route)
Получить фильтры до выполнения. | |
| array|null | filterRoute(array $route)
Отфильтровать маршрут по URI и/или имени. | |
| array | getHeaders()
Получить заголовки таблицы для видимых столбцов. | |
| array | getColumns()
Получить имена столбцов для отображения (нижние регистры заголовков таблицы). | |
| array | parseColumns(array $columns)
Обработать список столбцов. |
Details
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр команды консоли для данной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(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)
Определить, присутствует ли заданный аргумент.
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|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 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 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()
Получить реализацию вывода.
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(Router $router)
Создать новый экземпляр команды маршрута.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
isHidden()
{@inheritdoc}
setHidden($hidden)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
void handle()
Выполнить командную строку.
protected array getRoutes()
Компилировать маршруты в отображаемый формат.
protected array getRouteInformation(Route $route)
Получить информацию о маршруте для заданного маршрута.
protected array sortRoutes(string $sort, array $routes)
Сортировать маршруты по заданному элементу.
protected array pluckColumns(array $routes)
Удалить ненужные столбцы из маршрутов.
protected void displayRoutes(array $routes)
Отобразить информацию о маршрутах в консоли.
protected string getMiddleware(Route $route)
Получить фильтры до выполнения.
protected array|null filterRoute(array $route)
Отфильтровать маршрут по URI и/или имени.
protected array getHeaders()
Получить заголовки таблицы для видимых столбцов.
protected array getColumns()
Получить имена столбцов для отображения (заголовки таблицы в нижнем регистре).
protected array parseColumns(array $columns)
Проанализировать список столбцов.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Foundation/Console/RouteListCommand.html
