public function CommentItem::storageSettingsForm in Drupal 10

Same name and namespace in other branches

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

Class

CommentItem

Plugin implementation of the 'comment' field type.

Namespace

Drupal\comment\Plugin\Field\FieldType

Code

public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
  $element = [];

  // @todo Inject entity storage once typed-data supports container injection.
  //   See https://www.drupal.org/node/2053415 for more details.
  $comment_types = CommentType::loadMultiple();
  $options = [];
  $entity_type = $this
    ->getEntity()
    ->getEntityTypeId();
  foreach ($comment_types as $comment_type) {
    if ($comment_type
      ->getTargetEntityTypeId() == $entity_type) {
      $options[$comment_type
        ->id()] = $comment_type
        ->label();
    }
  }
  $element['comment_type'] = [
    '#type' => 'select',
    '#title' => t('Comment type'),
    '#options' => $options,
    '#required' => TRUE,
    '#description' => $this
      ->t('Select the Comment type to use for this comment field. Manage the comment types from the <a href=":url">administration overview page</a>.', [
      ':url' => Url::fromRoute('entity.comment_type.collection')
        ->toString(),
    ]),
    '#default_value' => $this
      ->getSetting('comment_type'),
    '#disabled' => $has_data,
  ];
  return $element;
}