Simple global convenience object to hold information for a single route.
| package |
CMS |
|---|---|
| license |
GPL |
| author |
Robert Campbell calguy1000@cmsmadesimple.org |
| since | 1.9 |
__construct(string $term, string $key1 = '', array $defaults = null, boolean $is_absolute = FALSE, string $key2 = null, string $key3 = null)
string $termThe route string (or regular expression)
string $key1The first key. Usually a module name.
array $defaultsAn array of parameter defaults for this module. Only applicable when the destination is a module.
boolean $is_absoluteFlag indicating wether the term is a regular expression or an absolute string.
string $key2The second key.
string $key3The second key.
new_builder(string $term, string $key1, string $key2 = '', array $defaults = null, boolean $is_absolute = FALSE, string $key3 = '')
string $termThe route string (or regular expression)
string $key1The first key. Usually a module name
string $key2The second key
array $defaultsAn array of parameter defaults for this module. Only applicable when the destination is a module
boolean $is_absoluteFlag indicating wether the term is a regular expression or an absolute string
string $key3The second key
signature()
get_term() : string
string
get_dest() : string
string
Destination module name. or null.
get_content() : integer
integer
Page id, or null.
get_defaults() : array
array
The default parameters for the route.. Null if no defaults specified.
is_content() : boolean
boolean
get_results() : array
Must be called AFTER the matches method to get the resulting parameters from the URI and route
array
Matching parameters... or Null
matches(string $str, boolean $exact = false) : boolean
string $strThe input string
boolean $exactPerform an exact string match rather than depending on the route values.
boolean
term : string
string key1 : string
string key2 : string
string key3 : string
string defaults : array
array absolute : boolean
boolean results : string
string