Properties

$routes

$routes : array

Array of available routes

Type

array

$controllerParams

$controllerParams : array

Array of controller parameters

Type

array

$dispatchParams

$dispatchParams : array

Array of dispatch parameters

Type

array

$controllerClass

$controllerClass : string

Controller class name

Type

string

Methods

__construct()

__construct(array  $routes = null) : \Pop\Router\Router

Constructor

Instantiate the router object

Parameters

array $routes

Returns

\Pop\Router\Router

addRoute()

addRoute(string  $route, mixed  $controller) : \Pop\Router\Router

Add a route

Parameters

string $route
mixed $controller

Returns

\Pop\Router\Router

addRoutes()

addRoutes(array  $routes) : \Pop\Router\Router

Add multiple controller routes

Parameters

array $routes

Returns

\Pop\Router\Router

addControllerParams()

addControllerParams(string  $controller, mixed  $params = null) : \Pop\Router\Router

Add controller params to be passed into a new controller instance

$router->addControllerParams('MyApp\Controller\IndexController', ['foo', 'bar']);

Parameters

string $controller
mixed $params

Returns

\Pop\Router\Router

addDispatchParams()

addDispatchParams(string  $dispatch, mixed  $params) : \Pop\Router\Router

Add dispatch params to be passed into the dispatched method of the controller instance

$router->addDispatchParams('MyApp\Controller\IndexController->foo', ['bar', 'baz']);

Parameters

string $dispatch
mixed $params

Returns

\Pop\Router\Router

getControllerParams()

getControllerParams(string  $controller) : mixed

Get the params assigned to the controller

Parameters

string $controller

Returns

mixed

getDispatchParams()

getDispatchParams(string  $dispatch) : mixed

Get the params assigned to the dispatch

Parameters

string $dispatch

Returns

mixed

hasRoute()

hasRoute() : boolean

Determine if a route is set for the current request

Returns

boolean

getRoutes()

getRoutes() : array

Get routes

Returns

array

getControllerClass()

getControllerClass() : string

Get the current controller class name

Returns

string

isCli()

isCli() : boolean

Determine if the route is CLI

Returns

boolean

isHttp()

isHttp() : boolean

Determine if the route is HTTP

Returns

boolean

route()

route() : void

Route to the correct controller