PHP Class Ergo\Routing\Router

Inheritance: implements Ergo\Routing\Controller

Public Methods

Method	Description
__construct ( $resolver = null )	Constructor
alias ( $template, $name, $to )	Register an alias from one route name to another
buildUrl ( string $name, array $parameters = [], $baseUrl = null )	Build a URL path based on a route name and associated parameters.
configure ( $file )	Configures the routemap from a php file
connect ( $template, $name, $controller = null, $metadata = [] )	Gives a route template a unique name and a controller to route to
controller ( $name )	Looks up a controller from a route name
execute ( $request )	* (non-phpdoc)
lookup ( string $path ) : RouteMatch	Looks up a route match based on a url path
metadata ( $routeName ) : array	Looks up metadata for a route name
redirect ( $template, $name, $to )	Create a redirect from a particular route name to another
routeByName ( $name ) : Route	Looks up a route by name
setBaseUrl ( $url )	Sets a base url for url building
setDefaultMetadata ( $metadata )	Sets the default metadata to be set into routes

Method	Description
_getRouteMatch ( string $path, array $routes ) : mixed	Look for a matching route in provided route list.

Constructor

public __construct ( $resolver = null )

public alias ( $template, $name, $to )

Build a URL path based on a route name and associated parameters.

public buildUrl ( string $name, array $parameters = [], $baseUrl = null )
$name	string
$parameters	array

Configures the routemap from a php file

public configure ( $file )

Gives a route template a unique name and a controller to route to

public connect ( $template, $name, $controller = null, $metadata = [] )

Looks up a controller from a route name

public controller ( $name )

* (non-phpdoc)

Looks up a route match based on a url path

public lookup ( string $path ) : RouteMatch
$path	string
return	RouteMatch

Looks up metadata for a route name

public metadata ( $routeName ) : array
return	array

Create a redirect from a particular route name to another

public redirect ( $template, $name, $to )

Looks up a route by name

public routeByName ( $name ) : Route
return	Route

Sets a base url for url building

public setBaseUrl ( $url )

Sets the default metadata to be set into routes

public setDefaultMetadata ( $metadata )