You are here

protected function GeneralUserReferenceFormatter::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 GeneralUserReferenceFormatter::getDescription()
GeneralUserReferenceFormatter::settingsForm in src/Plugin/Field/FieldFormatter/GeneralUserReferenceFormatter.php
Returns a form to configure settings for the formatter.

File

src/Plugin/Field/FieldFormatter/GeneralUserReferenceFormatter.php, line 372

Class

GeneralUserReferenceFormatter
Formats a user entity reference as one or more links.

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter

Code

protected function getDescription() {
  $isMultiple = $this->fieldDefinition
    ->getFieldStorageDefinition()
    ->isMultiple();
  if ($isMultiple === TRUE) {
    return $this
      ->t("Format field values as links that show the user's ID, account or display name, email address, and other options. Multiple field values are shown as a list on one line, bulleted, numbered, or in blocks.");
  }
  return $this
    ->t("Format a field as a link that shows the user's ID, account or display name, email address, and other options.");
}