1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Routing
  7. \
  8. UrlGeneratorInterface

UrlGeneratorInterface

interface UrlGeneratorInterface implements UrlGeneratorInterface (View source)

Defines an interface for generating a url from a route or system path.

Provides additional methods and options not present in the base interface.

Methods

string
getPathFromRoute(string|Route $name, array $parameters = [])

Gets the internal path (system path) for a route.

string|GeneratedUrl
generateFromRoute(string|Route $name, array $parameters = [], array $options = [], bool $collect_bubbleable_metadata = FALSE)

Generates a URL or path for a specific route based on the given parameters.

Details

at line 27
string getPathFromRoute(string|Route $name, array $parameters = [])

Gets the internal path (system path) for a route.

Parameters

string|Route $name

The route name or a route object.
array $parameters

An array of parameters as passed to \Symfony\Component\Routing\Generator\UrlGeneratorInterface::generate().

Return Value

string

The internal Drupal path corresponding to the route. This string is not urlencoded and will be an empty string for the front page.

at line 81
string|GeneratedUrl generateFromRoute(string|Route $name, array $parameters = [], array $options = [], bool $collect_bubbleable_metadata = FALSE)

internal  Should not be used in user code. Use \Drupal\Core\Url instead.
 

Generates a URL or path for a specific route based on the given parameters.

Parameters that reference placeholders in the route pattern will be substituted for them in the pattern. Extra params are added as query strings to the URL.

Parameters

string|Route $name

The route name or a route object.
array $parameters

An associative array of parameter names and values.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'query': An array of query key/value-pairs (without any URL-encoding) to append to the URL.
  • 'fragment': A fragment identifier (named anchor) to append to the URL. Do not include the leading '#' character.
  • 'absolute': Defaults to FALSE. Whether to force the output to be an absolute link (beginning with http:). Useful for links that will be displayed outside the site, such as in an RSS feed.
  • 'language': An optional language object used to look up the alias for the URL. If $options['language'] is omitted, it defaults to the current language for the language type LanguageInterface::TYPE_URL.
  • 'https': Whether this URL should point to a secure location. If not defined, the current scheme is used, so the user stays on HTTP or HTTPS respectively. TRUE enforces HTTPS and FALSE enforces HTTP.
  • 'base_url': Only used internally by a path processor, for example, to modify the base URL when a language dependent URL requires so.
  • 'prefix': Only used internally, to modify the path when a language dependent URL requires so.
bool $collect_bubbleable_metadata

(optional) Defaults to FALSE. When TRUE, both the generated URL and its associated bubbleable metadata are returned.

Return Value

string|GeneratedUrl

The generated URL for the given route. When $collect_bubbleable_metadata is TRUE, a GeneratedUrl object is returned, containing the generated URL plus bubbleable metadata.

Exceptions

RouteNotFoundException
MissingMandatoryParametersException
InvalidParameterException