public function StringItem::storageSettingsForm in Drupal 10

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php \Drupal\Core\Field\Plugin\Field\FieldType\StringItem::storageSettingsForm()
2. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php \Drupal\Core\Field\Plugin\Field\FieldType\StringItem::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/lib/Drupal/Core/Field/Plugin/Field/FieldType/StringItem.php, line 82

Class

StringItem

Defines the 'string' entity field type.

Namespace

Drupal\Core\Field\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $element = [];
  $element['max_length'] = [
    '#type' => 'number',
    '#title' => t('Maximum length'),
    '#default_value' => $this
      ->getSetting('max_length'),
    '#required' => TRUE,
    '#description' => t('The maximum length of the field in characters.'),
    '#min' => 1,
    '#disabled' => $has_data,
  ];
  return $element;
}