function FieldKernelTestBase::assertFieldValues

Same name in other branches
  1. 9 core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase::assertFieldValues()
  2. 8.9.x core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase::assertFieldValues()
  3. 10 core/modules/field/tests/src/Kernel/FieldKernelTestBase.php \Drupal\Tests\field\Kernel\FieldKernelTestBase::assertFieldValues()

Assert that a field has the expected values in an entity.

This function only checks a single column in the field values.

Parameters

\Drupal\Core\Entity\EntityInterface $entity: The entity to test.

string $field_name: The name of the field to test

array $expected_values: The array of expected values.

string $langcode: (Optional) The language code for the values. Defaults to \Drupal\Core\Language\LanguageInterface::LANGCODE_NOT_SPECIFIED.

string $column: (Optional) The name of the column to check. Defaults to 'value'.

File

core/modules/field/tests/src/Kernel/FieldKernelTestBase.php, line 200

Class

FieldKernelTestBase
Parent class for Field API unit tests.

Namespace

Drupal\Tests\field\Kernel

Code

protected function assertFieldValues(EntityInterface $entity, $field_name, $expected_values, $langcode = LanguageInterface::LANGCODE_NOT_SPECIFIED, $column = 'value') {
    $expected_values_count = count($expected_values);
    // Re-load the entity to make sure we have the latest changes.
    $storage = $this->container
        ->get('entity_type.manager')
        ->getStorage($entity->getEntityTypeId());
    $storage->resetCache([
        $entity->id(),
    ]);
    $e = $storage->load($this->entityId);
    $field = $values = $e->getTranslation($langcode)->{$field_name};
    // Filter out empty values so that they don't mess with the assertions.
    $field->filterEmptyItems();
    $values = $field->getValue();
    $this->assertCount($expected_values_count, $values, 'Expected number of values were saved.');
    foreach ($expected_values as $key => $value) {
        $this->assertEquals($value, $values[$key][$column], new FormattableMarkup('Value @value was saved correctly.', [
            '@value' => $value,
        ]));
    }
}

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