public static function Url::fromUri in Zircon Profile 8

Same name and namespace in other branches

8.0 core/lib/Drupal/Core/Url.php \Drupal\Core\Url::fromUri()

Creates a new Url object from a URI.

This method is for generating URLs for URIs that:

do not have Drupal routes: both external URLs and unrouted local URIs like base:robots.txt
do have a Drupal route but have a custom scheme to simplify linking. Currently, there is only the entity: scheme (This allows URIs of the form entity:{entity_type}/{entity_id}. For example: entity:node/1 resolves to the entity.node.canonical route with a node parameter of 1.)

For URLs that have Drupal routes (that is, most pages generated by Drupal), use Url::fromRoute().

Parameters

string $uri: The URI of the resource including the scheme. For user input that may correspond to a Drupal route, use internal: for the scheme. For paths that are known not to be handled by the Drupal routing system (such as static files), use base: for the scheme to get a link relative to the Drupal base path (like the <base> HTML element). For a link to an entity you may use entity:{entity_type}/{entity_id} URIs.

array $options: (optional) An associative array of additional URL 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.

Note: the internal: scheme should be avoided except when processing actual user input that may or may not correspond to a Drupal route. Normally use Url::fromRoute() for code linking to any any Drupal page.

You can call access() on the returned object to do access checking.

Return value

\Drupal\Core\Url A new Url object with properties depending on the URI scheme.

Throws

\InvalidArgumentException Thrown when the passed in path has no scheme.

File

core/lib/Drupal/Core/Url.php, line 295: Contains \Drupal\Core\Url.

Class

Url: Defines an object that holds information about a URL.

Namespace

Drupal\Core

Code

public static function fromUri($uri, $options = []) {
  $uri_parts = parse_url($uri);
  if ($uri_parts === FALSE) {
    throw new \InvalidArgumentException("The URI '{$uri}' is malformed.");
  }
  if (empty($uri_parts['scheme'])) {
    throw new \InvalidArgumentException("The URI '{$uri}' is invalid. You must use a valid URI scheme.");
  }
  $uri_parts += [
    'path' => '',
  ];

  // Discard empty fragment in $options for consistency with parse_url().
  if (isset($options['fragment']) && strlen($options['fragment']) == 0) {
    unset($options['fragment']);
  }

  // Extract query parameters and fragment and merge them into $uri_options,
  // but preserve the original $options for the fallback case.
  $uri_options = $options;
  if (isset($uri_parts['fragment'])) {
    $uri_options += [
      'fragment' => $uri_parts['fragment'],
    ];
    unset($uri_parts['fragment']);
  }
  if (!empty($uri_parts['query'])) {
    $uri_query = [];
    parse_str($uri_parts['query'], $uri_query);
    $uri_options['query'] = isset($uri_options['query']) ? $uri_options['query'] + $uri_query : $uri_query;
    unset($uri_parts['query']);
  }
  if ($uri_parts['scheme'] === 'entity') {
    $url = static::fromEntityUri($uri_parts, $uri_options, $uri);
  }
  elseif ($uri_parts['scheme'] === 'internal') {
    $url = static::fromInternalUri($uri_parts, $uri_options);
  }
  elseif ($uri_parts['scheme'] === 'route') {
    $url = static::fromRouteUri($uri_parts, $uri_options, $uri);
  }
  else {
    $url = new static($uri, array(), $options);
    if ($uri_parts['scheme'] !== 'base') {
      $url->external = TRUE;
      $url
        ->setOption('external', TRUE);
    }
    $url
      ->setUnrouted();
  }
  return $url;
}

You are here