RoutesListCommand

Lists every route the app’s actual configured Routing service knows about — i.e.

whatever getRouteCollection()/getMeta() on the class factories.xml/.yaml/.php names for the “routing” entry returns. That class decides for itself whether it’s hand-written routes (Routing::build()), attribute routes only, or both merged via AttributeRoutes::mergeInto() (see samples/app/Routing/AppRouting.php) — this command is a read-only view onto the live result, not a second opinion sourced only from #[Route] attributes.

Attribute-declared routes are additionally scanned (independently of whatever the app’s Routing class does with them) to surface authoring diagnostics — duplicate route names/paths among #[Route] attributes are worth flagging whether or not the app actually merges them in — and to label each listed route’s Source column “Attribute” (its name was declared via #[Route]) or “File” (anything else: Routing::build(), routing.xml, a programmatic builder, …).

Synopsis

final class RoutesListCommand extends AbstractAppCommand


Extends	`AbstractAppCommand`
Since	`1.0.0`
Source	`Console/Command/RoutesListCommand.php`

Inherited methods

These come from an ancestor and are documented where they are declared.

Method	Declared in	Description
`addArgument()`	`Command`	Adds an argument.
`addOption()`	`Command`	Adds an option.
`addUsage()`	`Command`	Add a command usage example, it’ll be prefixed with the command name.
`complete()`	`Command`	Supplies suggestions when resolving possible completion options for input (e.g.
`getAliases()`	`Command`	Returns the aliases for the command.
`getApplication()`	`Command`	Gets the application instance for this command.
`getCode()`	`Command`	Gets the code that is executed by the command.
`getDefinition()`	`Command`	Gets the InputDefinition attached to this Command.
`getDescription()`	`Command`	Returns the description for the command.
`getHelp()`	`Command`	Returns the help for the command.
`getHelper()`	`Command`	Gets a helper instance by name.
`getHelperSet()`	`Command`	Gets the helper set.
`getName()`	`Command`	Returns the command name.
`getNativeDefinition()`	`Command`	Gets the InputDefinition to be used to create representations of this Command.
`getProcessedHelp()`	`Command`	Returns the processed help for the command replacing the %command.name% and %command.full_name% patterns with the real values dynamically.
`getSubscribedSignals()`	`Command`
`getSynopsis()`	`Command`	Returns the synopsis for the command.
`getUsages()`	`Command`	Returns alternative usages of the command.
`handleSignal()`	`Command`
`ignoreValidationErrors()`	`Command`	Ignores validation errors.
`isEnabled()`	`Command`	Checks whether the command is enabled or not in the current environment.
`isHidden()`	`Command`
`run()`	`Command`	Runs the command.
`setAliases()`	`Command`	Sets the aliases for the command.
`setApplication()`	`Command`
`setCode()`	`Command`	Sets the code to execute when running this command.
`setDefinition()`	`Command`	Sets an array of argument and option instances.
`setDescription()`	`Command`	Sets the description for the command.
`setHelp()`	`Command`	Sets the help for the command.
`setHelperSet()`	`Command`
`setHidden()`	`Command`
`setName()`	`Command`	Sets the name of the command.
`setProcessTitle()`	`Command`	Sets the process title of the command.