StaticRoutePart
class StaticRoutePart extends AbstractRoutePart (View source)
Static Route Part
Properties
| protected string | $name | Name of the Route Part |
from AbstractRoutePart |
| protected mixed | $value | Value of the Route Part after decoding. |
from AbstractRoutePart |
| protected mixed | $defaultValue | Default value of the Route Part. |
from AbstractRoutePart |
| protected bool | $isOptional | Specifies whether this Route Part is optional. Which means it's put in parentheses in the routes URI pattern. |
from AbstractRoutePart |
| protected bool | $lowerCase | Specifies whether this Route Part should be converted to lower case when resolved. |
from AbstractRoutePart |
| protected array | $options | Contains options for this Route Part. |
from AbstractRoutePart |
Methods
Returns true if a value is set for this Route Part, otherwise false.
Returns value of the Route Part. Before match() is called this returns NULL.
Returns true if a default value is set for this Route Part, otherwise false.
Sets default value of the Route Part.
Gets default value of the Route Part.
Specifies whether this Route part is optional.
Specifies whether this Route part should be converted to lower case when resolved.
Checks whether this Static Route Part correspond to the given $routePath.
Sets the Route Part value to the Route Part name and returns true if successful.
Details
void
setName(string $partName)
Sets name of the Route Part.
string
getName()
Returns name of the Route Part.
bool
hasValue()
Returns true if a value is set for this Route Part, otherwise false.
mixed
getValue()
Returns value of the Route Part. Before match() is called this returns NULL.
bool
hasDefaultValue()
Returns true if a default value is set for this Route Part, otherwise false.
void
setDefaultValue(mixed $defaultValue)
Sets default value of the Route Part.
mixed
getDefaultValue()
Gets default value of the Route Part.
void
setOptional(bool $isOptional)
Specifies whether this Route part is optional.
bool
isOptional()
Getter for $this->isOptional.
void
setLowerCase(bool $lowerCase)
Specifies whether this Route part should be converted to lower case when resolved.
bool
isLowerCase()
Getter for $this->lowerCase.
void
setOptions(array $options)
Defines options for this Route Part.
Options can be used to enrich a route part with parameters or settings like case sensivity.
array
getOptions()
No description
bool|MatchResult
match(string $routePath)
Checks whether this Static Route Part correspond to the given $routePath.
This is true if $routePath is not empty and the first part is equal to the Route Part name.
bool|ResolveResult
resolve(array $routeValues)
Sets the Route Part value to the Route Part name and returns true if successful.