/library/XenForo/Route/Interface.php
PHP | 24 lines | 5 code | 1 blank | 18 comment | 0 complexity | 499e9ef83b438808476d64247c7919cb MD5 | raw file
Possible License(s): LGPL-2.1, GPL-2.0, BSD-3-Clause
- <?php
- /**
- * Interface for a routing rule. Without implementing this interface, a rule will
- * not be able to be added via {@link XenForo_Router::addRule()}.
- *
- * @package XenForo_Mvc
- */
- interface XenForo_Route_Interface
- {
- /**
- * Method to be called when attempting to match this rule against a routing path.
- * Should return false if no matching happened or a {@link XenForo_RouteMatch} if
- * some level of matching happened. If no {@link XenForo_RouteMatch::$controllerName}
- * is returned, the {@link XenForo_Router} will continue to the next rule.
- *
- * @param string Routing path
- * @param Zend_Controller_Request_Http Request object
- * @param XenForo_Router Router that routing is done within
- *
- * @return false|XenForo_RouteMatch
- */
- public function match($routePath, Zend_Controller_Request_Http $request, XenForo_Router $router);
- }