extends abstract class Phalcon\Router
implements Phalcon\RouterInterface, Phalcon\Di\InjectionAwareInterface, Phalcon\Events\EventsAwareInterface, Phalcon\Mvc\RouterInterface
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
<?php
$router = new Phalcon\Mvc\Router();
$router->add(
"/documentation/{chapter}/{name}.{type:[a-z]+}",
array(
"controller" => "documentation",
"action" => "show"
)
);
$router->handle();
echo $router->getControllerName();
integer MODE_DEFAULT
integer MODE_NONE
integer MODE_REST
integer URI_SOURCE_GET_URL
integer URI_SOURCE_SERVER_REQUEST_URI
public __construct ([boolean $defaultRoutes])
Phalcon\Mvc\Router constructor
public string getRewriteUri ()
Get rewrite info. This info is read from $_GET[‘_url’]. This returns ‘/’ if the rewrite information cannot be read
public Phalcon\Mvc\Router setUriSource (int $uriSource)
Sets the URI source. One of the URI_SOURCE_* constants
<?php
$router->setUriSource(Router::URI_SOURCE_SERVER_REQUEST_URI);
public Phalcon\Mvc\Router removeExtraSlashes (boolean $remove)
Set whether router must remove the extra slashes in the handled routes
public Phalcon\Mvc\Router 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
<?php
$router->setDefaults(array(
'module' => 'common',
'action' => 'index'
));
public array getDefaults ()
Returns an array of default parameters
public handle ([string $uri])
Handles routing information received from the rewrite engine
<?php
//Read the info from the rewrite engine
$router->handle();
//Manually passing an URL
$router->handle('/posts/edit/1');
public Phalcon\Mvc\Router\Route add (string $pattern, [string/array $paths], [array $regex], [string $httpMethods])
Adds a route to the router without any HTTP constraint
<?php
$router->add('/about', 'About::index');
public Phalcon\Mvc\Router\Route addGet (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is GET
public Phalcon\Mvc\Router\Route addPost (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is POST
public Phalcon\Mvc\Router\Route addPut (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is PUT
public Phalcon\Mvc\Router\Route addPatch (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is PATCH
public Phalcon\Mvc\Router\Route addDelete (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is DELETE
public Phalcon\Mvc\Router\Route addOptions (string $pattern, [string/array $paths], [unknown $regex])
Add a route to the router that only match if the HTTP method is OPTIONS
public Phalcon\Mvc\Router\Route addHead (string $pattern, [string/array $paths], [unknown $regex])
Adds a route to the router that only match if the HTTP method is HEAD
public Phalcon\Mvc\Router mount (Phalcon\Mvc\Router\Group $group)
Mounts a group of routes in the router
public Phalcon\Mvc\Router notFound (array|string $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 Phalcon\Mvc\Router\Route getMatchedRoute ()
Returns the route that matchs the handled URI
public array getMatches ()
Returns the sub expressions in the regular expression matched
public boolean wasMatched ()
Checks if the router macthes any of the defined routes
public Phalcon\Mvc\Router\Route [] getRoutes ()
Returns all the routes defined in the router
public Phalcon\Mvc\Router\Route | false getRouteById (string $id)
Returns a route object by its id
public Phalcon\Mvc\Router\Route getRouteByName (string $name)
Returns a route object by its name
public isExactControllerName ()
Returns whether controller name should not be mangled
public setDefaultController (unknown $handlerName)
Sets the default controller name
public string getDefaultController ()
Gets the default controller name
public setControllerName (unknown $handlerName)
Sets the controller name
public string getControllerName ()
Gets the controller name
public setDefaultModule (string $moduleName) inherited from Phalcon\Router
Sets the name of the default module
public string getDefaultModule () inherited from Phalcon\Router
Gets the name of the default module
public setDefaultNamespace (string $namespaceName) inherited from Phalcon\Router
Sets the name of the default namespace
public string getDefaultNamespace () inherited from Phalcon\Router
Gets the name of the default namespace
public setDefaultHandler (unknown $handlerName) inherited from Phalcon\Router
Sets the default handle name
public string getDefaultHandler () inherited from Phalcon\Router
Gets the default handle name
public setDefaultAction (string $actionName) inherited from Phalcon\Router
Sets the default action name
public string getDefaultAction () inherited from Phalcon\Router
Gets the default action name
public setDefaultParams (array $params) inherited from Phalcon\Router
Sets the default extra params
public string getDefaultParams () inherited from Phalcon\Router
Gets the default extra params
public string setCaseSensitive (boolean $caseSensitive) inherited from Phalcon\Router
Sets the case sensitive
public boolean getCaseSensitive () inherited from Phalcon\Router
Returns the case sensitive
public setMode (int $mode) inherited from Phalcon\Router
Sets the mode
public getMode () inherited from Phalcon\Router
Gets the mode
public setModuleName (string $moduleName) inherited from Phalcon\Router
Sets proccesed module name
public string getModuleName () inherited from Phalcon\Router
Returns proccesed module name
public setNamespaceName (string $namespaceName) inherited from Phalcon\Router
Sets proccesed namespace name
public string getNamespaceName () inherited from Phalcon\Router
Returns proccesed namespace name
public setHandlerName (unknown $handlerName) inherited from Phalcon\Router
Sets proccesed handle name
public string getHandlerName () inherited from Phalcon\Router
Returns proccesed handle name
public setActionName (string $actionName) inherited from Phalcon\Router
Sets proccesed action name
public string getActionName () inherited from Phalcon\Router
Returns proccesed action name
public setParams (array $params) inherited from Phalcon\Router
Sets proccesed extra params
public array getParams () inherited from Phalcon\Router
Returns proccesed extra params
public setDI (Phalcon\DiInterface $dependencyInjector) inherited from Phalcon\Di\Injectable
Sets the dependency injector
public Phalcon\DiInterface getDI ([unknown $error], [unknown $notUseDefault]) inherited from Phalcon\Di\Injectable
Returns the internal dependency injector
public setEventsManager (Phalcon\Events\ManagerInterface $eventsManager) inherited from Phalcon\Di\Injectable
Sets the event manager
public Phalcon\Events\ManagerInterface getEventsManager () inherited from Phalcon\Di\Injectable
Returns the internal event manager
public boolean fireEvent (string $eventName, [mixed $data], [unknown $cancelable]) inherited from Phalcon\Di\Injectable
Fires an event, implicitly calls behaviors and listeners in the events manager are notified
public mixed fireEventCancel (string $eventName, [mixed $data], [unknown $cancelable]) inherited from Phalcon\Di\Injectable
Fires an event, can stop the event by returning to the false
public boolean hasService (string $name) inherited from Phalcon\Di\Injectable
Check whether the DI contains a service by a name
public Phalcon\Di\ServiceInterface setService (unknown $name) inherited from Phalcon\Di\Injectable
Sets a service from the DI
public object|null getService (unknown $name) inherited from Phalcon\Di\Injectable
Obtains a service from the DI
public mixed getResolveService (string $name, [array $args], [unknown $noerror], [unknown $noshared]) inherited from Phalcon\Di\Injectable
Resolves the service based on its configuration
public attachEvent (string $eventType, Closure $callback) inherited from Phalcon\Di\Injectable
Attach a listener to the events
public __get (unknown $property) inherited from Phalcon\Di\Injectable
Magic method __get
public __sleep () inherited from Phalcon\Di\Injectable
...
public __debugInfo () inherited from Phalcon\Di\Injectable
...