PageRenderTime 42ms CodeModel.GetById 18ms RepoModel.GetById 1ms app.codeStats 0ms

/library/XenForo/Route/Interface.php

https://github.com/hanguyenhuu/DTUI_201105
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
  1. <?php
  2. /**
  3. * Interface for a routing rule. Without implementing this interface, a rule will
  4. * not be able to be added via {@link XenForo_Router::addRule()}.
  5. *
  6. * @package XenForo_Mvc
  7. */
  8. interface XenForo_Route_Interface
  9. {
  10. /**
  11. * Method to be called when attempting to match this rule against a routing path.
  12. * Should return false if no matching happened or a {@link XenForo_RouteMatch} if
  13. * some level of matching happened. If no {@link XenForo_RouteMatch::$controllerName}
  14. * is returned, the {@link XenForo_Router} will continue to the next rule.
  15. *
  16. * @param string Routing path
  17. * @param Zend_Controller_Request_Http Request object
  18. * @param XenForo_Router Router that routing is done within
  19. *
  20. * @return false|XenForo_RouteMatch
  21. */
  22. public function match($routePath, Zend_Controller_Request_Http $request, XenForo_Router $router);
  23. }