public function EntityClassFormatter::settingsForm in Entity Class Formatter 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/EntityClassFormatter.php, line 42

Class

EntityClassFormatter

Plugin implementation of the 'entity_class_formatter'.

Namespace

Drupal\entity_class_formatter\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $form = parent::settingsForm($form, $form_state);
  $form['prefix'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Prefix to be attached before each class'),
    '#default_value' => $this
      ->getSetting('prefix'),
  ];
  $form['suffix'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Suffix to be attached after each class'),
    '#default_value' => $this
      ->getSetting('suffix'),
  ];
  $form['attr'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Attribute name to be used instead of class'),
    '#description' => $this
      ->t('The field value will be escaped and assigned to the attribute you specify here (e.g. "data-value").'),
    '#default_value' => $this
      ->getSetting('attr'),
    '#required' => in_array($this->fieldDefinition
      ->getType(), [
      'decimal',
      'float',
      'integer',
    ]),
  ];
  return $form;
}