public function AliasPathProcessor::processOutbound in Drupal 10

Same name and namespace in other branches

9 core/modules/path_alias/src/PathProcessor/AliasPathProcessor.php \Drupal\path_alias\PathProcessor\AliasPathProcessor::processOutbound()

Processes the outbound path.

Parameters

string $path: The path to process, with a leading slash.

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.
'route': The route object for the given path. It will be set by \Drupal\Core\Routing\UrlGenerator::generateFromRoute().

\Symfony\Component\HttpFoundation\Request $request: The HttpRequest object representing the current request.

\Drupal\Core\Render\BubbleableMetadata $bubbleable_metadata: (optional) Object to collect path processors' bubbleable metadata.

Return value

string The processed path.

Overrides OutboundPathProcessorInterface::processOutbound

File

core/modules/path_alias/src/PathProcessor/AliasPathProcessor.php, line 44

Class

AliasPathProcessor: Processes the inbound path using path alias lookups.

Namespace

Drupal\path_alias\PathProcessor

Code

public function processOutbound($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleable_metadata = NULL) {
  if (empty($options['alias'])) {
    $langcode = isset($options['language']) ? $options['language']
      ->getId() : NULL;
    $path = $this->aliasManager
      ->getAliasByPath($path, $langcode);

    // Ensure the resulting path has at most one leading slash, to prevent it
    // becoming an external URL without a protocol like //example.com. This
    // is done in \Drupal\Core\Routing\UrlGenerator::generateFromRoute()
    // also, to protect against this problem in arbitrary path processors,
    // but it is duplicated here to protect any other URL generation code
    // that might call this method separately.
    if (strpos($path, '//') === 0) {
      $path = '/' . ltrim($path, '/');
    }
  }
  return $path;
}

You are here