You are here

Home » API reference » Tamper 8 » NumberFormat.php

class NumberFormat in Tamper 8

Plugin implementation for number format.

Plugin annotation


@Tamper(
  id = "number_format",
  label = @Translation("Format a number"),
  description = @Translation("Format a number."),
  category = "Number"
)

Hierarchy

Expanded class hierarchy of NumberFormat

1 file declares its use of NumberFormat
NumberFormatTest.php in tests/src/Unit/Plugin/Tamper/NumberFormatTest.php

File

src/Plugin/Tamper/NumberFormat.php, line 20

Namespace

Drupal\tamper\Plugin\Tamper
View source 
class NumberFormat extends TamperBase {
  const SETTING_DECIMALS = 'decimals';
  const SETTING_DEC_POINT = 'dec_point';
  const SETTING_THOUSANDS_SEP = 'thousands_sep';

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    $config = parent::defaultConfiguration();
    $config[self::SETTING_DECIMALS] = 0;
    $config[self::SETTING_DEC_POINT] = '.';
    $config[self::SETTING_THOUSANDS_SEP] = ',';
    return $config;
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form[self::SETTING_DECIMALS] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Decimals'),
      '#default_value' => $this
        ->getSetting(self::SETTING_DECIMALS),
      '#description' => $this
        ->t('The number of decimal places.'),
    ];
    $form[self::SETTING_DEC_POINT] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Decimal point'),
      '#default_value' => $this
        ->getSetting(self::SETTING_DEC_POINT),
      '#description' => $this
        ->t('The character to use as the decimal point.'),
    ];
    $form[self::SETTING_THOUSANDS_SEP] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Thousands separator'),
      '#default_value' => $this
        ->getSetting(self::SETTING_THOUSANDS_SEP),
      '#description' => $this
        ->t('The character to use as the thousands separator.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this
      ->setConfiguration([
      self::SETTING_DECIMALS => $form_state
        ->getValue(self::SETTING_DECIMALS),
      self::SETTING_DEC_POINT => $form_state
        ->getValue(self::SETTING_DEC_POINT),
      self::SETTING_THOUSANDS_SEP => $form_state
        ->getValue(self::SETTING_THOUSANDS_SEP),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function tamper($data, TamperableItemInterface $item = NULL) {
    if (!is_numeric($data)) {
      throw new TamperException('Input should be numeric.');
    }
    $decimals = $this
      ->getSetting(self::SETTING_DECIMALS);
    $dec_point = $this
      ->getSetting(self::SETTING_DEC_POINT);
    $thousands_sep = $this
      ->getSetting(self::SETTING_THOUSANDS_SEP);
    return number_format($data, $decimals, $dec_point, $thousands_sep);
  }

}

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
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
NumberFormat::buildConfigurationForm public function Form constructor. Overrides TamperBase::buildConfigurationForm
NumberFormat::defaultConfiguration public function Gets default configuration for this plugin. Overrides TamperBase::defaultConfiguration
NumberFormat::SETTING_DECIMALS constant
NumberFormat::SETTING_DEC_POINT constant
NumberFormat::SETTING_THOUSANDS_SEP constant
NumberFormat::submitConfigurationForm public function Form submission handler. Overrides TamperBase::submitConfigurationForm
NumberFormat::tamper public function Tamper data. Overrides TamperInterface::tamper
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.
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.
TamperBase::$sourceDefinition protected property The source definition.
TamperBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
TamperBase::getSetting public function Get a particular configuration value. Overrides TamperInterface::getSetting
TamperBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides TamperInterface::multiple 5
TamperBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
TamperBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 3
TamperBase::__construct public function Constructs a TamperBase object. Overrides PluginBase::__construct 1