1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Utility
  7. \
  8. UnroutedUrlAssembler

UnroutedUrlAssembler

class UnroutedUrlAssembler implements UnroutedUrlAssemblerInterface (View source)

Provides a way to build external or non Drupal local domain URLs.

It takes into account configured safe HTTP protocols.

Properties

protected RequestStack $requestStack

A request stack object.
protected OutboundPathProcessorInterface $pathProcessor

The outbound path processor.

Methods

__construct(RequestStack $request_stack, OutboundPathProcessorInterface $path_processor, array $filter_protocols = ['http', 'https'])

Constructs a new unroutedUrlAssembler object.

string|GeneratedUrl
assemble(string $uri, array $options = [], bool $collect_bubbleable_metadata = FALSE)

Builds a domain-local or external URL from a URI.

buildExternalUrl($uri, array $options = [], $collect_bubbleable_metadata = FALSE)

{@inheritdoc}

buildLocalUrl($uri, array $options = [], $collect_bubbleable_metadata = FALSE)

{@inheritdoc}

addOptionDefaults(array $options)

Merges in default defaults.

Details

at line 42
__construct(RequestStack $request_stack, OutboundPathProcessorInterface $path_processor, array $filter_protocols = ['http', 'https'])

Constructs a new unroutedUrlAssembler object.

Parameters

RequestStack $request_stack

A request stack object.
OutboundPathProcessorInterface $path_processor

The output path processor.
array $filter_protocols

(optional) An array of protocols allowed for URL generation.

at line 54
string|GeneratedUrl assemble(string $uri, array $options = [], bool $collect_bubbleable_metadata = FALSE)

Builds a domain-local or external URL from a URI.

For actual implementations the logic probably has to be split up between domain-local URIs and external URLs.

Parameters

string $uri

A local URI or an external URL being linked to, such as "base:foo" or "http://example.com/foo".

  • If you provide a full URL, it will be considered an external URL as long as it has an allowed protocol.
  • If you provide only a local URI (e.g. "base:foo"), it will be considered a path local to Drupal, but not handled by the routing system. The base path (the subdirectory where the front controller is found) will be added to the path. Additional query arguments for local paths must be supplied in $options['query'], not part of $uri.
  • If your external URL contains a query (e.g. http://example.com/foo?a=b), then you can either URL encode the query keys and values yourself and include them in $uri, or use $options['query'] to let this method URL encode them.
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.
  • '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.
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

A string containing a relative or absolute URL. When $collect_bubbleable_metadata is TRUE, a GeneratedUrl object is returned, containing the generated URL plus bubbleable metadata.

Exceptions

InvalidArgumentException

at line 71
protected buildExternalUrl($uri, array $options = [], $collect_bubbleable_metadata = FALSE)

{@inheritdoc}

Parameters

$uri
array $options
$collect_bubbleable_metadata

at line 106
protected buildLocalUrl($uri, array $options = [], $collect_bubbleable_metadata = FALSE)

{@inheritdoc}

Parameters

$uri
array $options
$collect_bubbleable_metadata

at line 170
protected addOptionDefaults(array $options)

Merges in default defaults.

Parameters

array $options

The options to merge in the defaults.