RouteListCommand
class RouteListCommand 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 Маршрутизатор | $router | Экземпляр маршрутизатора. | |
| protected string[] | $headers | Заголовки таблицы для команды. | |
| static protected Closure|null | $terminalWidthResolver | Обратный вызов для определения ширины терминала. | |
| protected array | $verbColors | Цвета глаголов для команды. |
Методы
| Команда | 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 | configurePrompts(InputInterface $input)
Настроить отступы подсказок. | из ConfiguresPrompts |
| смешанный | promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Запрашивать у пользователя данные до тех пор, пока не будет выполнено заданное проверкой обратное вызов. | из ConfiguresPrompts |
| ?string | validatePrompt(mixed $value, mixed $rules)
Проверить значение заданной подсказки с помощью валидатора. | из ConfiguresPrompts |
| Validator | getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки подсказок. | из ConfiguresPrompts |
| массив | validationMessages()
Получить сообщения валидации, которые следует использовать во время проверки подсказок. | из ConfiguresPrompts |
| массив | validationAttributes()
Получить атрибуты валидации, которые следует использовать во время проверки подсказок. | из ConfiguresPrompts |
| void | restorePrompts()
Восстановить вывод подсказок. | из ConfiguresPrompts |
| void | specifyParameters()
Указать аргументы и параметры команды. | из HasParameters |
| массив | getArguments()
Получить аргументы консольной команды. | из HasParameters |
| массив | getOptions()
Получить параметры консольной команды. | |
| 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 |
| смешанный | ask(string $question, string|null $default = null)
Задать вопрос пользователю для получения ввода. | из InteractsWithIO |
| смешанный | anticipate(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автодополнением. | из InteractsWithIO |
| смешанный | askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автодополнением. | из InteractsWithIO |
| смешанный | secret(string $question, bool $fallback = true)
Задать вопрос пользователю, но скрыть ответ в консоли. | из InteractsWithIO |
| string|array | 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)
Вывод строки как ошибку. | из InteractsWithIO |
| void | warn(string $string, int|string|null $verbosity = null)
Вывод строки как предупреждение. | из InteractsWithIO |
| void | alert(string $string, int|string|null $verbosity = null)
Вывод строки в окне предупреждения. | из InteractsWithIO |
| $this | newLine(int $count = 1)
Вывод пустой строки. | из 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 |
| Factory | outputComponents()
Получение реализации фабрики компонентов вывода. | из InteractsWithIO |
| trap($signals, $callback) Без описания | из InteractsWithSignals | |
| void | untrap()
Отключение обработчиков сигналов, установленных в обработчике команды. | из InteractsWithSignals |
| void | interact(InputInterface $input, OutputInterface $output)
Взаимодействие с пользователем перед валидацией ввода. | из PromptsForMissingInput |
| void | promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запрос у пользователя отсутствующих аргументов. | из PromptsForMissingInput |
| array | promptForMissingArgumentsUsing()
Запрос отсутствующих аргументов ввода, используя возвращенные вопросы. | из PromptsForMissingInput |
| void | afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнение действий после запроса у пользователя отсутствующих аргументов. | из PromptsForMissingInput |
| bool | didReceiveOptions(InputInterface $input)
Содержит ли ввод какие-либо параметры, отличающиеся от значений по умолчанию? | из PromptsForMissingInput |
| 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 void | flushMacros()
Очистка существующих макросов. | из Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса. | из Macroable |
| void | __construct(Router $router)
Создает новый экземпляр команды маршрута. | |
| void | configureUsingFluentDefinition()
Настраивает команду консоли с помощью определения fluent. | из Command |
| void | configureIsolation()
Настраивает команду консоли для изоляции. | из Command |
| int | run(InputInterface $input, OutputInterface $output)
Запускает команду консоли. | из Command |
| int | execute(InputInterface $input, OutputInterface $output)
Выполняет команду консоли. | из Command |
| CommandMutex | commandIsolationMutex()
Получает экземпляр мьютекса изоляции команды для команды. | из Command |
| void | fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой. | из Command |
| bool | isHidden() {@inheritdoc} | из Command |
| Command | setHidden(bool $hidden = true) {@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)
Получить промежуточное ПО для маршрута. | |
| bool | isVendorRoute(Route $route)
Определить, был ли маршрут определен за пределами приложения. | |
| bool | isFrameworkController(Route $route)
Определить, использует ли маршрут фреймворковый контроллер. | |
| array|null | filterRoute(array $route)
Отфильтровать маршрут по URI и/или имени. | |
| array | getHeaders()
Получить заголовки таблицы для видимых столбцов. | |
| array | getColumns()
Получить имена столбцов для отображения (строчные заголовки таблицы). | |
| array | parseColumns(array $columns)
Обработать список столбцов. | |
| string | asJson(Collection $routes)
Преобразовать заданные маршруты в JSON. | |
| array | forCli(Collection $routes)
Преобразовать заданные маршруты в обычный вывод CLI. | |
| string | formatActionForCli(array $route)
Получить отформатированное действие для отображения в CLI. | |
| string | determineRouteCountOutput(Collection $routes, int $terminalWidth)
Определить и вернуть вывод для отображения количества маршрутов в выводе CLI. | |
| static int | getTerminalWidth()
Получить ширину терминала. | |
| static void | resolveTerminalWidthUsing(Closure|null $resolver)
Установить обратный вызов, который следует использовать при разрешении ширины терминала. |
Подробности
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 ?string validatePrompt(mixed $value, mixed $rules)
Проверить заданное значение подсказки с помощью валидатора.
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки подсказок.
protected array validationMessages()
Получить сообщения об ошибках валидации, которые следует использовать при проверке подсказок.
protected array validationAttributes()
Получить атрибуты валидации, которые следует использовать при проверке подсказок.
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()
| внутренний |
Отменить обработку сигналов, установленных в обработчике команды.
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(Router $router)
Создать новый экземпляр команды маршрута.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения Fluent.
protected void configureIsolation()
Настроить команду консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected CommandMutex commandIsolationMutex()
Получить экземпляр взаимного исключения изоляции команды для команды.
void fail(Throwable|string|null $exception = null)
Принудительно завершить выполнение команды с ошибкой.
bool isHidden()
{@inheritdoc}
Команда setHidden(bool $hidden = true)
{@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 bool isVendorRoute(Маршрут $route)
Определить, был ли маршрут определен за пределами приложения.
protected bool isFrameworkController(Маршрут $route)
Определить, использует ли маршрут контроллер фреймворка.
protected array|null filterRoute(array $route)
Отфильтровать маршрут по URI и/или имени.
protected array getHeaders()
Получить заголовки таблицы для видимых столбцов.
protected array getColumns()
Получить имена столбцов для отображения (нижние регистры заголовков таблицы).
protected array parseColumns(array $columns)
Проанализировать список столбцов.
protected string asJson(Коллекция $routes)
Преобразовать заданные маршруты в JSON.
protected array forCli(Коллекция $routes)
Преобразовать заданные маршруты в обычный вывод CLI.
protected string formatActionForCli(array $route)
Получить отформатированное действие для отображения в CLI.
protected string determineRouteCountOutput(Коллекция $routes, int $terminalWidth)
Определить и вернуть вывод для отображения количества маршрутов в выводе CLI.
static int getTerminalWidth()
Получить ширину терминала.
static void resolveTerminalWidthUsing(Closure|null $resolver)
Установить обратный вызов, который должен использоваться при определении ширины терминала.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/RouteListCommand.html