interface 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> @author Tobias Schultze <http://tobion.de>

@api

Hierarchy

Expanded class hierarchy of UrlGeneratorInterface

All classes that implement UrlGeneratorInterface

6 files declare their use of UrlGeneratorInterface

File

drupal/core/vendor/symfony/routing/Symfony/Component/Routing/Generator/UrlGeneratorInterface.php, line 34

Namespace

Symfony\Component\Routing\Generator
View source

Members

Namesort descending Modifiers Type Description Overrides
RequestContextAwareInterface::getContext public function Gets the request context. 6
RequestContextAwareInterface::setContext public function Sets the request context. 6
UrlGeneratorInterface::ABSOLUTE_PATH constant Generates an absolute path, e.g. "/dir/file".
UrlGeneratorInterface::ABSOLUTE_URL constant Generates an absolute URL, e.g. "http://example.com/dir/file".
UrlGeneratorInterface::generate public function Generates a URL or path for a specific route based on the given parameters. 4
UrlGeneratorInterface::NETWORK_PATH constant Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.
UrlGeneratorInterface::RELATIVE_PATH constant Generates a relative path based on the current request path, e.g. "../parent-file".