class NumericFormatterBase

Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericFormatterBase.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\NumericFormatterBase
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericFormatterBase.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\NumericFormatterBase
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericFormatterBase.php \Drupal\Core\Field\Plugin\Field\FieldFormatter\NumericFormatterBase

Parent plugin for decimal and integer formatters.

Hierarchy

Expanded class hierarchy of NumericFormatterBase

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldFormatter/NumericFormatterBase.php, line 12

Namespace

Drupal\Core\Field\Plugin\Field\FieldFormatter
View source
abstract class NumericFormatterBase extends FormatterBase {
    
    /**
     * {@inheritdoc}
     */
    public function settingsForm(array $form, FormStateInterface $form_state) {
        $options = [
            '' => $this->t('- None -'),
            '.' => $this->t('Decimal point'),
            ',' => $this->t('Comma'),
            ' ' => $this->t('Space'),
            chr(8201) => $this->t('Thin space'),
            "'" => $this->t('Apostrophe'),
        ];
        $elements['thousand_separator'] = [
            '#type' => 'select',
            '#title' => $this->t('Thousand marker'),
            '#options' => $options,
            '#default_value' => $this->getSetting('thousand_separator'),
            '#weight' => 0,
        ];
        $elements['prefix_suffix'] = [
            '#type' => 'checkbox',
            '#title' => $this->t('Display prefix and suffix'),
            '#default_value' => $this->getSetting('prefix_suffix'),
            '#weight' => 10,
        ];
        return $elements;
    }
    
    /**
     * {@inheritdoc}
     */
    public function settingsSummary() {
        $summary = [];
        $summary[] = $this->numberFormat(1234.123456789);
        if ($this->getSetting('prefix_suffix')) {
            $summary[] = $this->t('Display with prefix and suffix.');
        }
        return $summary;
    }
    
    /**
     * {@inheritdoc}
     */
    public function viewElements(FieldItemListInterface $items, $langcode) {
        $elements = [];
        $settings = $this->getFieldSettings();
        foreach ($items as $delta => $item) {
            $output = $this->numberFormat($item->value);
            // Account for prefix and suffix.
            if ($this->getSetting('prefix_suffix')) {
                $prefixes = isset($settings['prefix']) ? array_map([
                    'Drupal\\Core\\Field\\FieldFilteredMarkup',
                    'create',
                ], explode('|', $settings['prefix'])) : [
                    '',
                ];
                $suffixes = isset($settings['suffix']) ? array_map([
                    'Drupal\\Core\\Field\\FieldFilteredMarkup',
                    'create',
                ], explode('|', $settings['suffix'])) : [
                    '',
                ];
                $prefix = count($prefixes) > 1 ? $this->formatPlural($item->value, $prefixes[0], $prefixes[1]) : $prefixes[0];
                $suffix = count($suffixes) > 1 ? $this->formatPlural($item->value, $suffixes[0], $suffixes[1]) : $suffixes[0];
                $output = $prefix . $output . $suffix;
            }
            // Output the raw value in a content attribute if the text of the HTML
            // element differs from the raw value (for example when a prefix is used).
            if (isset($item->_attributes) && $item->value != $output) {
                $item->_attributes += [
                    'content' => $item->value,
                ];
            }
            $elements[$delta] = [
                '#markup' => $output,
            ];
        }
        return $elements;
    }
    
    /**
     * Formats a number.
     *
     * @param mixed $number
     *   The numeric value.
     *
     * @return string
     *   The formatted number.
     */
    protected abstract function numberFormat($number);

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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 13
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. 13
NumericFormatterBase::numberFormat abstract protected function Formats a number. 2
NumericFormatterBase::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 1
NumericFormatterBase::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary
NumericFormatterBase::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsInterface::defaultSettings 43
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

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