public function WebAssert::buttonExists in Drupal 9

Same name and namespace in other branches

1. 8 core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::buttonExists()

Checks that specific button exists on the current page.

Parameters

string $button: One of id|name|label|value for the button.

\Behat\Mink\Element\TraversableElement $container: (optional) The document to check against. Defaults to the current page.

Return value

\Behat\Mink\Element\NodeElement The matching element.

Throws

\Behat\Mink\Exception\ElementNotFoundException When the element doesn't exist.

File

core/tests/Drupal/Tests/WebAssert.php, line 140

Class

WebAssert

Defines a class with methods for asserting presence of elements during tests.

Namespace

Drupal\Tests

Code

public function buttonExists($button, TraversableElement $container = NULL) {
  if (func_num_args() > 2) {
    @trigger_error('Calling ' . __METHOD__ . ' with more than two arguments is deprecated in drupal:9.1.0 and will throw an \\InvalidArgumentException in drupal:10.0.0. See https://www.drupal.org/node/3162537', E_USER_DEPRECATED);
  }
  $container = $container ?: $this->session
    ->getPage();
  $node = $container
    ->findButton($button);
  if ($node === NULL) {
    throw new ElementNotFoundException($this->session
      ->getDriver(), 'button', 'id|name|label|value', $button);
  }
  return $node;
}