Class **Phalcon\\Mvc\\Router** ============================== *implements* :doc:`Phalcon\\Di\\InjectionAwareInterface `, :doc:`Phalcon\\Mvc\\RouterInterface `, :doc:`Phalcon\\Events\\EventsAwareInterface ` .. role:: raw-html(raw) :format: html :raw-html:`Source on GitHub` Phalcon\\Mvc\\Router is the standard framework router. Routing is the process of taking a URI endpoint (that part of the URI which comes after the base URL) and decomposing it into parameters to determine which module, controller, and action of that controller should receive the request .. code-block:: php add( '/documentation/{chapter}/{name}\.{type:[a-z]+}', [ 'controller' => 'documentation', 'action' => 'show' ) ); $router->handle(); echo $router->getControllerName(); Constants --------- *integer* **URI_SOURCE_GET_URL** *integer* **URI_SOURCE_SERVER_REQUEST_URI** *integer* **POSITION_FIRST** *integer* **POSITION_LAST** Methods ------- public **__construct** ([*mixed* $defaultRoutes]) Phalcon\\Mvc\\Router constructor public **setDI** (:doc:`Phalcon\\DiInterface ` $dependencyInjector) Sets the dependency injector public **getDI** () Returns the internal dependency injector public **setEventsManager** (:doc:`Phalcon\\Events\\ManagerInterface ` $eventsManager) Sets the events manager public **getEventsManager** () Returns the internal event manager public **getRewriteUri** () Get rewrite info. This info is read from $_GET['_url']. This returns '/' if the rewrite information cannot be read public **setUriSource** (*mixed* $uriSource) Sets the URI source. One of the URI_SOURCE_* constants .. code-block:: php setUriSource(Router::URI_SOURCE_SERVER_REQUEST_URI); public **removeExtraSlashes** (*mixed* $remove) Set whether router must remove the extra slashes in the handled routes public **setDefaultNamespace** (*mixed* $namespaceName) Sets the name of the default namespace public **setDefaultModule** (*mixed* $moduleName) Sets the name of the default module public **setDefaultController** (*mixed* $controllerName) Sets the default controller name public **setDefaultAction** (*mixed* $actionName) Sets the default action name public **setDefaults** (*array* $defaults) Sets an array of default paths. If a route is missing a path the router will use the defined here This method must not be used to set a 404 route .. code-block:: php setDefaults([ 'module' => 'common', 'action' => 'index' ]); public **getDefaults** () Returns an array of default parameters public **handle** ([*mixed* $uri]) Handles routing information received from the rewrite engine .. code-block:: php handle(); // Manually passing an URL $router->handle('/posts/edit/1'); public **add** (*mixed* $pattern, [*mixed* $paths], [*mixed* $httpMethods], [*mixed* $position]) Adds a route to the router without any HTTP constraint .. code-block:: php add('/about', 'About::index'); $router->add('/about', 'About::index', ['GET', 'POST']); $router->add('/about', 'About::index', ['GET', 'POST'], Router::POSITION_FIRST); public **addGet** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is GET public **addPost** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is POST public **addPut** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is PUT public **addPatch** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is PATCH public **addDelete** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is DELETE public **addOptions** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Add a route to the router that only match if the HTTP method is OPTIONS public **addHead** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is HEAD public **addPurge** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is PURGE (Squid and Varnish support) public **addTrace** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is TRACE public **addConnect** (*mixed* $pattern, [*mixed* $paths], [*mixed* $position]) Adds a route to the router that only match if the HTTP method is CONNECT public **mount** (:doc:`Phalcon\\Mvc\\Router\\GroupInterface ` $group) Mounts a group of routes in the router public **notFound** (*mixed* $paths) Set a group of paths to be returned when none of the defined routes are matched public **clear** () Removes all the pre-defined routes public **getNamespaceName** () Returns the processed namespace name public **getModuleName** () Returns the processed module name public **getControllerName** () Returns the processed controller name public **getActionName** () Returns the processed action name public **getParams** () Returns the processed parameters public **getMatchedRoute** () Returns the route that matches the handled URI public **getMatches** () Returns the sub expressions in the regular expression matched public **wasMatched** () Checks if the router matches any of the defined routes public **getRoutes** () Returns all the routes defined in the router public **getRouteById** (*mixed* $id) Returns a route object by its id public **getRouteByName** (*mixed* $name) Returns a route object by its name public **isExactControllerName** () Returns whether controller name should not be mangled