1. class
  2. mako
  3. \
  4. application
  5. \
  6. cli
  7. \
  8. commands
  9. \
  10. app
  11. \
  12. ListRoutes

ListRoutes

class ListRoutes extends Command

Command that lists all registered routes.

Traits

CommandHelperTrait
Controller helper trait.
ContainerAwareTrait
Container aware trait.

Properties

protected Container $container Container. from ContainerAwareTrait
protected array $resolved Array of resolved objects and/or references to resolved objects. from ContainerAwareTrait
Application $app from ContainerAwareTrait
Input $input from ContainerAwareTrait
Output $output from ContainerAwareTrait
CommandBusInterface $bus from ContainerAwareTrait
FileSystem $fileSystem from ContainerAwareTrait
Config $config from ContainerAwareTrait
CacheManager $cache from ContainerAwareTrait
CryptoManager $crypto from ContainerAwareTrait
ConnectionManager $database from ContainerAwareTrait
Event $event from ContainerAwareTrait
ErrorHandler $errorHandler from ContainerAwareTrait
Authentication $gatekeeper from ContainerAwareTrait
Humanizer $humanizer from ContainerAwareTrait
I18n $i18n from ContainerAwareTrait
LoggerInterface $logger from ContainerAwareTrait
PaginationFactoryInterface $pagination from ContainerAwareTrait
ConnectionManager $redis from ContainerAwareTrait
Request $request from ContainerAwareTrait
Response $response from ContainerAwareTrait
Routes $routes from ContainerAwareTrait
Session $session from ContainerAwareTrait
Signer $signer from ContainerAwareTrait
URLBuilder $urlBuilder from ContainerAwareTrait
ValidatorFactory $validator from ContainerAwareTrait
ViewFactory $view from ContainerAwareTrait
protected array $commandInformation Command information.
protected bool $isStrict Make the command strict.

Methods

setContainer(Container $container)

Sets the container instance.

from ContainerAwareTrait
mixed
__get(string $key)

Resolves item from the container using overloading.

from ContainerAwareTrait
nl(int $lines = 1, int $writer = Output::STANDARD)

Writes n newlines to output.

from CommandHelperTrait
write(string $string, int $writer = Output::STANDARD)

Writes string to output.

from CommandHelperTrait
error(string $string)

Writes string to output using the error writer.

from CommandHelperTrait
clear()

Clears the screen.

from CommandHelperTrait
bell(int $times = 1)

Rings the terminal bell n times.

from CommandHelperTrait
countdown(int $from = 5)

Counts down from n.

from CommandHelperTrait
ProgressBar
progressBar(int $items, int $redrawRate = null, string $prefix = null)

Draws a progress bar and returns a progress bar instance.

from CommandHelperTrait
table(array $columnNames, array $rows, int $writer = Output::STANDARD)

Draws a table.

from CommandHelperTrait
ol(array $items, string $marker = '<yellow>%s</yellow>.', int $writer = Output::STANDARD)

Draws an ordered list.

from CommandHelperTrait
ul(array $items, string $marker = '<yellow>*</yellow>', int $writer = Output::STANDARD)

Draws an unordered list.

from CommandHelperTrait
bool
confirm(string $question, string $default = 'n')

Writes question to output and returns boolesn value corresponding to the chosen value.

from CommandHelperTrait
mixed
question(string $question, mixed $default = null)

Writes question to output and returns user input.

from CommandHelperTrait
int
select(string $question, array $options)

Prints out a list of options and returns the array key of the chosen value.

from CommandHelperTrait
mixed
secret(string $question, mixed $default = null, bool $fallback = false)

Writes question to output and returns hidden user input.

from CommandHelperTrait
__construct(Input $input, Output $output)

Constructor.

from Command
string
getCommandDescription()

Returns the command description.

from Command
array
getCommandArguments()

Returns the command arguments.

from Command
array
getCommandOptions()

Returns the command options.

