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.

Symfony\Component\Routing\Generator\UrlGeneratorInterface implements Symfony\Component\Routing\RequestContextAwareInterface

Direct known implementers

Symfony\Component\Routing\Generator\UrlGenerator, Symfony\Component\Routing\RouterInterface

Indirect known implementers

Symfony\Component\Routing\Router

Namespace: Symfony\Component\Routing\Generator
Author: Fabien Potencier <fabien@symfony.com>
Author: Tobias Schultze <http://tobion.de>
Located at Generator/UrlGeneratorInterface.php

Methods summary
`public string`	# `generate( string $name, mixed $parameters = array(), integer $referenceType = Symfony\Component\Routing\Generator\UrlGeneratorInterface::ABSOLUTE_PATH )` Generates a URL or path for a specific route based on the given parameters. 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. Parameters `$name` `string` $name The name of the route `$parameters` `mixed` $parameters An array of parameters `$referenceType` `integer` $referenceType The type of reference to be generated (one of the constants) Returns `string` The generated URL Throws `Symfony\Component\Routing\Exception\RouteNotFoundException` If the named route doesn't exist `Symfony\Component\Routing\Exception\MissingMandatoryParametersException` When some parameters are missing that are mandatory for the route `Symfony\Component\Routing\Exception\InvalidParameterException` When a parameter value for a placeholder is not correct because it does not match the requirement

Methods inherited from Symfony\Component\Routing\RequestContextAwareInterface
`getContext(), setContext()`

Constants summary
`integer`	`ABSOLUTE_URL`	`0`	# Generates an absolute URL, e.g. "http://example.com/dir/file". Generates an absolute URL, e.g. "http://example.com/dir/file".
`integer`	`ABSOLUTE_PATH`	`1`	# Generates an absolute path, e.g. "/dir/file". Generates an absolute path, e.g. "/dir/file".
`integer`	`RELATIVE_PATH`	`2`	# Generates a relative path based on the current request path, e.g. "../parent-file". Generates a relative path based on the current request path, e.g. "../parent-file". See `Symfony\Component\Routing\Generator\UrlGenerator::getRelativePath()`
`integer`	`NETWORK_PATH`	`3`	# Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host. Generates a network path, e.g. "//example.com/dir/file". Such reference reuses the current scheme but specifies the host.

Namespaces

Classes

Interfaces

Interface UrlGeneratorInterface

Direct known implementers

Indirect known implementers

Parameters

Returns

Throws

See