Symfony\Component\Routing\Generator\UrlGeneratorInterface
UrlGeneratorInterface is the interface that all URL generator classes must implement.
The constants in this interface define the different types of resource references that
are declared in RFC 3986: http://tools.ietf.org/html/rfc3986
We are using the term "URL" instead of "URI" as this is more common in web applications
and we do not need to distinguish them as the difference is mostly semantical and
less technical. Generating URIs, i.e. representation-independent resource identifiers,
is also possible.
- Author: Fabien Potencier <fabien@symfony.com>
Synopsis
interface UrlGeneratorInterface
extends RequestContextAwareInterface
{
- // constants
- const ABSOLUTE_URL = ;
- const ABSOLUTE_PATH = ;
- const RELATIVE_PATH = 'relative';
- const NETWORK_PATH = 'network';
- // methods
- public string generate()
- // Inherited methods from RequestContextAwareInterface
- public void setContext()
- public RequestContext getContext()
Hierarchy
Extends
Extended by
Implemented by
Constants
Name | Value |
---|---|
ABSOLUTE_URL | |
ABSOLUTE_PATH | |
RELATIVE_PATH | 'relative' |
NETWORK_PATH | 'network' |
Methods
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.