UserFrosting API

RouteListCommand extends BaseCommand

route:list Bakery Command Generate a list all registered routes Inspired by Laravel `route:list` artisan command.

Tags
author

Jose Vasconcellos

author

Louis Charette

Table of Contents

$headers array
$io SymfonyStyle
$ci ContainerInterface
configure() {@inheritdoc} mixed
execute() {@inheritdoc} mixed
getRouteInformation() Get the route information for a given route. array
sortRoutes() Sort the routes by a given element. array
filterRoute() Filter the route by URI and / or name. array|null
initialize() {@inheritdoc} mixed
setContainer() Setup the global container object. void
isProduction() Return if the app is in production mode. bool

Properties

Methods

configure()

{@inheritdoc}

protected configure( ) : mixed
Return values
mixed

execute()

{@inheritdoc}

protected execute( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

getRouteInformation()

Get the route information for a given route.

protected getRouteInformation( $route : Route , $input : InputInterface ) : array
Parameters
$route : Route
$input : InputInterface

[description]

Return values
array

sortRoutes()

Sort the routes by a given element.

protected sortRoutes( $sort : string , $routes : array ) : array
Parameters
$sort : string
$routes : array
Return values
array

filterRoute()

Filter the route by URI and / or name.

protected filterRoute( $route : array , $input : InputInterface ) : array|null
Parameters
$route : array
$input : InputInterface

[description]

Return values
array|null

initialize()

{@inheritdoc}

protected initialize( $input : InputInterface , $output : OutputInterface ) : mixed
Parameters
$input : InputInterface
$output : OutputInterface
Return values
mixed

setContainer()

Setup the global container object.

public setContainer( $ci : ContainerInterface ) : void
Parameters
$ci : ContainerInterface

isProduction()

Return if the app is in production mode.

protected isProduction( ) : bool

@return bool True/False if the app is in production mode

Return values
bool

Search results