from Command
bool
isStrict()

Returns TRUE we should be strict about what arguments and options we allow and FALSE if not.

from Command
execute(Routes $routes)

Executes the command.

Details

in ContainerAwareTrait at line 67
setContainer(Container $container)

Sets the container instance.

Parameters

Container $container Container

in ContainerAwareTrait at line 78
mixed __get(string $key)

Resolves item from the container using overloading.

Parameters

string $key Key

Return Value

mixed

in CommandHelperTrait at line 40
protected nl(int $lines = 1, int $writer = Output::STANDARD)

Writes n newlines to output.

Parameters

int $lines Number of newlines to write
int $writer Output writer

in CommandHelperTrait at line 51
protected write(string $string, int $writer = Output::STANDARD)

Writes string to output.

Parameters

string $string String to write
int $writer Output writer

in CommandHelperTrait at line 61
protected error(string $string)

Writes string to output using the error writer.

Parameters

string $string String to write

in CommandHelperTrait at line 69
protected clear()

Clears the screen.

in CommandHelperTrait at line 79
protected bell(int $times = 1)

Rings the terminal bell n times.

Parameters

int $times Number of times to ring the bell

in CommandHelperTrait at line 89
protected countdown(int $from = 5)

Counts down from n.

Parameters

int $from Number of seconds to count down

in CommandHelperTrait at line 102
protected ProgressBar progressBar(int $items, int $redrawRate = null, string $prefix = null)

Draws a progress bar and returns a progress bar instance.

Parameters

int $items Total number of items
int $redrawRate Redraw rate
string $prefix Progress bar prefix

Return Value

ProgressBar

in CommandHelperTrait at line 129
protected table(array $columnNames, array $rows, int $writer = Output::STANDARD)

Draws a table.

Parameters

array $columnNames Array of column names
array $rows Array of rows
int $writer Output writer

in CommandHelperTrait at line 141
protected ol(array $items, string $marker = '<yellow>%s</yellow>.', int $writer = Output::STANDARD)

Draws an ordered list.

Parameters

array $items Items
string $marker Item marker
int $writer Output writer

in CommandHelperTrait at line 153
protected ul(array $items, string $marker = '<yellow>*</yellow>', int $writer = Output::STANDARD)

Draws an unordered list.

Parameters

array $items Items
string $marker Item marker
int $writer Output writer

in CommandHelperTrait at line 165
protected bool confirm(string $question, string $default = 'n')

Writes question to output and returns boolesn value corresponding to the chosen value.

Parameters

string $question Question to ask
string $default Default answer

Return Value

bool

in CommandHelperTrait at line 177
protected mixed question(string $question, mixed $default = null)

Writes question to output and returns user input.

Parameters

string $question Question to ask
mixed $default Default if no input is entered

Return Value

mixed

in CommandHelperTrait at line 189
protected int select(string $question, array $options)

Prints out a list of options and returns the array key of the chosen value.

Parameters

string $question Question to ask
array $options Numeric array of options to choose from

Return Value

int

in CommandHelperTrait at line 202
protected mixed secret(string $question, mixed $default = null, bool $fallback = false)

Writes question to output and returns hidden user input.

Parameters

string $question Question to ask
mixed $default Default if no input is entered
bool $fallback Fall back to non-hidden input?

Return Value

mixed

in Command at line 62
__construct(Input $input, Output $output)

Constructor.

Parameters

Input $input Input
Output $output Output

in Command at line 72
string getCommandDescription()

Returns the command description.

Return Value

string

in Command at line 80
array getCommandArguments()

Returns the command arguments.

Return Value

array

in Command at line 88
array getCommandOptions()

Returns the command options.

Return Value

array

in Command at line 96
bool isStrict()

Returns TRUE we should be strict about what arguments and options we allow and FALSE if not.

Return Value

bool

at line 45
execute(Routes $routes)

Executes the command.

Parameters

Routes $routes Route collection