protected function GeneralNumberFormatter::getDescription in Formatter Suite 8

Returns a brief description of the formatter.

Return value

string Returns a brief translated description of the formatter.

1 call to GeneralNumberFormatter::getDescription()

GeneralNumberFormatter::settingsForm in src/Plugin/Field/FieldFormatter/GeneralNumberFormatter.php

Returns a form to configure settings for the formatter.

3 methods override GeneralNumberFormatter::getDescription()

GeneralNumberListFormatter::getDescription in src/Plugin/Field/FieldFormatter/GeneralNumberListFormatter.php

Returns a brief description of the formatter.

GeneralNumberWithBarIndicatorFormatter::getDescription in src/Plugin/Field/FieldFormatter/GeneralNumberWithBarIndicatorFormatter.php

Returns a brief description of the formatter.

GeneralNumberWithMinMaxFormatter::getDescription in src/Plugin/Field/FieldFormatter/GeneralNumberWithMinMaxFormatter.php

Returns a brief description of the formatter.

File

src/Plugin/Field/FieldFormatter/GeneralNumberFormatter.php, line 261

Class

GeneralNumberFormatter

Format a number field with a variety of notation styles and parameters.

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter

Code

protected function getDescription() {
  $isMultiple = $this->fieldDefinition
    ->getFieldStorageDefinition()
    ->isMultiple();
  if ($isMultiple === TRUE) {
    return $this
      ->t('Format numbers in a variety of notation styles. Multiple field values are shown as a list on one line, bulleted, numbered, or in blocks.');
  }
  return $this
    ->t('Format a number in a variety of notation styles.');
}