function WebAssert::hiddenFieldValueEquals

Same name in other branches
  1. 8.9.x core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::hiddenFieldValueEquals()
  2. 10 core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::hiddenFieldValueEquals()
  3. 11.x core/tests/Drupal/Tests/WebAssert.php \Drupal\Tests\WebAssert::hiddenFieldValueEquals()

Checks that specific hidden field have provided value.

Parameters

string $field: One of id|name|value for the hidden field.

string $value: The hidden field value that needs to be checked.

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

Throws

\Behat\Mink\Exception\ElementNotFoundException

\Behat\Mink\Exception\ExpectationException

File

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

Class

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

Namespace

Drupal\Tests

Code

public function hiddenFieldValueEquals($field, $value, TraversableElement $container = NULL) {
    if (func_num_args() > 3) {
        @trigger_error('Calling ' . __METHOD__ . ' with more than three 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);
    }
    $node = $this->hiddenFieldExists($field, $container);
    $actual = $node->getValue();
    $regex = '/^' . preg_quote($value, '/') . '$/ui';
    $message = "The hidden field '{$field}' value is '{$actual}', but '{$value}' expected.";
    $this->assert((bool) preg_match($regex, $actual), $message);
}

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