- Openclerk\Router
class Openclerk \ Router
Method Summary
| Name | Description |
|---|---|
| absoluteUrlFor($module, $arguments = array()) | |
| addRoutes($routes) | |
| calculateRelativePath() | Can be cached. |
| checkForWildcardRoute() | Check that we don't have a wildcard route that would cause any additional added routes to be ignored. |
| compileRoutes() | |
| getAdditionalParameters($translated) | Return just additional query parameters that should be included for the given translated URI. |
| getCompiledRoutes() | Get a list of the compiled route keys and resulting matches, only really for debugging. |
| getPHPInclude($translated) | Return just the PHP include that should be included for the given translated URI. |
| process($path) | Given the current path, find the correct PHP template, set the appropriate GET variables and require() the PHP template. |
| resetRoutes() | |
| translate($route) | Get the PHP file that should be included for the given route. |
| urlAdd($url, $arguments = array()) | Add GET arguments onto a particular URL. Replaces any existing arguments. Also handles #hash arguments. |
| urlFor($module, $arguments = array()) |
static function absoluteUrlFor($module, $arguments = array())
- Defaults:
arguments= array()
static function addRoutes($routes)
static function calculateRelativePath()
Can be cached.
static function checkForWildcardRoute()
Check that we don't have a wildcard route that would cause any additional added routes to be ignored.
- Throws:
RouterException - if there is a wildcard route that will cause additional routes to be ignored
static function compileRoutes()
static function getAdditionalParameters($translated)
Return just additional query parameters that should be included for the given translated URI.
static function getCompiledRoutes()
Get a list of the compiled route keys and resulting matches, only really for debugging.
static function getPHPInclude($translated)
Return just the PHP include that should be included for the given translated URI.
static function process($path)
Given the current path, find the correct PHP template, set the appropriate GET variables and require() the PHP template.
static function resetRoutes()
static function translate($route)
Get the PHP file that should be included for the given route.
static function urlAdd($url, $arguments = array())
Add GET arguments onto a particular URL. Replaces any existing arguments. Also handles #hash arguments.
- Defaults:
arguments= array()
static function urlFor($module, $arguments = array())
- Defaults:
arguments= array()