Interface

Symfony\Component\Routing\RouterInterface

interface RouterInterface implements UrlMatcherInterface, UrlGeneratorInterface

RouterInterface is the interface that all Router classes must implements.

This interface is the concatenation of UrlMatcherInterface and UrlGeneratorInterface.

Methods

setContext(RequestContext $context)

Sets the request context.

from RequestContextAwareInterface
array match(string $pathinfo)

Tries to match a URL with a set of routes.

from UrlMatcherInterface
string generate(string $name, mixed $parameters = array(), Boolean $absolute = false)

Generates a URL from the given parameters.

from UrlGeneratorInterface

Details

public setContext(RequestContext $context)

Sets the request context.

Parameters

RequestContext $context The context

in UrlMatcherInterface at line 37
public array match(string $pathinfo)

Tries to match a URL with a set of routes.

Parameters

string $pathinfo The path info to be parsed

Return Value

array An array of parameters

Exceptions

ResourceNotFoundException If the resource could not be found
MethodNotAllowedException If the resource was found but the request method is not allowed

in UrlGeneratorInterface at line 36
public string generate(string $name, mixed $parameters = array(), Boolean $absolute = false)

Generates a URL from the given parameters.

Parameters

string $name The name of the route
mixed $parameters An array of parameters
Boolean $absolute Whether to generate an absolute URL

Return Value

string The generated URL