\CodeIgniter\RouterRouterInterface

Expected behavior of a Router.

Summary

Methods

Constants

__construct()
handle()
controllerName()
methodName()
params()
setIndexPage()

No constants found

No protected methods found

N/A

No private methods found

N/A

Methods

__construct()

__construct(\CodeIgniter\Router\RouteCollectionInterface  $routes, \CodeIgniter\HTTP\Request  $request = null)

Stores a reference to the RouteCollection object.

Parameters

\CodeIgniter\Router\RouteCollectionInterface	$routes
\CodeIgniter\HTTP\Request	$request

handle()

handle(string  $uri = null) : mixed

Scans the URI and attempts to match the current URI to the one of the defined routes in the RouteCollection.

Parameters

string

$uri

Returns

mixed

controllerName()

controllerName() : mixed

Returns the name of the matched controller.

Returns

mixed

methodName()

methodName() : mixed

Returns the name of the method to run in the chosen container.

Returns

mixed

params()

params() : mixed

Returns the binds that have been matched and collected during the parsing process as an array, ready to send to instance->method(.

..$params).

Returns

mixed

setIndexPage()

setIndexPage(  $page) : mixed

Sets the value that should be used to match the index.php file. Defaults to index.php but this allows you to modify it in case your are using something like mod_rewrite to remove the page. This allows you to set it a blank.

Parameters

$page

Returns

mixed