public function DateRangeCustomFormatter::settingsForm in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeCustomFormatter::settingsForm()
2. 9 core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php \Drupal\datetime_range\Plugin\Field\FieldFormatter\DateRangeCustomFormatter::settingsForm()

Returns a form to configure settings for the formatter.

Invoked from \Drupal\field_ui\Form\EntityDisplayFormBase to allow administrators to configure the formatter. The field_ui module takes care of handling submitted form values.

Parameters

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

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form elements for the formatter settings.

Overrides DateTimeCustomFormatter::settingsForm

File

core/modules/datetime_range/src/Plugin/Field/FieldFormatter/DateRangeCustomFormatter.php, line 73

Class

DateRangeCustomFormatter

Plugin implementation of the 'Custom' formatter for 'daterange' fields.

Namespace

Drupal\datetime_range\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['separator'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Date separator'),
    '#description' => $this
      ->t('The string to separate the start and end dates'),
    '#default_value' => $this
      ->getSetting('separator'),
  ];
  return $form;
}