public function ListItemBase::storageSettingsForm in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/options/src/Plugin/Field/FieldType/ListItemBase.php \Drupal\options\Plugin\Field\FieldType\ListItemBase::storageSettingsForm()
2. 9 core/modules/options/src/Plugin/Field/FieldType/ListItemBase.php \Drupal\options\Plugin\Field\FieldType\ListItemBase::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/options/src/Plugin/Field/FieldType/ListItemBase.php, line 81

Class

ListItemBase

Plugin base class inherited by the options field types.

Namespace

Drupal\options\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $allowed_values = $this
    ->getSetting('allowed_values');
  $allowed_values_function = $this
    ->getSetting('allowed_values_function');
  $element['allowed_values'] = [
    '#type' => 'textarea',
    '#title' => t('Allowed values list'),
    '#default_value' => $this
      ->allowedValuesString($allowed_values),
    '#rows' => 10,
    '#access' => empty($allowed_values_function),
    '#element_validate' => [
      [
        static::class,
        'validateAllowedValues',
      ],
    ],
    '#field_has_data' => $has_data,
    '#field_name' => $this
      ->getFieldDefinition()
      ->getName(),
    '#entity_type' => $this
      ->getEntity()
      ->getEntityTypeId(),
    '#allowed_values' => $allowed_values,
  ];
  $element['allowed_values']['#description'] = $this
    ->allowedValuesDescription();
  $element['allowed_values_function'] = [
    '#type' => 'item',
    '#title' => t('Allowed values list'),
    '#markup' => t('The value of this field is being determined by the %function function and may not be changed.', [
      '%function' => $allowed_values_function,
    ]),
    '#access' => !empty($allowed_values_function),
    '#value' => $allowed_values_function,
  ];
  return $element;
}