public function ListFormatter::settingsForm in Facebook Instant Articles 3.x

Same name and namespace in other branches

1. 8.2 src/Plugin/Field/FieldFormatter/ListFormatter.php \Drupal\fb_instant_articles\Plugin\Field\FieldFormatter\ListFormatter::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/ListFormatter.php, line 41

Class

ListFormatter

Plugin implementation of the 'fbia_list' formatter.

Namespace

Drupal\fb_instant_articles\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['is_ordered'] = [
    '#type' => 'checkbox',
    '#title' => $this
      ->t('Ordered list'),
    '#description' => $this
      ->t('Should this list be ordered or not?'),
    '#default_value' => $this
      ->getSetting('is_ordered'),
  ];
  return $element;
}