spunQ_IUrlTemplatePart Interface Reference
Part of a url template. More...
Inheritance diagram for spunQ_IUrlTemplatePart:
Public Member Functions | |
| getString () | |
| Provides the string for parts that are not regular expressions. | |
| getRegularExpression () | |
| Provides the regular expression of this part. | |
| getUrlTemplate () | |
| Provides the url template this part belongs to. | |
| isRegularExpression () | |
| Whether this part of the url is a regular expression. | |
Detailed Description
Part of a url template.A url template consists of url parts that are separated by slashes to emulate a folder hierarchy.
Definition at line 8 of file IUrlTemplatePart.interface.php.
Member Function Documentation
| spunQ_IUrlTemplatePart::getRegularExpression | ( | ) |
Provides the regular expression of this part.
- Returns:
- string The return value is undefined if isRegularExpression() returns
true.
Implemented in spunQ_DefaultUrlManagerUrlTemplatePart.
| spunQ_IUrlTemplatePart::getString | ( | ) |
Provides the string for parts that are not regular expressions.
- Returns:
- string The return value is undefined if isRegularExpression() returns
false.
Implemented in spunQ_DefaultUrlManagerUrlTemplatePart.
| spunQ_IUrlTemplatePart::getUrlTemplate | ( | ) |
Provides the url template this part belongs to.
- Returns:
- spunQ_IUrlTemplate
Implemented in spunQ_DefaultUrlManagerUrlTemplatePart.
| spunQ_IUrlTemplatePart::isRegularExpression | ( | ) |
Whether this part of the url is a regular expression.
Very important to be able to compare url templates for sorting them.
- Returns:
- boolean
Implemented in spunQ_DefaultUrlManagerUrlTemplatePart.
The documentation for this interface was generated from the following file:
