RouteListCommand

class RouteListCommand extends Command (View source)

Свойства

CallsCommands

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	from InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	from InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	from InteractsWithIO
protected int	$verbosity	Уровень подробности вывода команд по умолчанию.	from InteractsWithIO
protected array	$verbosityMap	Сопоставление удобочитаемых уровней подробности и уровней Symfony OutputInterface.	from InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	from InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	from Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	from Command
protected string	$signature	Имя и сигнатура команды консоли.	from Command
protected string	$name	Имя команды консоли.
protected string	$description	Описание команды консоли.
protected string	$help	Текст справки команды консоли.	from Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
static protected string\|null deprecated	$defaultName	Имя команды консоли.
protected Router	$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	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
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) Вывести строку как сообщение об ошибке.	из 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
void	trap(iterable<array-key,int>\|int $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.	из Команда
void	configureIsolation() Настроить команду консоли для изоляции.	из Команда
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	из Команда
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Команда
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команд для команды.	из Команда
bool	isHidden() {@inheritdoc}	из Команда
Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команда

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
void	handle() Выполнить консольную команду.
массив	getRoutes() Скомпилировать маршруты в отображаемый формат.
массив	getRouteInformation(Маршрут $route) Получить информацию о маршруте.
массив	sortRoutes(string $sort, array $routes) Отсортировать маршруты по заданному элементу.
массив	pluckColumns(array $routes) Удалить ненужные столбцы из маршрутов.
void	displayRoutes(array $routes) Отобразить информацию о маршрутах в консоли.
строка	getMiddleware(Маршрут $route) Получить мидлварь для маршрута.
boolean	isVendorRoute(Маршрут $route) Определить, был ли маршрут определён вне приложения.
boolean	isFrameworkController(Маршрут $route) Определить, использует ли маршрут фреймворковый контроллер.
массив\|null	filterRoute(array $route) Отфильтровать маршрут по URI и/или имени.
массив	getHeaders() Получить заголовки таблицы для отображаемых столбцов.
массив	getColumns() Получить имена столбцов для отображения (строчные заголовки таблицы).
массив	parseColumns(array $columns) Обработать список столбцов.
строка	asJson(Коллекция $routes) Преобразовать заданные маршруты в JSON.
массив	forCli(Коллекция $routes) Преобразовать заданные маршруты в обычный вывод CLI.
строка	formatActionForCli(array $route) Получить отформатированное действие для отображения в CLI.
строка	determineRouteCountOutput(Коллекция $routes, int $terminalWidth) Определить и вернуть вывод для отображения количества маршрутов в выводе CLI.
статический int	getTerminalWidth() Получить ширину терминала.
статический void	resolveTerminalWidthUsing(Closure\|null $resolver) Установить обратный вызов, который следует использовать при определении ширины терминала.

Подробности

абстрактный защищённый Команда resolveCommand(Команда|строка $command)

Разрешить экземпляр консольной команды для заданной команды.

Параметры

Команда|строка

$command

Возвращаемое значение

Команда

int call(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments

Возвращаемое значение

int

int callSilent(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

Возвращаемое значение

int

int callSilently(Команда|строка $command, массив $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

Команда\|строка	$command
массив	$arguments

Возвращаемое значение

int

защищённый int runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

Выполнить заданную консольную команду.

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

Возвращаемое значение

int

защищённый ArrayInput createInputFromArguments(массив $arguments)

Создать экземпляр ввода из заданных аргументов.

Параметры

массив

$arguments

Возвращаемое значение

ArrayInput

защищённый массив context()

Получить весь контекст, переданный команде.

Возвращаемое значение

массив

защищённый void specifyParameters()

Указать аргументы и опции для команды.

Возвращаемое значение

void

защищённый массив getArguments()

Получить аргументы консольной команды.

Возвращаемое значение

массив

защищённый массив getOptions()

Получить опции консольной команды.

Возвращаемое значение

массив

bool hasArgument(строка|int $name)

Определить, присутствует ли указанный аргумент.

Параметры

строка|int

$name

Возвращаемое значение

bool

array|string|bool|null argument(string|null $key = null)

Получить значение аргумента команды.

Параметры

string|null

$key

Возвращаемое значение

array|string|bool|null

array arguments()

Получить все аргументы, переданные команде.

Возвращаемое значение

array

bool hasOption(string $name)

Определить, присутствует ли данный параметр.

Параметры

string

$name

Возвращаемое значение

bool

string|array|bool|null option(string|null $key = null)

Получить значение параметра команды.

Параметры

string|null

$key

Возвращаемое значение

string|array|bool|null

array options()

Получить все параметры, переданные команде.

Возвращаемое значение

array

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

string	$question
bool	$default

Возвращаемое значение

bool

mixed ask(string $question, string|null $default = null)

Запросить ввод у пользователя.

Параметры

string	$question
string\|null	$default

Возвращаемое значение

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Запросить ввод у пользователя с автодополнением.

Параметры

string	$question
array\|callable	$choices
string\|null	$default

Возвращаемое значение

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Запросить ввод у пользователя с автодополнением.

Параметры

string	$question
array\|callable	$choices
string\|null	$default

Возвращаемое значение

mixed

mixed secret(string $question, bool $fallback = true)

Запросить ввод у пользователя, скрывая ответ в консоли.

Параметры

string	$question
bool	$fallback

Возвращаемое значение

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предложить пользователю выбор из массива ответов.

Параметры

string	$question
array	$choices
string\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

Возвращаемое значение

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

Форматировать ввод в текстовую таблицу.

Параметры

array	$headers
Arrayable\|array	$rows
TableStyle\|string	$tableStyle
array	$columnStyles

Возвращаемое значение

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, продвигая полосу прогресса.

Параметры

iterable\|int	$totalSteps
Closure	$callback

Возвращаемое значение

mixed|void

void info(string $string, int|string|null $verbosity = null)

Вывести строку как информацию.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

string	$string
string\|null	$style
int\|string\|null	$verbosity

Возвращаемое значение

void

void comment(string $string, int|string|null $verbosity = null)

Вывести строку как комментарий.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void question(string $string, int|string|null $verbosity = null)

Вывести строку как вопрос.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void error(string $string, int|string|null $verbosity = null)

Вывести строку как ошибку.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void warn(string $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

void alert(string $string, int|string|null $verbosity = null)

Вывести строку в всплывающем окне.

Параметры

string	$string
int\|string\|null	$verbosity

Возвращаемое значение

void

$this newLine(int $count = 1)

Вывести пустую строку.

Параметры

int

$count

Возвращаемое значение

$this

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface

$input

Возвращаемое значение

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle

$output

Возвращаемое значение

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

Возвращаемое значение

void

protected int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

Параметры

string|int|null

$level

Возвращаемое значение

int

OutputStyle getOutput()

Получить реализацию вывода.

Возвращаемое значение

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполнен при возникновении указанного сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

Возвращаемое значение

void

void untrap()

internal

Отменить обработчики сигналов, установленные в обработчике команды.

Возвращаемое значение

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед валидацией ввода.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected array promptForMissingArgumentsUsing()

Запросить отсутствующие входные аргументы, используя возвращенные вопросы.

Возвращаемое значение

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнить действия после запроса у пользователя отсутствующих аргументов.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

void

protected bool didReceiveOptions(InputInterface $input)

Содержит ли входные данные какие-либо опции, отличающиеся от значений по умолчанию.

Параметры

InputInterface

$input

Возвращаемое значение

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Параметры

string

$name

Возвращаемое значение

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

Параметры

string	$method
array	$parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

END_OF_DOCUMENT_MARKER

void __construct(Маршрутизатор $router)

Создать новый экземпляр команды маршрута.

Параметры

Маршрутизатор

$router

Возвращаемое значение

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

Возвращаемое значение

void

protected void configureIsolation()

Настроить команду консоли для изоляции.

Возвращаемое значение

void

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

int

protected int execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

int

protected БлокировкаИзоляцииКоманды commandIsolationMutex()

Получить экземпляр блокировки изоляции команды для команды.

Возвращаемое значение

БлокировкаИзоляцииКоманды

bool isHidden()

{@inheritdoc}

Возвращаемое значение

bool

Команда setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

Возвращаемое значение

Команда

Приложение getLaravel()

Получить экземпляр приложения Laravel.

Возвращаемое значение

Приложение

void setLaravel(Контейнер $laravel)

Установить экземпляр приложения Laravel.

Параметры

Контейнер

$laravel

Возвращаемое значение

void

void handle()

Выполнить команду консоли.

Возвращаемое значение

void

protected array getRoutes()

Скомпилировать маршруты в формат, отображаемый на экране.

Возвращаемое значение

array

protected array getRouteInformation(Маршрут $route)

Получить информацию о маршруте для данного маршрута.

Параметры

Маршрут

$route

Возвращаемое значение

array

protected array sortRoutes(string $sort, array $routes)

Сортировать маршруты по заданному элементу.

Параметры

string	$sort
array	$routes

Возвращаемое значение

array

protected array pluckColumns(array $routes)

Удалить ненужные столбцы из маршрутов.

Параметры

array

$routes

Возвращаемое значение

array

protected void displayRoutes(array $routes)

Отобразить информацию о маршрутах в консоли.

Параметры

array

$routes

Возвращаемое значение

void

protected string getMiddleware(Маршрут $route)

Получить middleware для маршрута.

Параметры

Маршрут

$route

Возвращаемое значение

string

protected bool isVendorRoute(Маршрут $route)

Определить, был ли маршрут определен вне приложения.

Параметры

Маршрут

$route

Возвращаемое значение

bool

protected bool isFrameworkController(Маршрут $route)

Определить, использует ли маршрут контроллер фреймворка.

Параметры

Маршрут

$route

Возвращаемое значение

bool

protected array|null filterRoute(array $route)

Отфильтровать маршрут по URI и/или имени.

Параметры

array

$route

Возвращаемое значение

array|null

protected array getHeaders()

Получить заголовки таблицы для видимых столбцов.

Возвращаемое значение

array

protected array getColumns()

Получить имена столбцов для отображения (нижние регистры заголовков таблицы).

Возвращаемое значение

array

protected array parseColumns(array $columns)

Обработать список столбцов.

Parameters

array

$columns

Return Value

array

protected string asJson(Collection $routes)

Преобразовать заданные маршруты в JSON.

Parameters

Collection

$routes

Return Value

string

protected array forCli(Collection $routes)

Преобразовать заданные маршруты в обычный вывод CLI.

Parameters

Collection

$routes

Return Value

array

protected string formatActionForCli(array $route)

Получить отформатированное действие для отображения в CLI.

Parameters

array

$route

Return Value

string

protected string determineRouteCountOutput(Collection $routes, int $terminalWidth)

Определить и вернуть вывод для отображения количества маршрутов в выводе CLI.

Parameters

Collection	$routes
int	$terminalWidth

Return Value

string

static int getTerminalWidth()

Получить ширину терминала.

Return Value

int

static void resolveTerminalWidthUsing(Closure|null $resolver)

Установить обратный вызов, который следует использовать при разрешении ширины терминала.

Parameters

Closure|null

$resolver

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Foundation/Console/RouteListCommand.html