DecimalFormatter.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/DecimalFormatter.php
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/DecimalFormatter.php
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/DecimalFormatter.php

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/DecimalFormatter.php

View source
<?php

namespace Drupal\Core\Field\Plugin\Field\FieldFormatter;

use Drupal\Core\Form\FormStateInterface;

/**
 * Plugin implementation of the 'number_decimal' formatter.
 *
 * The 'Default' formatter is different for integer fields on the one hand, and
 * for decimal and float fields on the other hand, in order to be able to use
 * different settings.
 *
 * @FieldFormatter(
 *   id = "number_decimal",
 *   label = @Translation("Default"),
 *   field_types = {
 *     "decimal",
 *     "float"
 *   }
 * )
 */
class DecimalFormatter extends NumericFormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultSettings() {
        return [
            'thousand_separator' => '',
            'decimal_separator' => '.',
            'scale' => 2,
            'prefix_suffix' => TRUE,
        ] + parent::defaultSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $elements = parent::settingsForm($form, $form_state);
        $elements['decimal_separator'] = [
            '#type' => 'select',
            '#title' => $this->t('Decimal marker'),
            '#options' => [
                '.' => $this->t('Decimal point'),
                ',' => $this->t('Comma'),
            ],
            '#default_value' => $this->getSetting('decimal_separator'),
            '#weight' => 5,
        ];
        $elements['scale'] = [
            '#type' => 'number',
            '#title' => $this->t('Scale', [], [
                'context' => 'decimal places',
            ]),
            '#min' => 0,
            '#max' => 10,
            '#default_value' => $this->getSetting('scale'),
            '#description' => $this->t('The number of digits to the right of the decimal.'),
            '#weight' => 6,
        ];
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function numberFormat($number) {
        return number_format($number, $this->getSetting('scale'), $this->getSetting('decimal_separator'), $this->getSetting('thousand_separator'));
    }

}

Classes

Title Deprecated Summary
DecimalFormatter Plugin implementation of the 'number_decimal' formatter.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.