Spec-Zone.ru › Laravel 11

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

Текст справки командной строки.

из Команда
protected bool $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)

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

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

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 ?string validatePrompt(mixed $value, mixed $rules)

Проверить заданное значение подсказки с помощью валидатора.

Parameters

mixed $value
mixed $rules

Return Value

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Parameters

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

Return Value

Validator

protected array validationMessages()

Получить сообщения об ошибках валидации, которые следует использовать при проверке подсказок.

Return Value

array

protected array validationAttributes()

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

Return Value

array

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()

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

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

Factory

trap($signals, $callback)

Описание отсутствует

Параметры

$signals
$callback

void untrap()

внутренний

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

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

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

void __construct(Router $router)

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

Параметры

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 CommandMutex commandIsolationMutex()

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

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

CommandMutex

void fail(Throwable|string|null $exception = null)

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

Параметры

Throwable|string|null $exception

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

void

Исключения

Throwable
END_OF_DOCUMENT_MARKER

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)

Получить промежуточное ПО для маршрута.

Параметры

Маршрут $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)

Проанализировать список столбцов.

Параметры

array $columns

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

array

protected string asJson(Коллекция $routes)

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

Параметры

Коллекция $routes

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

string

protected array forCli(Коллекция $routes)

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

Параметры

Коллекция $routes

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

array

protected string formatActionForCli(array $route)

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

Параметры

array $route

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

string

protected string determineRouteCountOutput(Коллекция $routes, int $terminalWidth)

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

Параметры

Коллекция $routes
int $terminalWidth

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

string
END_OF_DOCUMENT_MARKER

static int getTerminalWidth()

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

Значение возврата

int

static void resolveTerminalWidthUsing(Closure|null $resolver)

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

Параметры

Closure|null $resolver

Значение возврата

void

© 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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API