## Class TUrlMappingPattern

Description

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:

     /^articles/(?P<year>d{4})/(?P<month>d{2})/(?P<day>d+)$/u

The above regular expression used the "named group" feature available in PHP. Notice that you need to escape the slash in regular expressions.

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>.

- since: 3.0.5
- version: $Id: TUrlMapping.php 2584 2008-12-04 17:05:12Z haertl.mike $
- author: Wei Zhuo <weizhuo[at]gmail[dot]com>

Located in /Web/TUrlMapping.php (line 424)

    TComponent
       |
       --TUrlMappingPattern

Method Summary
TUrlMappingPattern __construct (TUrlManager $manager)
string constructUrl (array $getItems, boolean $encodeAmpersand, boolean $encodeGetItems)
boolean getCaseSensitive ()
boolean getEnableCustomUrl ()
boolean getIsWildCardPattern ()
TUrlManager getManager ()
string getParameterizedPattern ()
TAttributeCollection getParameters ()
string getPattern ()
array getPatternMatches (THttpRequest $request)
string getRegularExpression ()
string getServiceID ()
string getServiceParameter ()
THttpRequestUrlFormat getUrlFormat ()
string getUrlParamSeparator ()
void init (TXmlElement $config)
void setCaseSensitive (boolean $value)
void setEnableCustomUrl (boolean $value)
void setParameters (TAttributeCollection $value)
void setPattern (string $value)
void setRegularExpression (string $value)
void setServiceID (string $value)
void setServiceParameter (string $value)
void setUrlFormat (THttpRequestUrlFormat $value, since 1)
void setUrlParamSeparator (string $value)
boolean supportCustomUrl (array $getItems)
Methods
Constructor __construct (line 463)

Constructor.

- access: public

TUrlMappingPattern __construct (TUrlManager $manager)

- TUrlManager $manager: the URL manager instance

constructUrl (line 752)

Constructs a URL using this pattern.

- return: the constructed URL
- access: public
- since: 3.1.1

string constructUrl (array $getItems, boolean $encodeAmpersand, boolean $encodeGetItems)

- array $getItems: list of GET variables
- boolean $encodeAmpersand: whether the ampersand should be encoded in the constructed URL
- boolean $encodeGetItems: whether the GET variables should be encoded in the constructed URL

getCaseSensitive (line 542)

- return: whether the Pattern should be treated as case sensititve. Defaults to true.
- access: public

boolean getCaseSensitive ()
getEnableCustomUrl (line 661)

Returns a value indicating whether to use this pattern to construct URL.

- return: whether to enable custom constructUrl. Defaults to true.
- access: public
- since: 3.1.1

boolean getEnableCustomUrl ()
getIsWildCardPattern (line 679)

- return: whether this pattern is a wildcard pattern
- access: public
- since: 3.1.4

boolean getIsWildCardPattern ()
getManager (line 473)

- return: the URL manager instance
- access: public

TUrlManager getManager ()
getParameterizedPattern (line 496)

Substitute the parameter key value pairs as named groupings in the regular expression matching pattern.

- return: regular expression pattern with parameter subsitution
- access: protected

string getParameterizedPattern ()
getParameters (line 606)

- return: parameter key value pairs.
- access: public

TAttributeCollection getParameters ()
getPattern (line 590)

- return: url pattern to match. Defaults to ''.
- access: public

string getPattern ()
getPatternMatches (line 625)

Uses URL pattern (or full regular expression if available) to match the given url path.

- return: matched parameters, empty if no matches.
- access: public

array getPatternMatches (THttpRequest $request)

- THttpRequest $request: the request module

getRegularExpression (line 526)

- return: full regular expression mapping pattern
- access: public

string getRegularExpression ()
getServiceID (line 582)

- return: service id.
- access: public

string getServiceID ()
getServiceParameter (line 566)

- return: service parameter, such as page class name.
- access: public

string getServiceParameter ()
getUrlFormat (line 686)

- return: the format of URLs. Defaults to THttpRequestUrlFormat::Get.
- access: public

THttpRequestUrlFormat getUrlFormat ()
getUrlParamSeparator (line 710)

- return: separator used to separate GET variable name and value when URL format is Path. Defaults to slash '/'.
- access: public

string getUrlParamSeparator ()
init (line 483)

Initializes the pattern.

- access: public
- throws: TConfigurationException if service parameter is not specified

void init (TXmlElement $config)

- TXmlElement $config: configuration for this module.

setCaseSensitive (line 550)

- access: public

void setCaseSensitive (boolean $value)

- boolean $value: whether the Pattern should be treated as case sensititve.

setEnableCustomUrl (line 670)

Sets a value indicating whether to enable custom constructUrl using this pattern

- access: public

void setEnableCustomUrl (boolean $value)

- boolean $value: whether to enable custom constructUrl.

setParameters (line 614)

- access: public

void setParameters (TAttributeCollection $value)

- TAttributeCollection $value: new parameter key value pairs.

setPattern (line 598)

- access: public

void setPattern (string $value)

- string $value: url pattern to match.

setRegularExpression (line 534)

- access: public

void setRegularExpression (string $value)

- string $value: full regular expression mapping pattern.

setServiceID (line 574)

- access: public

void setServiceID (string $value)

- string $value: service id to handle.

setServiceParameter (line 558)

- access: public

void setServiceParameter (string $value)

- string $value: service parameter, such as page class name.

setUrlFormat (line 702)

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.

- access: public

void setUrlFormat (THttpRequestUrlFormat $value, since 1)

- since 1: 3.1.4
- THttpRequestUrlFormat $value: the format of URLs.

setUrlParamSeparator (line 719)

- access: public
- throws: TInvalidDataValueException if the separator is not a single character

void setUrlParamSeparator (string $value)

- string $value: separator used to separate GET variable name and value when URL format is Path.

supportCustomUrl (line 732)

- return: whether this pattern IS the one for constructing the URL with the specified GET items.
- access: public
- since: 3.1.1

boolean supportCustomUrl (array $getItems)

- array $getItems: list of GET items to be put in the constructed URL

#### Inherited Methods

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, 11 Jan 2009 20:24:18 -0500 by phpDocumentor 1.3.0RC4