You are here

public function RadioactivityEmitter::settingsForm in Radioactivity 8.3

Same name and namespace in other branches
  1. 4.0.x src/Plugin/Field/FieldFormatter/RadioactivityEmitter.php \Drupal\radioactivity\Plugin\Field\FieldFormatter\RadioactivityEmitter::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/RadioactivityEmitter.php, line 50

Class

RadioactivityEmitter
Plugin implementation of the 'radioactivity_emitter' formatter.

Namespace

Drupal\radioactivity\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  return [
    // Implement settings form.
    'energy' => [
      '#title' => $this
        ->t('Energy'),
      '#type' => 'textfield',
      '#required' => TRUE,
      '#description' => $this
        ->t('The amount of energy to emit when this field is displayed. Examples: 0.5, 10.'),
      '#pattern' => '[0-9]+(\\.[0-9]+)?',
      '#default_value' => $this
        ->getSetting('energy'),
    ],
    'display' => [
      '#title' => $this
        ->t('Display'),
      '#type' => 'select',
      '#options' => [
        'none' => $this
          ->t('Only emit'),
        'raw' => $this
          ->t('Energy level + emit'),
      ],
      '#default_value' => $this
        ->getSetting('display'),
    ],
  ] + parent::settingsForm($form, $form_state);
}