interface RouterInterface implements UrlMatcherInterface, UrlGeneratorInterface
RouterInterface is the interface that all Router classes must implement.
This interface is the concatenation of UrlMatcherInterface and UrlGeneratorInterface.
Methods
| array |
match(string $pathinfo)
Tries to match a URL path with a set of routes. |
from UrlMatcherInterface |
| string |
generate(string $name, mixed $parameters = array(), Boolean|string $referenceType = self::ABSOLUTE_PATH)
Generates a URL or path for a specific route based on the given parameters. |
from UrlGeneratorInterface |
| RouteCollection |
getRouteCollection()
Gets the RouteCollection instance associated with this Router. |
Details
in UrlMatcherInterface at line 42
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.
in UrlGeneratorInterface at line 86
public string
generate(string $name, mixed $parameters = array(), Boolean|string $referenceType = self::ABSOLUTE_PATH)
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 = ABSOLUTE_PATH
but the route requires the https scheme whereas the current scheme is http, it will instead return an
ABSOLUTE_URL 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.
at line 31
public RouteCollection
getRouteCollection()
Gets the RouteCollection instance associated with this Router.