public function CshsFullHierarchyFormatter::settingsForm in Client-side Hierarchical Select 8

Same name and namespace in other branches

1. 8.3 src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php \Drupal\cshs\Plugin\Field\FieldFormatter\CshsFullHierarchyFormatter::settingsForm()
2. 8.2 src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php \Drupal\cshs\Plugin\Field\FieldFormatter\CshsFullHierarchyFormatter::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 CshsFormatterBase::settingsForm

File

src/Plugin/Field/FieldFormatter/CshsFullHierarchyFormatter.php, line 32

Class

CshsFullHierarchyFormatter

Plugin implementation of the "Full hierarchy" formatter.

Namespace

Drupal\cshs\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) : array {
  $element = parent::settingsForm($form, $form_state);
  $element['separator'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Separator'),
    '#description' => $this
      ->t('Specify a separator which will be placed in between the different hierarchy levels.'),
    '#default_value' => $this
      ->getSetting('separator'),
  ];
  return $element;
}