Return Value

at line 215

Generates a URL or path for a specific route based on the given parameters.

Parameters that reference placeholders in the route pattern will substitute them in the
path or host. Extra params are added as query string to the URL.

When the passed reference type cannot be generated for the route because it requires a different
host or scheme than the current one, the method will return a more comprehensive reference
that includes the required params. For example, when you call this method with $referenceType = ABSOLUTEPATH
but the route requires the https scheme whereas the current scheme is http, it will instead return an
ABSOLUTEURL with the https scheme and the current host. This makes sure the generated URL matches
the route in any case.

If there is no route with the given name, the generator must throw the RouteNotFoundException.

Parameters

string

$name

The name of the route

mixed

$parameters

An array of parameters

bool|string

$referenceType

The type of reference to be generated (one of the constants)

Return Value

string

The generated URL

Exceptions

RouteNotFoundException

If the named route doesn't exist

MissingMandatoryParametersException

When some parameters are missing that are mandatory for the route

InvalidParameterException

When a parameter value for a placeholder is not correct because it does not match the requirement

at line 223

public array
match(string $pathinfo)

Tries to match a URL path with a set of routes.

If the matcher can not find information, it must throw one of the exceptions documented
below.