function AssertContentTrait::assertFieldByName

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

Asserts that a field exists with the given name and value.

Parameters

string $name: Name of field to assert.

string $value: (optional) Value of the field to assert. You may pass in NULL (default) to skip checking the actual value, while still checking that the field exists.

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, FALSE on fail.

1 call to AssertContentTrait::assertFieldByName()
TextFormatElementFormTest::testTextFormatElement in core/modules/filter/tests/src/Kernel/TextFormatElementFormTest.php
Tests that values are returned.

File

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

Class

AssertContentTrait
Provides test methods to assert content.

Namespace

Drupal\KernelTests

Code

protected function assertFieldByName($name, $value = NULL, $message = NULL) : bool {
    if (!isset($message)) {
        if (!isset($value)) {
            $message = new FormattableMarkup('Found field with name @name', [
                '@name' => var_export($name, TRUE),
            ]);
        }
        else {
            $message = new FormattableMarkup('Found field with name @name and value @value', [
                '@name' => var_export($name, TRUE),
                '@value' => var_export($value, TRUE),
            ]);
        }
    }
    return $this->assertFieldByXPath($this->constructFieldXpath('name', $name), $value, $message);
}

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