Spec-Zone.ru › Laravel 5.2

RoutesCommand

class RoutesCommand extends Command (View source)

Свойства

protected Application $laravel Экземпляр приложения Laravel. from Command
protected InputInterface $input Реализация интерфейса ввода. from Command
protected OutputInterface $output Реализация интерфейса вывода. from Command
protected string $name Имя команды консоли.
protected string $description Описание команды консоли.
protected Router $router Экземпляр маршрутизатора.
protected RouteCollection $routes Массив всех зарегистрированных маршрутов.
protected array $headers Заголовки таблицы для команды.

Методы

void __construct(Router $router)

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

void specifyParameters()

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

из Command
int run(InputInterface $input, OutputInterface $output)

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

из Command
mixed execute(InputInterface $input, OutputInterface $output)

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

из Command
int call(string $command, array $arguments = array())

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

из Command
int callSilent(string $command, array $arguments = array())

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

из Command
string|array argument(string $key = null)

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

из Command
string|array option(string $key = null)

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

из Command
bool confirm(string $question, bool $default = false)

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

из Command
string ask(string $question, string $default = null)

Задать вопрос пользователю.

из Command
string askWithCompletion(string $question, array $choices, string $default = null)

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

из Command
string secret(string $question, bool $fallback = true)

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

из Command
bool choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

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

из Command
void table(array $headers, array $rows, string $style = 'default')

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

из Command
void info(string $string)

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

из Command
void line(string $string)

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

из Command
void comment(string $string)

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

из Command
void question(string $string)

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

из Command
void error(string $string)

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

из Command
array getArguments()

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

из Command
array getOptions()

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

OutputInterface getOutput()

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

из Command
Application getLaravel()

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

из Command
void setLaravel(Application $laravel)

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

из Command
void fire()

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

array getRoutes()

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

array getRouteInformation(Route $route)

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

void displayRoutes(array $routes)

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

string getBeforeFilters(Route $route)

Получить фильтры перед маршрутом

array getPatternFilters(Route $route)

Получить все фильтры шаблонов, соответствующие маршруту.

array getMethodPatterns(string $uri, string $method)

Получить фильтры шаблонов для заданного URI и метода.

string getAfterFilters(Route $route)

Получить фильтры после маршрута

array|null filterRoute(array $route)

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

Подробности

void __construct(Router $router)

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

Parameters

Router $router

Return Value

void

protected void specifyParameters()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

int call(string $command, array $arguments = array())

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

Parameters

string $command
array $arguments

Return Value

int

int callSilent(string $command, array $arguments = array())

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

Parameters

string $command
array $arguments

Return Value

int

string|array argument(string $key = null)

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

Parameters

string $key

Return Value

string|array

string|array option(string $key = null)

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

Parameters

string $key

Return Value

string|array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

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

Parameters

string $question
string $default

Return Value

string

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

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

Parameters

string $question
array $choices
string $default

Return Value

string

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

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

Parameters

string $question
bool $fallback

Return Value

string

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

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

Parameters

string $question
array $choices
string $default
mixed $attempts
bool $multiple

Return Value

bool

void table(array $headers, array $rows, string $style = 'default')

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

Parameters

array $headers
array $rows
string $style

Return Value

void

void info(string $string)

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

Parameters

string $string

Return Value

void

void line(string $string)

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

Parameters

string $string

Return Value

void

void comment(string $string)

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

Parameters

string $string

Return Value

void

void question(string $string)

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

Parameters

string $string

Return Value

void

void error(string $string)

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

Parameters

string $string

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputInterface getOutput()

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

Return Value

OutputInterface

Application getLaravel()

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

Return Value

Application

void setLaravel(Application $laravel)

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

Parameters

Application $laravel

Return Value

void

void fire()

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

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

void

protected array getRoutes()

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

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

array

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

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

Параметры

Маршрут $route

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

array

protected void displayRoutes(array $routes)

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

Параметры

array $routes

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

void

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

Получить фильтры до выполнения.

Параметры

Маршрут $route

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

string

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

Получить все фильтры шаблонов, соответствующие маршруту.

Параметры

Маршрут $route

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

array

protected array getMethodPatterns(string $uri, string $method)

Получить фильтры шаблонов для заданного URI и метода.

Параметры

string $uri
string $method

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

array

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

Получить фильтры после выполнения.

Параметры

Маршрут $route

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

string

protected array|null filterRoute(array $route)

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

Параметры

array $route

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

array|null

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

Spec-Zone.ru

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