public function PathProcessorTest::processOutbound in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/system/tests/modules/url_alter_test/src/PathProcessorTest.php \Drupal\url_alter_test\PathProcessorTest::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/system/tests/modules/url_alter_test/src/PathProcessorTest.php, line 40

Class

PathProcessorTest

Path processor for url_alter_test.

Namespace

Drupal\url_alter_test

Code

public function processOutbound($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleable_metadata = NULL) {

  // Rewrite user/uid to user/username.
  if (preg_match('!^/user/([0-9]+)(/.*)?!', $path, $matches)) {
    if ($account = User::load($matches[1])) {
      $matches += [
        2 => '',
      ];
      $path = '/user/' . $account
        ->getAccountName() . $matches[2];
      if ($bubbleable_metadata) {
        $bubbleable_metadata
          ->addCacheTags($account
          ->getCacheTags());
      }
    }
  }

  // Verify that $options are alterable.
  if ($path == '/user/login') {
    $options['query']['foo'] = 'bar';
  }

  // Rewrite forum/ to community/.
  return preg_replace('@^/forum(.*)@', '/community$1', $path);
}