RouteListCommand

class RouteListCommand extends Command (View source)

Свойства

CallsCommands

ConfiguresPrompts

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
protected bool	$isolated	Указывает, может ли выполняться только один экземпляр команды в любой момент времени.	from Command
protected int	$isolatedExitCode	Код выхода по умолчанию для изолированных команд.	from Command
protected array	$aliases	Псевдонимы имени команды консоли.	from Command
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	configurePrompts(InputInterface $input) Настроить отступы подсказок.	из ConfiguresPrompts
mixed	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя данные до тех пор, пока не будет выполнено заданное условие проверки.	из 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() Получить все параметры, переданные команде.
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
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) Выполнить консольную команду.	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	handle() Выполнить консольную команду.
array	getRoutes() Скомпилировать маршруты в отображаемый формат.
array	getRouteInformation(Маршрут $route) Получить информацию о маршруте для заданного маршрута.
array	sortRoutes(string $sort, array $routes) Отсортировать маршруты по заданному элементу.
array	pluckColumns(array $routes) Удалить ненужные столбцы из маршрутов.
void	displayRoutes(array $routes) Отобразить информацию о маршрутах в консоли.
string	getMiddleware(Маршрут $route) Получить средства обработки для маршрута.
bool	isVendorRoute(Маршрут $route) Определить, определен ли маршрут вне приложения.
bool	isFrameworkController(Маршрут $route) Определить, использует ли маршрут контроллер фреймворка.
array\|null	filterRoute(array $route) Отфильтровать маршрут по URI и/или имени.
array	getHeaders() Получить заголовки таблицы для видимых столбцов.
array	getColumns() Получить имена столбцов для отображения (строчные заголовки таблицы).
array	parseColumns(array $columns) Разбор списка столбцов.
string	asJson(Коллекция $routes) Преобразовать заданные маршруты в JSON.
array	forCli(Коллекция $routes) Преобразовать заданные маршруты в обычный вывод CLI.
string	formatActionForCli(array $route) Получить отформатированное действие для отображения в CLI.
string	determineRouteCountOutput(Коллекция $routes, int $terminalWidth) Определить и вернуть вывод для отображения количества маршрутов в выводе CLI.
static int	getTerminalWidth() Получить ширину терминала.
static void	resolveTerminalWidthUsing(Closure\|null $resolver) Установить обратный вызов, который должен использоваться при определении ширины терминала.

Details

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string

$command

Return Value

Command

int call(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

int callSilent(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

int callSilently(Command|string $command, array $arguments = [])

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

Parameters

Command\|string	$command
array	$arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Parameters

Command\|string	$command
array	$arguments
OutputInterface	$output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array

$arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

END_OF_DOCUMENT_MARKER

protected void configurePrompts(InputInterface $input)

Настроить отступы подсказок.

Parameters

InputInterface

$input

Return Value

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Запрашивать у пользователя данные до тех пор, пока не будет пройден заданный вызов обратного вызова проверки.

Parameters

Closure	$prompt
bool\|string	$required
Closure\|null	$validate

Return Value

mixed

protected void restorePrompts()

Восстановить вывод подсказок.

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

Определить, присутствует ли данная опция.

Parameters

string

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

mixed|void

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

Вывести строку в виде информационного сообщения.

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

Вывести строку в виде сообщения об ошибке.

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

$this newLine(int $count = 1)

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

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int

$level

Return Value

void

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

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

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

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

Return Value

OutputStyle

Factory outputComponents()

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

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

	$signals
	$callback

void untrap()

internal

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

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Возвращает true, если входные данные содержат параметры, отличающиеся от значений по умолчанию.

Parameters

InputInterface

$input

Return Value

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Router $router)

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

Parameters

Router

$router

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

void

protected void configureIsolation()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool

$hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container

$laravel

Return Value

void

void handle()

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

Return Value

void

protected array getRoutes()

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

Return Value

array

protected array getRouteInformation(Route $route)

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

Parameters

Route

$route

Return Value

array

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

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

Parameters

string	$sort
array	$routes

Return Value

array

protected array pluckColumns(array $routes)

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

Parameters

array

$routes

Return Value

array

protected void displayRoutes(array $routes)

Отображение информации о маршрутах в консоли.

Parameters

array

$routes

Return Value

void

protected string getMiddleware(Route $route)

Получение среднего для маршрута.

Parameters

Route

$route

Return Value

string

protected bool isVendorRoute(Route $route)

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

Parameters

Route

$route

Return Value

bool

protected bool isFrameworkController(Route $route)

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

Parameters

Route

$route

Return Value

bool

protected array|null filterRoute(array $route)

Фильтрация маршрута по URI и/или имени.

Parameters

array

$route

Return Value

array|null

protected array getHeaders()

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

Return Value

array

protected array getColumns()

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

Return Value

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/10.x/Illuminate/Foundation/Console/RouteListCommand.html