public function TimeRangeFormatter::settingsForm in Time Field For Drupal 8.x / 9.x 8

Same name and namespace in other branches

1. 2.x src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php \Drupal\time_field\Plugin\Field\FieldFormatter\TimeRangeFormatter::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 FormatterBase::settingsForm

File

src/Plugin/Field/FieldFormatter/TimeRangeFormatter.php, line 61

Class

TimeRangeFormatter

Plugin implementation of the 'time_formatter' formatter.

Namespace

Drupal\time_field\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $elements = parent::settingsForm($form, $form_state);
  $elements['timerange_format'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Time Range Format'),
    '#default_value' => (string) $this
      ->getSetting('timerange_format'),
    '#description' => $this
      ->t('This setting must have `start` and `end` keys'),
  ];
  $elements['time_format'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Time Format'),
    '#default_value' => $this
      ->getSetting('time_format'),
    '#description' => $this
      ->getTimeDescription(),
  ];
  return $elements;
}