RouteListCommand
class RouteListCommand extends Команда (Просмотреть исходный код)
Трейты
| CallsCommands | |
| HasParameters | |
| InteractsWithIO | |
| Macroable |
Свойства
| protected InputInterface | $input | Реализация интерфейса ввода. | из InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из InteractsWithIO |
| protected int | $verbosity | Уровень подробности вывода по умолчанию. | из InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности и Symfony's OutputInterface. | из InteractsWithIO |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Команда |
| protected string | $signature | Имя и подпись командной строки. | из Команда |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки команды консоли. | из Команда |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Команда | |
| protected Маршрутизатор | $router | Экземпляр маршрутизатора. | |
| protected string[] | $headers | Заголовки таблицы для команды. | |
| protected string[] | $compactColumns | Столбцы для отображения при использовании флага «compact». |
Методы
| Команда | 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()
Получить параметры консольной команды. | |
| bool | hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент. | из InteractsWithIO |
| string|массив|null | argument(string|null $key = null)
Получить значение аргумента команды. | из InteractsWithIO |
| массив | arguments()
Получить все аргументы, переданные команде. | из InteractsWithIO |
| bool | hasOption(string $name)
Определить, присутствует ли заданный параметр. | из InteractsWithIO |
| string|массив|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 |
| string|массив | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю один вариант из массива ответов. | из InteractsWithIO |
| void | table(array $headers, Arrayable|array $rows, 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)
Вывести строку как сообщение об ошибке. | из InteractsWithIO |
| void | warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение. | from InteractsWithIO |
| void | alert(string $string)
Вывести строку в окне оповещения. | from InteractsWithIO |
| void | 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 |
| 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(Router $router)
Создать новый экземпляр команды маршрута. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | from Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Command | setHidden(bool $hidden) {@inheritdoc} | from Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | from 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)
Обработать список столбцов. | |
| string | asJson(array $routes)
Преобразовать заданные маршруты в JSON. |
Details
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)
Определить, присутствует ли данный аргумент.
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|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю один вариант из массива ответов.
void table(array $headers, Arrayable|array $rows, 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)
Вывод строки в диалоговом окне.
void 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()
Получение реализации вывода.
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)
Динамическая обработка вызовов класса.
смешанный тип __call(string $method, array $parameters)
Динамическая обработка вызовов класса.
void __construct(Маршрутизатор $router)
Создание нового экземпляра команды маршрута.
protected void configureUsingFluentDefinition()
Настройка команды консоли с помощью определения с использованием fluent интерфейса.
int run(InputInterface $input, OutputInterface $output)
Запуск команды консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнение команды консоли.
bool isHidden()
{@inheritdoc}
Команда setHidden(bool $hidden)
{@inheritdoc}
Приложение getLaravel()
Получение экземпляра приложения Laravel.
void setLaravel(Контейнер $laravel)
Указание экземпляра приложения Laravel.
void handle()
Выполнение команды консоли.
protected array getRoutes()
Компиляция маршрутов в отображаемый формат.
protected array getRouteInformation(Маршрут $route)
Получение информации о маршруте.
protected array sortRoutes(string $sort, array $routes)
Сортировка маршрутов по заданному элементу.
protected array pluckColumns(array $routes)
Удаление ненужных столбцов из маршрутов.
protected void displayRoutes(array $routes)
Вывод информации о маршрутах в консоли.
protected string getMiddleware(Маршрут $route)
Получение среднего программного обеспечения для маршрута.
protected array|null filterRoute(array $route)
Фильтрация маршрута по URI и/или имени.
protected array getHeaders()
Получение заголовков таблицы для видимых столбцов.
protected array getColumns()
Получение имён столбцов для отображения (строчные заголовки таблицы).
protected array parseColumns(array $columns)
Разбор списка столбцов.
protected string asJson(array $routes)
Преобразование заданных маршрутов в JSON.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Foundation/Console/RouteListCommand.html
