Symfony\Component\Routing\RouterInterface
RouterInterface is the interface that all Router classes must implement.
This interface is the concatenation of UrlMatcherInterface and UrlGeneratorInterface.
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
interface RouterInterface
extends UrlMatcherInterface, UrlGeneratorInterface
{
- // Inherited constants from UrlGeneratorInterface
- const ABSOLUTE_URL = ;
- const ABSOLUTE_PATH = ;
- const RELATIVE_PATH = 'relative';
- const NETWORK_PATH = 'network';
- // methods
- public RouteCollection getRouteCollection()
- // Inherited methods from UrlMatcherInterface
- public array match()
- // Inherited methods from UrlGeneratorInterface
- public string generate()
- // Inherited methods from RequestContextAwareInterface
- public void setContext()
- public RequestContext getContext()
Hierarchy
Extends
- Symfony\Component\Routing\Matcher\UrlMatcherInterface
- Symfony\Component\Routing\Generator\UrlGeneratorInterface
Implemented by
Constants
Name | Value |
---|---|
ABSOLUTE_URL | |
ABSOLUTE_PATH | |
RELATIVE_PATH | 'relative' |
NETWORK_PATH | 'network' |
Methods
public
- getRouteCollection() — Gets the RouteCollection instance associated with this Router.
Inherited from Symfony\Component\Routing\Matcher\UrlMatcherInterface
public
- match() — Tries to match a URL path with a set of routes.
Inherited from Symfony\Component\Routing\Generator\UrlGeneratorInterface
public
- generate() — Generates a URL or path for a specific route based on the given parameters.
Inherited from Symfony\Component\Routing\RequestContextAwareInterface
public
- getContext() — Gets the request context.
- setContext() — Sets the request context.