spunQ_DefaultUrlManagerUrlTemplatePart Class Reference
Template part for the default url manager. More...
Public Member Functions | |
| __construct (spunQ_DefaultUrlManagerUrlTemplate $urlTemplate, $string) | |
| Constructor. | |
| getLocaleShortName () | |
| Provides the short name of the locale of the url template. | |
| getLocale () | |
| Provides the locale of the url template. | |
| getString () | |
| Provides the string for parts that are not regular expressions. | |
| getVariableName () | |
| setVariableName ($variableName) | |
| getType () | |
| setType ($type) | |
| getOptions () | |
| setOptions ($options) | |
| getRegularExpression () | |
| Provides the regular expression of this part. | |
| setRegularExpression ($regularExpression) | |
| getUrlTemplate () | |
| Provides the url template this part belongs to. | |
| isRegularExpression () | |
| Whether this part of the url is a regular expression. | |
Private Attributes | |
| $urlTemplate | |
| The url tempalte this object belongs to. | |
| $string | |
| $variableName | |
| $type | |
| $options | |
| $regularExpression | |
Detailed Description
Template part for the default url manager.The object might be in two states (could have been sub-classed, but I'll leave the current implementation for now):
- A static part (one that does not contain a variable, but merely a static string) will only have the members set that have been passed to the constructor.
- The part for a variable wil have all other members set.
- Todo:
- : split into two classes as described in class docs
Definition at line 14 of file DefaultUrlManagerUrlTemplatePart.class.php.
Constructor & Destructor Documentation
| spunQ_DefaultUrlManagerUrlTemplatePart::__construct | ( | spunQ_DefaultUrlManagerUrlTemplate $ | urlTemplate, | |
| $ | string | |||
| ) |
Constructor.
- Parameters:
-
$urlTemplate The url tempalte this object belongs to.
Definition at line 36 of file DefaultUrlManagerUrlTemplatePart.class.php.
Member Function Documentation
| spunQ_DefaultUrlManagerUrlTemplatePart::getLocale | ( | ) |
Provides the locale of the url template.
- Returns:
- spunQ_Locale
Definition at line 56 of file DefaultUrlManagerUrlTemplatePart.class.php.
| spunQ_DefaultUrlManagerUrlTemplatePart::getLocaleShortName | ( | ) |
Provides the short name of the locale of the url template.
- Returns:
- string
Definition at line 47 of file DefaultUrlManagerUrlTemplatePart.class.php.
| spunQ_DefaultUrlManagerUrlTemplatePart::getRegularExpression | ( | ) |
Provides the regular expression of this part.
- Returns:
- string The return value is undefined if isRegularExpression() returns
true.
Implements spunQ_IUrlTemplatePart.
Definition at line 91 of file DefaultUrlManagerUrlTemplatePart.class.php.
| spunQ_DefaultUrlManagerUrlTemplatePart::getString | ( | ) |
Provides the string for parts that are not regular expressions.
- Returns:
- string The return value is undefined if isRegularExpression() returns
false.
Implements spunQ_IUrlTemplatePart.
Definition at line 60 of file DefaultUrlManagerUrlTemplatePart.class.php.
| spunQ_DefaultUrlManagerUrlTemplatePart::getUrlTemplate | ( | ) |
Provides the url template this part belongs to.
- Returns:
- spunQ_IUrlTemplate
Implements spunQ_IUrlTemplatePart.
Definition at line 106 of file DefaultUrlManagerUrlTemplatePart.class.php.
| spunQ_DefaultUrlManagerUrlTemplatePart::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
Implements spunQ_IUrlTemplatePart.
Definition at line 113 of file DefaultUrlManagerUrlTemplatePart.class.php.
Member Data Documentation
spunQ_DefaultUrlManagerUrlTemplatePart::$urlTemplate [private] |
The url tempalte this object belongs to.
Definition at line 20 of file DefaultUrlManagerUrlTemplatePart.class.php.
The documentation for this class was generated from the following file:
