function AssertContentTrait::assertFieldChecked

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertFieldChecked()
  2. 8.9.x core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertFieldChecked()
  3. 10 core/tests/Drupal/KernelTests/AssertContentTrait.php \Drupal\KernelTests\AssertContentTrait::assertFieldChecked()

Asserts that a checkbox field in the current page is checked.

Parameters

string $id: ID of field to assert.

string $message: (optional) A message to display with the assertion. Do not translate messages with t(). Use double quotes and embed variables directly in message text, or use sprintf() if necessary. Avoid the use of \Drupal\Component\Render\FormattableMarkup unless you cast the object to a string. If left blank, a default message will be displayed.

Return value

bool TRUE on pass.

Deprecated

in drupal:11.1.0 and is removed from drupal:12.0.0. There is no replacement.

See also

https://www.drupal.org/node/3476110

File

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

Class

AssertContentTrait
Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function assertFieldChecked($id, $message = '') : bool {
    @trigger_error(__METHOD__ . '() is deprecated in drupal:11.1.0 and is removed from drupal:12.0.0. There is no replacement. See https://www.drupal.org/node/3476110', E_USER_DEPRECATED);
    $message = $message ? $message : new FormattableMarkup('Checkbox field @id is checked.', [
        '@id' => $id,
    ]);
    $elements = $this->xpath('//input[@id=:id]', [
        ':id' => $id,
    ]);
    $this->assertNotEmpty($elements, $message);
    $this->assertNotEmpty($elements[0]['checked'], $message);
    return TRUE;
}

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