Spec-Zone.ru › Laravel 5.4

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)

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

Параметры

Router $router

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

void

protected void specifyParameters()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

mixed

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

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

Параметры

string $command
array $arguments

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

int

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

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

Параметры

string $command
array $arguments

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

int

string|array argument(string $key = null)

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

Параметры

string $key

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

string|array

string|array option(string $key = null)

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

Параметры

string $key

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

string|array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string $default

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

string

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

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

Параметры

string $question
array $choices
string $default

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

string

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

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

Параметры

string $question
bool $fallback

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

string

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

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

Параметры

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

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

bool

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

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

Параметры

array $headers
array $rows
string $style

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

void

void info(string $string)

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

Параметры

string $string

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

void

void line(string $string)

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

Параметры

string $string

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

void

void comment(string $string)

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

Параметры

string $string

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

void

void question(string $string)

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

Параметры

string $string

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

void

void error(string $string)

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

Параметры

string $string

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Application $laravel)

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

Параметры

Application $laravel

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

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.4/Illuminate/Foundation/Console/RoutesCommand.html

Spec-Zone.ru

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