RoutesCommand

class RoutesCommand extends Command (View source)

Properties

protected Application	$laravel	The Laravel application instance.	from Command
protected InputInterface	$input	The input interface implementation.	from Command
protected OutputInterface	$output	The output interface implementation.	from Command
protected string	$name	The console command name.
protected string	$description	The console command description.
protected Router	$router	The router instance.
protected RouteCollection	$routes	An array of all the registered routes.
protected array	$headers	The table headers for the command.

Methods

void

__construct(Router $router)

Create a new route command instance.

void

specifyParameters()

Specify the arguments and options on the command.

from Command

int

run(InputInterface $input, OutputInterface $output)

Run the console command.

from Command

mixed

execute(InputInterface $input, OutputInterface $output)

Execute the console command.

from Command

int

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

Call another console command.

from Command

int

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

Call another console command silently.

from Command

string|array

argument(string $key = null)

Get the value of a command argument.

from Command

string|array

option(string $key = null)

Get the value of a command option.

from Command

bool

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

Confirm a question with the user.

from Command

string

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

Prompt the user for input.

from Command

string

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

Prompt the user for input with auto completion.

from Command

string

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

Prompt the user for input but hide the answer from the console.

from Command

bool

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

Give the user a single choice from an array of answers.

from Command

void

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

Format input to textual table

from Command

void

info(string $string)

Write a string as information output.

from Command

void

line(string $string)

Write a string as standard output.

from Command

void

comment(string $string)

Write a string as comment output.

from Command

void

question(string $string)

Write a string as question output.

from Command

void

error(string $string)

Write a string as error output.

from Command

array

getArguments()

Get the console command arguments.

from Command

array

getOptions()

Get the console command options.

OutputInterface

getOutput()

Get the output implementation.

from Command

Application

getLaravel()

Get the Laravel application instance.

from Command

void

setLaravel(Application $laravel)

Set the Laravel application instance.

from Command

void

fire()

Execute the console command.

array

getRoutes()

Compile the routes into a displayable format.

array

getRouteInformation(Route $route)

Get the route information for a given route.

void

displayRoutes(array $routes)

Display the route information on the console.

string

getBeforeFilters(Route $route)

Get before filters

array

getPatternFilters(Route $route)

Get all of the pattern filters matching the route.

array

getMethodPatterns(string $uri, string $method)

Get the pattern filters for a given URI and method.

string

getAfterFilters(Route $route)

Get after filters

array|null

filterRoute(array $route)

Filter the route by URI and / or name.

Details

void __construct(Router $router)

Create a new route command instance.

Parameters

Router

$router

Return Value

void

protected void specifyParameters()

Specify the arguments and options on the command.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Run the console command.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

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

Execute the console command.

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

mixed

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

Call another console command.

Parameters

string	$command
array	$arguments

Return Value

int

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

Call another console command silently.

Parameters

string	$command
array	$arguments

Return Value

int

string|array argument(string $key = null)

Get the value of a command argument.

Parameters

string

$key

Return Value

string|array

string|array option(string $key = null)

Get the value of a command option.

Parameters

string

$key

Return Value

string|array

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

Confirm a question with the user.

Parameters

string	$question
bool	$default

Return Value

bool

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

Prompt the user for input.

Parameters

string	$question
string	$default

Return Value

string

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

Prompt the user for input with auto completion.

Parameters

string	$question
array	$choices
string	$default

Return Value

string

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

Prompt the user for input but hide the answer from the console.

Parameters

string	$question
bool	$fallback

Return Value

string

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

Give the user a single choice from an array of answers.

Parameters

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

Return Value

bool

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

Format input to textual table

Parameters

array	$headers
array	$rows
string	$style

Return Value

void

void info(string $string)

Write a string as information output.

Parameters

string

$string

Return Value

void

void line(string $string)

Write a string as standard output.

Parameters

string

$string

Return Value

void

void comment(string $string)

Write a string as comment output.

Parameters

string

$string

Return Value

void

void question(string $string)

Write a string as question output.

Parameters

string

$string

Return Value

void

void error(string $string)

Write a string as error output.

Parameters

string

$string

Return Value

void

protected array getArguments()

Get the console command arguments.

Return Value

array

protected array getOptions()

Get the console command options.

Return Value

array

OutputInterface getOutput()

Get the output implementation.

Return Value

OutputInterface

Application getLaravel()

Get the Laravel application instance.

Return Value

Application

void setLaravel(Application $laravel)

Set the Laravel application instance.

Parameters

Application

$laravel

Return Value

void

void fire()

Execute the console command.

Return Value

void

protected array getRoutes()

Compile the routes into a displayable format.

Return Value

array

protected array getRouteInformation(Route $route)

Get the route information for a given route.

Parameters

Route

$route

Return Value

array

protected void displayRoutes(array $routes)

Display the route information on the console.

Parameters

array

$routes

Return Value

void

protected string getBeforeFilters(Route $route)

Get before filters

Parameters

Route

$route

Return Value

string

protected array getPatternFilters(Route $route)

Get all of the pattern filters matching the route.

Parameters

Route

$route

Return Value

array

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

Get the pattern filters for a given URI and method.

Parameters

string	$uri
string	$method

Return Value

array

protected string getAfterFilters(Route $route)

Get after filters

Parameters

Route

$route

Return Value

string

protected array|null filterRoute(array $route)

Filter the route by URI and / or name.

Parameters

array

$route

Return Value

array|null

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