final class RouteParameters implements CacheAwareInterface (View source)

This class allows the whole routing behavior to be parametrized.

Route Part implementations can react to given parameters and adjust their matching behavior accordingly if they implement ParameterAwareRoutePartInterface

Routing RouteParameters are usually registered using HTTP components

Methods

static RouteParameters
createEmpty()

Creates an empty instance of this class

withParameter(string $parameterName, bool|float|int|string|CacheAwareInterface $parameterValue)

Create a new instance adding the given parameter

bool
has(string $parameterName)

Checks whether a given parameter exists

bool|float|int|string|CacheAwareInterface|null
getValue(string $parameterName)

Returns the value for a given $parameterName, or NULL if it doesn't exist

bool
isEmpty()

No description

array
toArray()

No description

string
getCacheEntryIdentifier()

No description

Details

static RouteParameters createEmpty()

Creates an empty instance of this class

Return Value

RouteParameters

RouteParameters withParameter(string $parameterName, bool|float|int|string|CacheAwareInterface $parameterValue)

Create a new instance adding the given parameter

Parameters

string $parameterName

name of the parameter to add

bool|float|int|string|CacheAwareInterface $parameterValue

value of the parameter, has to be a literal or an object implementing CacheAwareInterface

Return Value

RouteParameters

a new instance with the given parameters added

bool has(string $parameterName)

Checks whether a given parameter exists

Parameters

string $parameterName

Return Value

bool

bool|float|int|string|CacheAwareInterface|null getValue(string $parameterName)

Returns the value for a given $parameterName, or NULL if it doesn't exist

Parameters

string $parameterName

Return Value

bool|float|int|string|CacheAwareInterface|null

bool isEmpty()

No description

Return Value

bool

array toArray()

No description

Return Value

array

string getCacheEntryIdentifier()

No description

Return Value

string