You are here

public function HMSFormatter::settingsForm in HMS 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/HMSFormatter.php, line 70
Contains \Drupal\hms_field\Plugin\Field\FieldFormatter\HMSFormatter.

Class

HMSFormatter
Plugin implementation of the 'hms_default_formatter' formatter.

Namespace

Drupal\hms_field\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $settings = $this
    ->getSettings();
  $elements['format'] = array(
    '#type' => 'select',
    '#title' => t('Display format'),
    '#options' => $this->hms_service
      ->format_options(),
    '#description' => t('The display format used for this field'),
    '#default_value' => $settings['format'],
    '#required' => TRUE,
  );
  $elements['leading_zero'] = array(
    '#type' => 'checkbox',
    '#title' => t('Leading zero'),
    '#description' => t('Leading zero values will be displayed when this option is checked'),
    '#default_value' => $settings['leading_zero'],
  );
  return $elements;
}