You are here

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

File

src/Plugin/Field/FieldFormatter/NumberWithBytesFormatter.php, line 114

Class

NumberWithBytesFormatter
Formats numbers with a byte suffix, like "bytes", "KB", or "MB".

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter

Code

protected function getDescription() {
  return $this
    ->t("Formats a number as a quantity of bytes, simplifying the number and appending the appropriate suffix. Quantities can be reported in international standard <em>Kilobytes</em> (1000 bytes = 1 KB) or legacy <em>Kibibytes</em> (1024 bytes = 1 KiB).");
}