public function DateRangeAllDayCustomFormatter::settingsForm in Date all day 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 DateRangeCustomFormatter::settingsForm

File

src/Plugin/Field/FieldFormatter/DateRangeAllDayCustomFormatter.php, line 39

Class

DateRangeAllDayCustomFormatter

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

Namespace

Drupal\date_all_day\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['date_only_format'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Date only format'),
    '#description' => $this
      ->t('A date format excluding the time part. This is used when the "all day" option is active. See <a href="http://php.net/manual/function.date.php" target="_blank">the documentation for PHP date formats</a>.'),
    '#default_value' => $this
      ->getSetting('date_only_format'),
  ];
  return $form;
}