You are here

Home » API reference » Formatter Suite 8 » NumberWithBytesFormatter.php

class NumberWithBytesFormatter in Formatter Suite 8

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

Plugin annotation


@FieldFormatter(
  id          = "formatter_suite_number_with_bytes",
  label       = @Translation("Formatter Suite - Bytes with KB/MB/GB suffix"),
  weight      = 900,
  field_types = {
    "integer",
    "decimal",
    "float",
  }
)

Hierarchy

Expanded class hierarchy of NumberWithBytesFormatter

Related topics

Formatter Suite
@file Implements the principal entry points and hooks for the module.

File

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

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter
View source 
class NumberWithBytesFormatter extends FormatterBase {

  /*---------------------------------------------------------------------
   *
   * Configuration.
   *
   *---------------------------------------------------------------------*/

  /**
   * Returns an array of "k" units.
   *
   * @return string[]
   *   Returns an associative array with internal names as keys and
   *   human-readable translated names as values.
   */
  protected static function getKiloUnits() {
    return [
      1000 => t('Kilobytes, Megabytes, Gigabytes, etc.'),
      1024 => t('Kibibytes, Mibibytes, Gibibytes, etc.'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return array_merge([
      'kunit' => 1000,
      'fullWord' => FALSE,
      'decimalDigits' => 2,
    ], parent::defaultSettings());
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $this
      ->sanitizeSettings();
    $summary = [];
    $summary[] = $this
      ->t('Sample: @value', [
      '@value' => Utilities::formatBytes(1289748, $this
        ->getSetting('kunit'), $this
        ->getSetting('fullWord'), $this
        ->getSetting('decimalDigits')),
    ]);
    switch ($this
      ->getSetting('kunit')) {
      default:
      case 1000:
        if ($this
          ->getSetting('fullWord') === FALSE) {
          $summary[] = $this
            ->t('KB, MB, GB, etc.');
        }
        else {
          $summary[] = $this
            ->t('Kilobyte, Megabyte, Gigabyte, etc.');
        }
        break;
      case 1024:
        if ($this
          ->getSetting('fullWord') === FALSE) {
          $summary[] = $this
            ->t('KiB, MiB, GiB, etc.');
        }
        else {
          $summary[] = $this
            ->t('Kibibyte, Mebibyte, Gibibyte, etc.');
        }
        break;
    }
    return $summary;
  }

  /*---------------------------------------------------------------------
   *
   * Settings form.
   *
   *---------------------------------------------------------------------*/

  /**
   * Returns a brief description of the formatter.
   *
   * @return string
   *   Returns a brief translated description of the formatter.
   */
  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).");
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $formState) {

    // Get the parent's form.
    $elements = parent::settingsForm($form, $formState);

    // Add branding.
    $elements = Branding::addFieldFormatterBranding($elements);
    $elements['#attached']['library'][] = 'formatter_suite/formatter_suite.fieldformatter';

    // Add description.
    //
    // Use a large negative weight to insure it comes first.
    $elements['description'] = [
      '#type' => 'html_tag',
      '#tag' => 'div',
      '#value' => $this
        ->getDescription(),
      '#weight' => -1000,
      '#attributes' => [
        'class' => [
          'formatter_suite-settings-description',
        ],
      ],
    ];
    $weight = 0;

    // Prompt for each setting.
    $elements['kunit'] = [
      '#title' => $this
        ->t('Bytes units'),
      '#type' => 'select',
      '#options' => $this
        ->getKiloUnits(),
      '#default_value' => $this
        ->getSetting('kunit'),
      '#weight' => $weight++,
      '#wrapper_attributes' => [
        'class' => [
          'formatter_suite-number-with-bytes-kunit',
        ],
      ],
    ];
    $elements['fullWord'] = [
      '#title' => $this
        ->t('Use full words, not abbreviations (e.g. "Kilobyte" vs. "KB")'),
      '#type' => 'checkbox',
      '#default_value' => $this
        ->getSetting('fullWord'),
      '#weight' => $weight++,
      '#wrapper_attributes' => [
        'class' => [
          'formatter_suite-number-with-bytes-full-word',
        ],
      ],
    ];
    $elements['decimalDigits'] = [
      '#title' => $this
        ->t('Decimal digits'),
      '#type' => 'number',
      '#min' => 0,
      '#max' => 3,
      '#default_value' => $this
        ->getSetting('decimalDigits'),
      '#weight' => $weight++,
      '#wrapper_attributes' => [
        'class' => [
          'formatter_suite-number-with-bytes-decimal-digits',
        ],
      ],
    ];
    return $elements;
  }

