XenForo Reference Guide for Developer
Back to top  

Interface for a routing rule.

Without implementing this interface, a rule will not be able to be added via XenForo_Router::addRule().

package XenForo_Mvc

 Methods

Method to be called when attempting to match this rule against a routing path.

match(string $routePath, \Zend_Controller_Request_Http $request, \XenForo_Router $router) : false | \XenForo_RouteMatch

Should return false if no matching happened or a XenForo_RouteMatch if some level of matching happened. If no XenForo_RouteMatch::$controllerName is returned, the XenForo_Router will continue to the next rule.

Parameters

$routePath

string

Routing path

$request

\Zend_Controller_Request_Http

Request object

$router

\XenForo_Router

Router that routing is done within

Returns

false\XenForo_RouteMatch