protected function AssertContentTrait::assertNoDuplicateIds in Drupal 9

Same name and namespace in other branches

8 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertNoDuplicateIds()

Asserts that each HTML ID is used for just a single element.

Parameters

string $message: (optional) A message to display with the assertion. Do not translate messages: use \Drupal\Component\Render\FormattableMarkup to embed variables in the message text, not t(). If left blank, a default message will be displayed.

string $group: (optional) The group this message is in, which is displayed in a column in test output. Use 'Debug' to indicate this is debugging output. Do not translate this string. Defaults to 'Other'; most tests do not override this default.

array $ids_to_skip: An optional array of ids to skip when checking for duplicates. It is always a bug to have duplicate HTML IDs, so this parameter is to enable incremental fixing of core code. Whenever a test passes this parameter, it should add a "todo" comment above the call to this function explaining the legacy bug that the test wishes to ignore and including a link to an issue that is working to fix that legacy bug.

Return value

bool TRUE on pass.

File

core/tests/Drupal/KernelTests/AssertContentTrait.php, line 1476

Class

AssertContentTrait: Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function assertNoDuplicateIds($message = '', $group = 'Other', $ids_to_skip = []) {
  $status = TRUE;
  foreach ($this
    ->xpath('//*[@id]') as $element) {
    $id = (string) $element['id'];
    if (isset($seen_ids[$id]) && !in_array($id, $ids_to_skip)) {
      $this
        ->fail(new FormattableMarkup('The HTML ID %id is unique.', [
        '%id' => $id,
      ]), $group);
      $status = FALSE;
    }
    $seen_ids[$id] = TRUE;
  }
  $this
    ->assertTrue($status, $message);
  return TRUE;
}

You are here