public function TestItem::storageSettingsForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php \Drupal\field_test\Plugin\Field\FieldType\TestItem::storageSettingsForm()

Returns a form for the storage-level settings.

Invoked from \Drupal\field_ui\Form\FieldStorageConfigEditForm to allow administrators to configure storage-level settings.

Field storage might reject settings changes that affect the field storage schema if the storage already has data. When the $has_data parameter is TRUE, the form should not allow changing the settings that take part in the schema() method. It is recommended to set #access to FALSE on the corresponding elements.

Parameters

array $form: The form where the settings form is being included in.

\Drupal\Core\Form\FormStateInterface $form_state: The form state of the (entire) configuration form.

bool $has_data: TRUE if the field already has data, FALSE if not.

Return value

array The form definition for the field settings.

Overrides FieldItemBase::storageSettingsForm

File

core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldType/TestItem.php, line 76

Class

TestItem

Defines the 'test_field' entity field item.

Namespace

Drupal\field_test\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $form['test_field_storage_setting'] = [
    '#type' => 'textfield',
    '#title' => t('Field test field storage setting'),
    '#default_value' => $this
      ->getSetting('test_field_storage_setting'),
    '#required' => FALSE,
    '#description' => t('A dummy form element to simulate field storage setting.'),
  ];
  return $form;
}