public function StatesListFormatter::settingsForm in Workflows Field 2.x

Same name and namespace in other branches

1. 8 src/Plugin/Field/FieldFormatter/StatesListFormatter.php \Drupal\workflows_field\Plugin\Field\FieldFormatter\StatesListFormatter::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/StatesListFormatter.php, line 106

Class

StatesListFormatter

Plugin implementation of the 'workflows_field_state_list' formatter.

Namespace

Drupal\workflows_field\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $elements = parent::settingsForm($form, $form_state);
  $elements['excluded_states'] = [
    '#type' => 'checkboxes',
    '#title' => $this
      ->t('Excluded states'),
    '#options' => array_map(function (StateInterface $state) {
      return $state
        ->label();
    }, $this
      ->getStatesFromWorkflow()),
    '#default_value' => $this
      ->getSetting('excluded_states'),
  ];
  return $elements;
}