function AssertBreadcrumbTrait::assertBreadcrumbParts

Same name and namespace in other branches
  1. 11.x core/modules/system/tests/src/Functional/Menu/AssertBreadcrumbTrait.php \Drupal\Tests\system\Functional\Menu\AssertBreadcrumbTrait::assertBreadcrumbParts()

Assert that a trail exists in the internal browser.

Parameters

array $trail: An associative array whose keys are expected breadcrumb link paths and whose values are expected breadcrumb link texts (not sanitized).

File

core/modules/system/tests/src/Functional/Menu/AssertBreadcrumbTrait.php, line 65

Class

AssertBreadcrumbTrait
Provides test assertions for verifying breadcrumbs.

Namespace

Drupal\Tests\system\Functional\Menu

Code

protected function assertBreadcrumbParts($trail) {
  // Compare paths with actual breadcrumb.
  $parts = $this->getBreadcrumbParts();
  $pass = TRUE;
  // Fail if there is no breadcrumb and we have a trail.
  if (!empty($trail) && empty($parts)) {
    $pass = FALSE;
  }
  // There may be more than one breadcrumb on the page. If $trail is empty
  // this test would go into an infinite loop, so we need to check that too.
  while ($trail && !empty($parts)) {
    foreach ($trail as $path => $title) {
      // If the path is empty, generate the path from the <front> route.  If
      // the path does not start with a leading slash, then run it through
      // Url::fromUri('base:')->toString() to get the correct base
      // prepended.
      if ($path == '') {
        $url = Url::fromRoute('<front>')->toString();
      }
      elseif ($path[0] != '/') {
        $url = Url::fromUri('base:' . $path)->toString();
      }
      else {
        $url = $path;
      }
      $part = array_shift($parts);
      $pass = $pass && $part['href'] === $url && $part['text'] === Html::escape($title);
    }
  }
  // No parts must be left, or an expected "Home" will always pass.
  $pass = $pass && empty($parts);
  $this->assertTrue($pass, new FormattableMarkup('Breadcrumb %parts found on @path.', [
    '%parts' => implode(' » ', $trail),
    '@path' => $this->getUrl(),
  ]));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.