public function TimeZoneFieldFormatter::settingsForm in Time Zone Field 8

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/TimeZoneFieldFormatter.php, line 57

Class

TimeZoneFieldFormatter

Plugin implementation of the 'tzfield_date' formatter.

Namespace

Drupal\tzfield\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['format'] = [
    '#title' => $this
      ->t('Date format string'),
    '#description' => $this
      ->t('Enter a <a rel="noreferrer" href="https://www.php.net/manual/en/datetime.format.php#refsect1-datetime.format-parameters">PHP date format string</a>, e.g. <em>T</em> to display the current time zone abbreviation.'),
    '#type' => 'textfield',
    '#default_value' => $this
      ->getSetting('format'),
  ];
  return $form;
}