public function TextTrimmedFormatter::settingsForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/text/src/Plugin/Field/FieldFormatter/TextTrimmedFormatter.php \Drupal\text\Plugin\Field\FieldFormatter\TextTrimmedFormatter::settingsForm()
2. 10 core/modules/text/src/Plugin/Field/FieldFormatter/TextTrimmedFormatter.php \Drupal\text\Plugin\Field\FieldFormatter\TextTrimmedFormatter::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

core/modules/text/src/Plugin/Field/FieldFormatter/TextTrimmedFormatter.php, line 45

Class

TextTrimmedFormatter

Plugin implementation of the 'text_trimmed' formatter.

Namespace

Drupal\text\Plugin\Field\FieldFormatter

Code

public function settingsForm(array $form, FormStateInterface $form_state) {
  $element['trim_length'] = [
    '#title' => t('Trimmed limit'),
    '#type' => 'number',
    '#field_suffix' => t('characters'),
    '#default_value' => $this
      ->getSetting('trim_length'),
    '#description' => t('If the summary is not set, the trimmed %label field will end at the last full sentence before this character limit.', [
      '%label' => $this->fieldDefinition
        ->getLabel(),
    ]),
    '#min' => 1,
    '#required' => TRUE,
  ];
  return $element;
}