A specific route can be retrived by providing its index. All connected routes inside all
scopes may be retrieved by providing null instead of the route index. To retrieve all
routes for the current scope only, pass true for the $scope parameter.
public static get ( integer $route = null, string | boolean $scope = null ) : object | array | null | ||
$route | integer | Index of the route. |
$scope | string | boolean | Name of the scope to get routes from. Uses default scope if `true`. |
return | object | array | null | If $route is an integer, returns the route object at given index or if that fails returns `null`. If $route is `null` returns an array of routes or scopes with their respective routes depending on the value of $scope. |