Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\field\Tests;
Chris@0: 
Chris@0: use Drupal\Component\Utility\Html;
Chris@0: use Drupal\Core\Entity\Entity\EntityFormDisplay;
Chris@0: use Drupal\Core\Field\FieldStorageDefinitionInterface;
Chris@0: use Drupal\Core\Form\FormState;
Chris@0: use Drupal\entity_test\Entity\EntityTest;
Chris@0: use Drupal\entity_test\Entity\EntityTestBaseFieldDisplay;
Chris@0: use Drupal\field\Entity\FieldConfig;
Chris@0: use Drupal\field\Entity\FieldStorageConfig;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests field form handling.
Chris@0:  *
Chris@0:  * @group field
Chris@0:  */
Chris@0: class FormTest extends FieldTestBase {
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to enable.
Chris@0:    *
Chris@0:    * Locale is installed so that TranslatableMarkup actually does something.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['node', 'field_test', 'options', 'entity_test', 'locale'];
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of values defining a field single.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldStorageSingle;
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of values defining a field multiple.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldStorageMultiple;
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of values defining a field with unlimited cardinality.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $fieldStorageUnlimited;
Chris@0: 
Chris@0:   /**
Chris@0:    * An array of values defining a field.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $field;
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     $web_user = $this->drupalCreateUser(['view test entity', 'administer entity_test content']);
Chris@0:     $this->drupalLogin($web_user);
Chris@0: 
Chris@0:     $this->fieldStorageSingle = [
Chris@0:       'field_name' => 'field_single',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'type' => 'test_field',
Chris@0:     ];
Chris@0:     $this->fieldStorageMultiple = [
Chris@0:       'field_name' => 'field_multiple',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'type' => 'test_field',
Chris@0:       'cardinality' => 4,
Chris@0:     ];
Chris@0:     $this->fieldStorageUnlimited = [
Chris@0:       'field_name' => 'field_unlimited',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'type' => 'test_field',
Chris@0:       'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
Chris@0:     ];
Chris@0: 
Chris@0:     $this->field = [
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'bundle' => 'entity_test',
Chris@0:       'label' => $this->randomMachineName() . '_label',
Chris@0:       'description' => '[site:name]_description',
Chris@0:       'weight' => mt_rand(0, 127),
Chris@0:       'settings' => [
Chris@0:         'test_field_setting' => $this->randomMachineName(),
Chris@0:       ],
Chris@0:     ];
Chris@0:   }
Chris@0: 
Chris@0:   public function testFieldFormSingle() {
Chris@0:     $field_storage = $this->fieldStorageSingle;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0: 
Chris@0:     // Create token value expected for description.
Chris@0:     $token_description = Html::escape($this->config('system.site')->get('name')) . '_description';
Chris@0:     $this->assertText($token_description, 'Token replacement for description is displayed');
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget is displayed');
Chris@0:     $this->assertNoField("{$field_name}[1][value]", 'No extraneous widget is displayed');
Chris@0: 
Chris@0:     // Check that hook_field_widget_form_alter() does not believe this is the
Chris@0:     // default value form.
Chris@0:     $this->assertNoText('From hook_field_widget_form_alter(): Default form is true.', 'Not default value form in hook_field_widget_form_alter().');
Chris@0: 
Chris@0:     // Submit with invalid value (field-level validation).
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => -1
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     $this->assertRaw(t('%name does not accept the value -1.', ['%name' => $this->field['label']]), 'Field validation fails with invalid input.');
Chris@0:     // TODO : check that the correct field is flagged for error.
Chris@0: 
Chris@0:     // Create an entity
Chris@0:     $value = mt_rand(1, 127);
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => $value,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match('|entity_test/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0:     $this->assertText(t('entity_test @id has been created.', ['@id' => $id]), 'Entity was created');
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, $value, 'Field value was saved');
Chris@0: 
Chris@0:     // Display edit form.
Chris@0:     $this->drupalGet('entity_test/manage/' . $id . '/edit');
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", $value, 'Widget is displayed with the correct default value');
Chris@0:     $this->assertNoField("{$field_name}[1][value]", 'No extraneous widget is displayed');
Chris@0: 
Chris@0:     // Update the entity.
Chris@0:     $value = mt_rand(1, 127);
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => $value,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     $this->assertText(t('entity_test @id has been updated.', ['@id' => $id]), 'Entity was updated');
Chris@0:     $this->container->get('entity.manager')->getStorage('entity_test')->resetCache([$id]);
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, $value, 'Field value was updated');
Chris@0: 
Chris@0:     // Empty the field.
Chris@0:     $value = '';
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => $value
Chris@0:     ];
Chris@0:     $this->drupalPostForm('entity_test/manage/' . $id . '/edit', $edit, t('Save'));
Chris@0:     $this->assertText(t('entity_test @id has been updated.', ['@id' => $id]), 'Entity was updated');
Chris@0:     $this->container->get('entity.manager')->getStorage('entity_test')->resetCache([$id]);
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertTrue($entity->{$field_name}->isEmpty(), 'Field was emptied');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests field widget default values on entity forms.
Chris@0:    */
Chris@0:   public function testFieldFormDefaultValue() {
Chris@0:     $field_storage = $this->fieldStorageSingle;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     $default = rand(1, 127);
Chris@0:     $this->field['default_value'] = [['value' => $default]];
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0:     // Test that the default value is displayed correctly.
Chris@0:     $this->assertFieldByXpath("//input[@name='{$field_name}[0][value]' and @value='$default']");
Chris@0: 
Chris@0:     // Try to submit an empty value.
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => '',
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match('|entity_test/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0:     $this->assertText(t('entity_test @id has been created.', ['@id' => $id]), 'Entity was created.');
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertTrue($entity->{$field_name}->isEmpty(), 'Field is now empty.');
Chris@0:   }
Chris@0: 
Chris@0:   public function testFieldFormSingleRequired() {
Chris@0:     $field_storage = $this->fieldStorageSingle;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     $this->field['required'] = TRUE;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Submit with missing required value.
Chris@0:     $edit = [];
Chris@0:     $this->drupalPostForm('entity_test/add', $edit, t('Save'));
Chris@0:     $this->assertRaw(t('@name field is required.', ['@name' => $this->field['label']]), 'Required field with no value fails validation');
Chris@0: 
Chris@0:     // Create an entity
Chris@0:     $value = mt_rand(1, 127);
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => $value,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match('|entity_test/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0:     $this->assertText(t('entity_test @id has been created.', ['@id' => $id]), 'Entity was created');
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, $value, 'Field value was saved');
Chris@0: 
Chris@0:     // Edit with missing required value.
Chris@0:     $value = '';
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => $value,
Chris@0:     ];
Chris@0:     $this->drupalPostForm('entity_test/manage/' . $id . '/edit', $edit, t('Save'));
Chris@0:     $this->assertRaw(t('@name field is required.', ['@name' => $this->field['label']]), 'Required field with no value fails validation');
Chris@0:   }
Chris@0: 
Chris@0:   public function testFieldFormUnlimited() {
Chris@0:     $field_storage = $this->fieldStorageUnlimited;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form -> 1 widget.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget 1 is displayed');
Chris@0:     $this->assertNoField("{$field_name}[1][value]", 'No extraneous widget is displayed');
Chris@0: 
Chris@0:     // Check if aria-describedby attribute is placed on multiple value widgets.
Chris@0:     $elements = $this->xpath('//table[@id="field-unlimited-values" and @aria-describedby="edit-field-unlimited--description"]');
Chris@0:     $this->assertTrue(isset($elements[0]), t('aria-describedby attribute is properly placed on multiple value widgets.'));
Chris@0: 
Chris@0:     // Press 'add more' button -> 2 widgets.
Chris@0:     $this->drupalPostForm(NULL, [], t('Add another item'));
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget 1 is displayed');
Chris@0:     $this->assertFieldByName("{$field_name}[1][value]", '', 'New widget is displayed');
Chris@0:     $this->assertNoField("{$field_name}[2][value]", 'No extraneous widget is displayed');
Chris@0:     // TODO : check that non-field inputs are preserved ('title'), etc.
Chris@0: 
Chris@0:     // Yet another time so that we can play with more values -> 3 widgets.
Chris@0:     $this->drupalPostForm(NULL, [], t('Add another item'));
Chris@0: 
Chris@0:     // Prepare values and weights.
Chris@0:     $count = 3;
Chris@0:     $delta_range = $count - 1;
Chris@0:     $values = $weights = $pattern = $expected_values = [];
Chris@0:     $edit = [];
Chris@0:     for ($delta = 0; $delta <= $delta_range; $delta++) {
Chris@0:       // Assign unique random values and weights.
Chris@0:       do {
Chris@0:         $value = mt_rand(1, 127);
Chris@0:       } while (in_array($value, $values));
Chris@0:       do {
Chris@0:         $weight = mt_rand(-$delta_range, $delta_range);
Chris@0:       } while (in_array($weight, $weights));
Chris@0:       $edit["{$field_name}[$delta][value]"] = $value;
Chris@0:       $edit["{$field_name}[$delta][_weight]"] = $weight;
Chris@0:       // We'll need three slightly different formats to check the values.
Chris@0:       $values[$delta] = $value;
Chris@0:       $weights[$delta] = $weight;
Chris@0:       $field_values[$weight]['value'] = (string) $value;
Chris@0:       $pattern[$weight] = "<input [^>]*value=\"$value\" [^>]*";
Chris@0:     }
Chris@0: 
Chris@0:     // Press 'add more' button -> 4 widgets
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Add another item'));
Chris@0:     for ($delta = 0; $delta <= $delta_range; $delta++) {
Chris@0:       $this->assertFieldByName("{$field_name}[$delta][value]", $values[$delta], "Widget $delta is displayed and has the right value");
Chris@0:       $this->assertFieldByName("{$field_name}[$delta][_weight]", $weights[$delta], "Widget $delta has the right weight");
Chris@0:     }
Chris@0:     ksort($pattern);
Chris@0:     $pattern = implode('.*', array_values($pattern));
Chris@0:     $this->assertPattern("|$pattern|s", 'Widgets are displayed in the correct order');
Chris@0:     $this->assertFieldByName("{$field_name}[$delta][value]", '', "New widget is displayed");
Chris@0:     $this->assertFieldByName("{$field_name}[$delta][_weight]", $delta, "New widget has the right weight");
Chris@0:     $this->assertNoField("{$field_name}[" . ($delta + 1) . '][value]', 'No extraneous widget is displayed');
Chris@0: 
Chris@0:     // Submit the form and create the entity.
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match('|entity_test/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0:     $this->assertText(t('entity_test @id has been created.', ['@id' => $id]), 'Entity was created');
Chris@0:     $entity = EntityTest::load($id);
Chris@0:     ksort($field_values);
Chris@0:     $field_values = array_values($field_values);
Chris@0:     $this->assertIdentical($entity->{$field_name}->getValue(), $field_values, 'Field values were saved in the correct order');
Chris@0: 
Chris@0:     // Display edit form: check that the expected number of widgets is
Chris@0:     // displayed, with correct values change values, reorder, leave an empty
Chris@0:     // value in the middle.
Chris@0:     // Submit: check that the entity is updated with correct values
Chris@0:     // Re-submit: check that the field can be emptied.
Chris@0: 
Chris@0:     // Test with several multiple fields in a form
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the position of the required label.
Chris@0:    */
Chris@0:   public function testFieldFormUnlimitedRequired() {
Chris@0:     $field_name = $this->fieldStorageUnlimited['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     $this->field['required'] = TRUE;
Chris@0:     FieldStorageConfig::create($this->fieldStorageUnlimited)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form -> 1 widget.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0:     // Check that the Required symbol is present for the multifield label.
Chris@0:     $element = $this->xpath('//h4[contains(@class, "label") and contains(@class, "js-form-required") and contains(text(), :value)]', [':value' => $this->field['label']]);
Chris@0:     $this->assertTrue(isset($element[0]), 'Required symbol added field label.');
Chris@0:     // Check that the label of the field input is visually hidden and contains
Chris@0:     // the field title and an indication of the delta for a11y.
Chris@0:     $element = $this->xpath('//label[@for=:for and contains(@class, "visually-hidden") and contains(text(), :value)]', [':for' => 'edit-field-unlimited-0-value', ':value' => $this->field['label'] . ' (value 1)']);
Chris@0:     $this->assertTrue(isset($element[0]), 'Required symbol not added for field input.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests widget handling of multiple required radios.
Chris@0:    */
Chris@0:   public function testFieldFormMultivalueWithRequiredRadio() {
Chris@0:     // Create a multivalue test field.
Chris@0:     $field_storage = $this->fieldStorageUnlimited;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Add a required radio field.
Chris@0:     FieldStorageConfig::create([
Chris@0:       'field_name' => 'required_radio_test',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'type' => 'list_string',
Chris@0:       'settings' => [
Chris@0:         'allowed_values' => ['yes' => 'yes', 'no' => 'no'],
Chris@0:       ],
Chris@0:     ])->save();
Chris@0:     $field = [
Chris@0:       'field_name' => 'required_radio_test',
Chris@0:       'entity_type' => 'entity_test',
Chris@0:       'bundle' => 'entity_test',
Chris@0:       'required' => TRUE,
Chris@0:     ];
Chris@0:     FieldConfig::create($field)->save();
Chris@0:     entity_get_form_display($field['entity_type'], $field['bundle'], 'default')
Chris@0:       ->setComponent($field['field_name'], [
Chris@0:         'type' => 'options_buttons',
Chris@0:       ])
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0: 
Chris@0:     // Press the 'Add more' button.
Chris@0:     $this->drupalPostForm(NULL, [], t('Add another item'));
Chris@0: 
Chris@0:     // Verify that no error is thrown by the radio element.
Chris@0:     $this->assertNoFieldByXpath('//div[contains(@class, "error")]', FALSE, 'No error message is displayed.');
Chris@0: 
Chris@0:     // Verify that the widget is added.
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget 1 is displayed');
Chris@0:     $this->assertFieldByName("{$field_name}[1][value]", '', 'New widget is displayed');
Chris@0:     $this->assertNoField("{$field_name}[2][value]", 'No extraneous widget is displayed');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests widgets handling multiple values.
Chris@0:    */
Chris@0:   public function testFieldFormMultipleWidget() {
Chris@0:     // Create a field with fixed cardinality, configure the form to use a
Chris@0:     // "multiple" widget.
Chris@0:     $field_storage = $this->fieldStorageMultiple;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($this->field)->save();
Chris@0:     entity_get_form_display($this->field['entity_type'], $this->field['bundle'], 'default')
Chris@0:       ->setComponent($field_name, [
Chris@0:         'type' => 'test_field_widget_multiple',
Chris@0:       ])
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display creation form.
Chris@0:     $this->drupalGet('entity_test/add');
Chris@0:     $this->assertFieldByName($field_name, '', 'Widget is displayed.');
Chris@0: 
Chris@0:     // Create entity with three values.
Chris@0:     $edit = [
Chris@0:       $field_name => '1, 2, 3',
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match('|entity_test/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0: 
Chris@0:     // Check that the values were saved.
Chris@0:     $entity_init = EntityTest::load($id);
Chris@0:     $this->assertFieldValues($entity_init, $field_name, [1, 2, 3]);
Chris@0: 
Chris@0:     // Display the form, check that the values are correctly filled in.
Chris@0:     $this->drupalGet('entity_test/manage/' . $id . '/edit');
Chris@0:     $this->assertFieldByName($field_name, '1, 2, 3', 'Widget is displayed.');
Chris@0: 
Chris@0:     // Submit the form with more values than the field accepts.
Chris@0:     $edit = [$field_name => '1, 2, 3, 4, 5'];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     $this->assertRaw('this field cannot hold more than 4 values', 'Form validation failed.');
Chris@0:     // Check that the field values were not submitted.
Chris@0:     $this->assertFieldValues($entity_init, $field_name, [1, 2, 3]);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests fields with no 'edit' access.
Chris@0:    */
Chris@0:   public function testFieldFormAccess() {
Chris@0:     $entity_type = 'entity_test_rev';
Chris@0:     // Create a "regular" field.
Chris@0:     $field_storage = $this->fieldStorageSingle;
Chris@0:     $field_storage['entity_type'] = $entity_type;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $field = $this->field;
Chris@0:     $field['field_name'] = $field_name;
Chris@0:     $field['entity_type'] = $entity_type;
Chris@0:     $field['bundle'] = $entity_type;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     FieldConfig::create($field)->save();
Chris@0:     entity_get_form_display($entity_type, $entity_type, 'default')
Chris@0:       ->setComponent($field_name)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Create a field with no edit access. See
Chris@0:     // field_test_entity_field_access().
Chris@0:     $field_storage_no_access = [
Chris@0:       'field_name' => 'field_no_edit_access',
Chris@0:       'entity_type' => $entity_type,
Chris@0:       'type' => 'test_field',
Chris@0:     ];
Chris@0:     $field_name_no_access = $field_storage_no_access['field_name'];
Chris@0:     $field_no_access = [
Chris@0:       'field_name' => $field_name_no_access,
Chris@0:       'entity_type' => $entity_type,
Chris@0:       'bundle' => $entity_type,
Chris@0:       'default_value' => [0 => ['value' => 99]],
Chris@0:     ];
Chris@0:     FieldStorageConfig::create($field_storage_no_access)->save();
Chris@0:     FieldConfig::create($field_no_access)->save();
Chris@0:     entity_get_form_display($field_no_access['entity_type'], $field_no_access['bundle'], 'default')
Chris@0:       ->setComponent($field_name_no_access)
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Test that the form structure includes full information for each delta
Chris@0:     // apart from #access.
Chris@0:     $entity = $this->container->get('entity_type.manager')
Chris@0:       ->getStorage($entity_type)
Chris@0:       ->create(['id' => 0, 'revision_id' => 0]);
Chris@0: 
Chris@0:     $display = entity_get_form_display($entity_type, $entity_type, 'default');
Chris@0:     $form = [];
Chris@0:     $form_state = new FormState();
Chris@0:     $display->buildForm($entity, $form, $form_state);
Chris@0: 
Chris@0:     $this->assertFalse($form[$field_name_no_access]['#access'], 'Field #access is FALSE for the field without edit access.');
Chris@0: 
Chris@0:     // Display creation form.
Chris@0:     $this->drupalGet($entity_type . '/add');
Chris@0:     $this->assertNoFieldByName("{$field_name_no_access}[0][value]", '', 'Widget is not displayed if field access is denied.');
Chris@0: 
Chris@0:     // Create entity.
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => 1,
Chris@0:     ];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     preg_match("|$entity_type/manage/(\d+)|", $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0: 
Chris@0:     // Check that the default value was saved.
Chris@0:     $storage = $this->container->get('entity_type.manager')
Chris@0:       ->getStorage($entity_type);
Chris@0:     $entity = $storage->load($id);
Chris@0:     $this->assertEqual($entity->$field_name_no_access->value, 99, 'Default value was saved for the field with no edit access.');
Chris@0:     $this->assertEqual($entity->$field_name->value, 1, 'Entered value vas saved for the field with edit access.');
Chris@0: 
Chris@0:     // Create a new revision.
Chris@0:     $edit = [
Chris@0:       "{$field_name}[0][value]" => 2,
Chris@0:       'revision' => TRUE,
Chris@0:     ];
Chris@0:     $this->drupalPostForm($entity_type . '/manage/' . $id . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Check that the new revision has the expected values.
Chris@0:     $storage->resetCache([$id]);
Chris@0:     $entity = $storage->load($id);
Chris@0:     $this->assertEqual($entity->$field_name_no_access->value, 99, 'New revision has the expected value for the field with no edit access.');
Chris@0:     $this->assertEqual($entity->$field_name->value, 2, 'New revision has the expected value for the field with edit access.');
Chris@0: 
Chris@0:     // Check that the revision is also saved in the revisions table.
Chris@0:     $entity = $this->container->get('entity_type.manager')
Chris@0:       ->getStorage($entity_type)
Chris@0:       ->loadRevision($entity->getRevisionId());
Chris@0:     $this->assertEqual($entity->$field_name_no_access->value, 99, 'New revision has the expected value for the field with no edit access.');
Chris@0:     $this->assertEqual($entity->$field_name->value, 2, 'New revision has the expected value for the field with edit access.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests hiding a field in a form.
Chris@0:    */
Chris@0:   public function testHiddenField() {
Chris@0:     $entity_type = 'entity_test_rev';
Chris@0:     $field_storage = $this->fieldStorageSingle;
Chris@0:     $field_storage['entity_type'] = $entity_type;
Chris@0:     $field_name = $field_storage['field_name'];
Chris@0:     $this->field['field_name'] = $field_name;
Chris@0:     $this->field['default_value'] = [0 => ['value' => 99]];
Chris@0:     $this->field['entity_type'] = $entity_type;
Chris@0:     $this->field['bundle'] = $entity_type;
Chris@0:     FieldStorageConfig::create($field_storage)->save();
Chris@0:     $this->field = FieldConfig::create($this->field);
Chris@0:     $this->field->save();
Chris@0:     // We explicitly do not assign a widget in a form display, so the field
Chris@0:     // stays hidden in forms.
Chris@0: 
Chris@0:     // Display the entity creation form.
Chris@0:     $this->drupalGet($entity_type . '/add');
Chris@0: 
Chris@0:     // Create an entity and test that the default value is assigned correctly to
Chris@0:     // the field that uses the hidden widget.
Chris@0:     $this->assertNoField("{$field_name}[0][value]", 'The field does not appear in the form');
Chris@0:     $this->drupalPostForm(NULL, [], t('Save'));
Chris@0:     preg_match('|' . $entity_type . '/manage/(\d+)|', $this->url, $match);
Chris@0:     $id = $match[1];
Chris@0:     $this->assertText(t('entity_test_rev @id has been created.', ['@id' => $id]), 'Entity was created');
Chris@0:     $storage = $this->container->get('entity_type.manager')
Chris@0:       ->getStorage($entity_type);
Chris@0: 
Chris@0:     $entity = $storage->load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, 99, 'Default value was saved');
Chris@0: 
Chris@0:     // Update the field to remove the default value, and switch to the default
Chris@0:     // widget.
Chris@0:     $this->field->setDefaultValue([]);
Chris@0:     $this->field->save();
Chris@0:     entity_get_form_display($entity_type, $this->field->getTargetBundle(), 'default')
Chris@0:       ->setComponent($this->field->getName(), [
Chris@0:         'type' => 'test_field_widget',
Chris@0:       ])
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Display edit form.
Chris@0:     $this->drupalGet($entity_type . '/manage/' . $id . '/edit');
Chris@0:     $this->assertFieldByName("{$field_name}[0][value]", 99, 'Widget is displayed with the correct default value');
Chris@0: 
Chris@0:     // Update the entity.
Chris@0:     $value = mt_rand(1, 127);
Chris@0:     $edit = ["{$field_name}[0][value]" => $value];
Chris@0:     $this->drupalPostForm(NULL, $edit, t('Save'));
Chris@0:     $this->assertText(t('entity_test_rev @id has been updated.', ['@id' => $id]), 'Entity was updated');
Chris@0:     $storage->resetCache([$id]);
Chris@0:     $entity = $storage->load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, $value, 'Field value was updated');
Chris@0: 
Chris@0:     // Set the field back to hidden.
Chris@0:     entity_get_form_display($entity_type, $this->field->getTargetBundle(), 'default')
Chris@0:       ->removeComponent($this->field->getName())
Chris@0:       ->save();
Chris@0: 
Chris@0:     // Create a new revision.
Chris@0:     $edit = ['revision' => TRUE];
Chris@0:     $this->drupalPostForm($entity_type . '/manage/' . $id . '/edit', $edit, t('Save'));
Chris@0: 
Chris@0:     // Check that the expected value has been carried over to the new revision.
Chris@0:     $storage->resetCache([$id]);
Chris@0:     $entity = $storage->load($id);
Chris@0:     $this->assertEqual($entity->{$field_name}->value, $value, 'New revision has the expected value for the field with the Hidden widget');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests the form display of the label for multi-value fields.
Chris@0:    */
Chris@0:   public function testLabelOnMultiValueFields() {
Chris@0:     $user = $this->drupalCreateUser(['administer entity_test content']);
Chris@0:     $this->drupalLogin($user);
Chris@0: 
Chris@0:     FieldStorageConfig::create([
Chris@0:       'entity_type' => 'entity_test_base_field_display',
Chris@0:       'field_name' => 'foo',
Chris@0:       'type' => 'text',
Chris@0:       'cardinality' => FieldStorageConfig::CARDINALITY_UNLIMITED,
Chris@0:     ])->save();
Chris@0:     FieldConfig::create([
Chris@0:       'entity_type' => 'entity_test_base_field_display',
Chris@0:       'bundle' => 'bar',
Chris@0:       'field_name' => 'foo',
Chris@0:       // Set a dangerous label to test XSS filtering.
Chris@0:       'label' => "<script>alert('a configurable field');</script>",
Chris@0:     ])->save();
Chris@0:     EntityFormDisplay::create([
Chris@0:       'targetEntityType' => 'entity_test_base_field_display',
Chris@0:       'bundle' => 'bar',
Chris@0:       'mode' => 'default',
Chris@0:     ])->setComponent('foo', ['type' => 'text_textfield'])->enable()->save();
Chris@0: 
Chris@0:     $entity = EntityTestBaseFieldDisplay::create(['type' => 'bar']);
Chris@0:     $entity->save();
Chris@0: 
Chris@0:     $this->drupalGet('entity_test_base_field_display/manage/' . $entity->id());
Chris@0:     $this->assertResponse(200);
Chris@0:     $this->assertText('A field with multiple values');
Chris@0:     // Test if labels were XSS filtered.
Chris@0:     $this->assertEscaped("<script>alert('a configurable field');</script>");
Chris@0:   }
Chris@0: 
Chris@0: }