You are here

public function PathProcessor::processOutbound in Sub-pathauto (Sub-path URL Aliases) 8

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

src/PathProcessor.php, line 119

Class

PathProcessor
Processes the inbound path using path alias lookups.

Namespace

Drupal\subpathauto

Code

public function processOutbound($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleableMetadata = NULL) {
  $original_path = $path;
  $subpath = [];
  $max_depth = $this
    ->getMaxDepth();
  $i = 0;
  while (($path_array = explode('/', ltrim($path, '/'))) && ($max_depth === 0 || $i < $max_depth)) {
    $i++;
    $subpath[] = array_pop($path_array);
    if (empty($path_array)) {
      break;
    }
    $path = '/' . implode('/', $path_array);
    $processed_path = $this->pathProcessor
      ->processOutbound($path, $options, $request);
    if ($processed_path !== $path) {
      $path = $processed_path . '/' . implode('/', array_reverse($subpath));
      return $path;
    }
  }
  return $original_path;
}