annotate core/modules/field/tests/src/Functional/FieldTestBase.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 7a779792577d
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Tests\field\Functional;
Chris@0 4
Chris@0 5 use Drupal\Core\Entity\EntityInterface;
Chris@0 6 use Drupal\Core\Language\LanguageInterface;
Chris@0 7 use Drupal\Tests\BrowserTestBase;
Chris@0 8
Chris@0 9 /**
Chris@0 10 * Parent class for Field API tests.
Chris@0 11 */
Chris@0 12 abstract class FieldTestBase extends BrowserTestBase {
Chris@0 13
Chris@0 14 /**
Chris@0 15 * Generate random values for a field_test field.
Chris@0 16 *
Chris@0 17 * @param $cardinality
Chris@0 18 * Number of values to generate.
Chris@0 19 * @return
Chris@0 20 * An array of random values, in the format expected for field values.
Chris@0 21 */
Chris@0 22 public function _generateTestFieldValues($cardinality) {
Chris@0 23 $values = [];
Chris@0 24 for ($i = 0; $i < $cardinality; $i++) {
Chris@0 25 // field_test fields treat 0 as 'empty value'.
Chris@0 26 $values[$i]['value'] = mt_rand(1, 127);
Chris@0 27 }
Chris@0 28 return $values;
Chris@0 29 }
Chris@0 30
Chris@0 31 /**
Chris@0 32 * Assert that a field has the expected values in an entity.
Chris@0 33 *
Chris@0 34 * This function only checks a single column in the field values.
Chris@0 35 *
Chris@12 36 * @param \Drupal\Core\Entity\EntityInterface $entity
Chris@0 37 * The entity to test.
Chris@0 38 * @param $field_name
Chris@0 39 * The name of the field to test
Chris@0 40 * @param $expected_values
Chris@0 41 * The array of expected values.
Chris@0 42 * @param $langcode
Chris@0 43 * (Optional) The language code for the values. Defaults to
Chris@0 44 * \Drupal\Core\Language\LanguageInterface::LANGCODE_DEFAULT.
Chris@0 45 * @param $column
Chris@0 46 * (Optional) The name of the column to check. Defaults to 'value'.
Chris@0 47 */
Chris@0 48 public function assertFieldValues(EntityInterface $entity, $field_name, $expected_values, $langcode = LanguageInterface::LANGCODE_DEFAULT, $column = 'value') {
Chris@0 49 // Re-load the entity to make sure we have the latest changes.
Chris@0 50 $storage = $this->container->get('entity_type.manager')
Chris@0 51 ->getStorage($entity->getEntityTypeId());
Chris@0 52 $storage->resetCache([$entity->id()]);
Chris@0 53 $e = $storage->load($entity->id());
Chris@0 54
Chris@0 55 $field = $values = $e->getTranslation($langcode)->$field_name;
Chris@0 56 // Filter out empty values so that they don't mess with the assertions.
Chris@0 57 $field->filterEmptyItems();
Chris@0 58 $values = $field->getValue();
Chris@0 59 $this->assertEqual(count($values), count($expected_values), 'Expected number of values were saved.');
Chris@0 60 foreach ($expected_values as $key => $value) {
Chris@0 61 $this->assertEqual($values[$key][$column], $value, format_string('Value @value was saved correctly.', ['@value' => $value]));
Chris@0 62 }
Chris@0 63 }
Chris@0 64
Chris@0 65 }