TUrlMappingPattern class.
TUrlMappingPattern represents a pattern used to parse and construct URLs. If the currently requested URL matches the pattern, it will alter the THttpRequest parameters. If a constructUrl() call matches the pattern parameters, the pattern will generate a valid URL. In both case, only the PATH_INFO part of a URL is parsed/constructed using the pattern.
To specify the pattern, set the Pattern property. Pattern takes a string expression with parameter names enclosed between a left brace '{' and a right brace '}'. The patterns for each parameter can be set using Parameters attribute collection. For example
- <url ... pattern="articles/{year}/{month}/{day}"
- parameters.year="\d{4}" parameters.month="\d{2}" parameters.day="\d+" />
In the above example, the pattern contains 3 parameters named "year", "month" and "day". The pattern for these parameters are, respectively, "\d{4}" (4 digits), "\d{2}" (2 digits) and "\d+" (1 or more digits). Essentially, the <tt>Parameters</tt> attribute name and values are used as substrings in replacing the placeholders in the <tt>Pattern</tt> string to form a complete regular expression string.
For more complicated patterns, one may specify the pattern using a regular expression by RegularExpression. For example, the above pattern is equivalent to the following regular expression-based pattern:
The above regular expression used the "named group" feature available in PHP. Notice that you need to escape the slash in regular expressions.
- /^articles/(?P<year>d{4})/(?P<month>d{2})/(?P<day>d+)$/u
Thus, only an url that matches the pattern will be valid. For example, a URL <tt>http://example.com/index.php/articles/2006/07/21</tt> will match the above pattern, while <tt>http://example.com/index.php/articles/2006/07/hello</tt> will not since the "day" parameter pattern is not satisfied.
The parameter values are available through the <tt>THttpRequest</tt> instance (e.g. <tt>$this->Request['year']</tt>).
The ServiceParameter and ServiceID (the default ID is 'page') set the service parameter and service id respectively.
Since 3.1.4 you can also use simplyfied wildcard patterns to match multiple ServiceParameters with a single rule. The pattern must contain the placeholder {*} for the ServiceParameter. For example
<url ServiceParameter="adminpages.*" pattern="admin/{*}" />
This rule will match an URL like <tt>http://example.com/index.php/admin/edituser</tt> and resolve it to the page Application.pages.admin.edituser. The wildcard matching is non-recursive. That means you have to add a rule for every subdirectory you want to access pages in:
<url ServiceParameter="adminpages.users.*" pattern="useradmin/{*}" />
It is still possible to define an explicit rule for a page in the wildcard path. This rule has to preceed the wildcard rule.
You can also use parameters with wildcard patterns. The parameters are then available with every matching page:
<url ServiceParameter="adminpages.*" pattern="admin/{*}/{id}" parameters.id="\d+" />
To enable automatic parameter encoding in a path format fro wildcard patterns you can set {@setUrlFormat UrlFormat} to 'Path':
<url ServiceParameter="adminpages.*" pattern="admin/{*}" UrlFormat="Path" />
This will create and parse URLs of the form <tt>.../index.php/admin/listuser/param1/value1/param2/value2</tt>.
Use {@setUrlParamSeparator} to define another separator character between parameter name and value. Parameter/value pairs are always separated by a '/'.
<url ServiceParameter="adminpages.*" pattern="admin/{*}" UrlFormat="Path" UrlParamSeparator="-" />
<tt>.../index.php/admin/listuser/param1-value1/param2-value2</tt>.
Located in /Web/TUrlMapping.php (line 424)
TComponent | --TUrlMappingPattern
Constructor.
Constructs a URL using this pattern.
Returns a value indicating whether to use this pattern to construct URL.
Substitute the parameter key value pairs as named groupings in the regular expression matching pattern.
Uses URL pattern (or full regular expression if available) to match the given url path.
Sets a value indicating whether to enable custom constructUrl using this pattern
Sets the format of URLs constructed and interpreted by this pattern.
A Get URL format is like index.php?name1=value1&name2=value2 while a Path URL format is like index.php/name1/value1/name2/value. The separating character between name and value can be configured with setUrlParamSeparator and defaults to '/'. Changing the UrlFormat will affect constructUrl and how GET variables are parsed.
Inherited From TComponent
TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Documentation generated on Sun, 24 May 2009 16:48:49 -0400 by phpDocumentor 1.3.0RC4