  /**
   * Sanitize settings to insure that they are safe and valid.
   *
   * @internal
   * Drupal's class hierarchy for plugins and their settings does not
   * include a 'validate' function, like that for other classes with forms.
   * Validation must therefore occur on use, rather than on form submission.
   * @endinternal
   */
  protected function sanitizeSettings() {

    // Get settings.
    $kunit = $this
      ->getSetting('kunit');
    $fullWord = $this
      ->getSetting('fullWord');
    $decimalDigits = $this
      ->getSetting('decimalDigits');
    $defaults = $this
      ->defaultSettings();

    // Sanitize & validate.
    $kunits = $this
      ->getKiloUnits();
    if (empty($kunit) === TRUE || isset($kunits[$kunit]) === FALSE) {
      $kunit = $defaults['kunit'];
      $this
        ->setSetting('kunit', $kunit);
    }
    $fullWord = boolval($fullWord);
    $this
      ->setSetting('fullWord', $fullWord);
    $decimalDigits = intval($decimalDigits);
    if ($decimalDigits < 0) {
      $decimalDigits = 0;
    }
    elseif ($decimalDigits > 3) {
      $decimalDigits = 3;
    }
    $this
      ->setSetting('decimalDigits', $decimalDigits);
  }

  /*---------------------------------------------------------------------
   *
   * View.
   *
   *---------------------------------------------------------------------*/

  /**
   * {@inheritdoc}
   */
  public function viewElements(FieldItemListInterface $items, $langcode) {
    if ($items
      ->isEmpty() === TRUE) {
      return [];
    }
    $this
      ->sanitizeSettings();
    $elements = [];
    foreach ($items as $delta => $item) {
      $elements[$delta] = [
        '#markup' => Utilities::formatBytes($item->value, $this
          ->getSetting('kunit'), $this
          ->getSetting('fullWord'), $this
          ->getSetting('decimalDigits')),
      ];
    }
    return $elements;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormatterBase::$fieldDefinition protected property The field definition.
FormatterBase::$label protected property The label display setting.
FormatterBase::$settings protected property The formatter settings. Overrides PluginSettingsBase::$settings
FormatterBase::$viewMode protected property The view mode.
FormatterBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 11
FormatterBase::getFieldSetting protected function Returns the value of a field setting.
FormatterBase::getFieldSettings protected function Returns the array of field settings.
FormatterBase::isApplicable public static function Returns if the formatter can be used for the provided field. Overrides FormatterInterface::isApplicable 14
FormatterBase::prepareView public function Allows formatters to load information for field values being displayed. Overrides FormatterInterface::prepareView 2
FormatterBase::view public function Builds a renderable array for a fully themed field. Overrides FormatterInterface::view 1
FormatterBase::__construct public function Constructs a FormatterBase object. Overrides PluginBase::__construct 11
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
NumberWithBytesFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
NumberWithBytesFormatter::getDescription protected function Returns a brief description of the formatter.
NumberWithBytesFormatter::getKiloUnits protected static function Returns an array of "k" units.
NumberWithBytesFormatter::sanitizeSettings protected function Sanitize settings to insure that they are safe and valid.
NumberWithBytesFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm
NumberWithBytesFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
NumberWithBytesFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::$thirdPartySettings protected property The plugin settings injected by third party modules.
PluginSettingsBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 6
PluginSettingsBase::getSetting public function Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
PluginSettingsBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
PluginSettingsBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::onDependencyRemoval public function Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface::onDependencyRemoval 3
PluginSettingsBase::setSetting public function Sets the value of a setting for the plugin. Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Sets the settings for the plugin. Overrides PluginSettingsInterface::setSettings
PluginSettingsBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
PluginSettingsBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.