You are here

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

class GeneralNumberListFormatter in Formatter Suite 8

Formats multiple numbers as a list.

Plugin annotation


@FieldFormatter(
  id          = "formatter_suite_general_number_list",
  label       = @Translation("Formatter Suite (deprecated) - General number list"),
  weight      = 10000,
  field_types = {
    "decimal",
    "float",
    "integer",
  }
)

Hierarchy

Expanded class hierarchy of GeneralNumberListFormatter

Deprecated

in formatter_suite:8.x-1.2 and is removed from formatter_suite:8.x-1.4. Use GeneralNumberFormatter instead.

Related topics

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

File

src/Plugin/Field/FieldFormatter/GeneralNumberListFormatter.php, line 24

Namespace

Drupal\formatter_suite\Plugin\Field\FieldFormatter
View source 
class GeneralNumberListFormatter extends GeneralNumberFormatter {

  /**
   * Returns a brief description of the formatter.
   *
   * @return string
   *   Returns a brief translated description of the formatter.
   */
  protected function getDescription() {
    return $this
      ->t('<span class="formatter_suite-deprecated">Deprecated. Please switch to "General number", which has all of the same features. This formatter will be deleted in a future release.</span>');
  }

}

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
GeneralNumberFormatter::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings 2
GeneralNumberFormatter::getDecimalSeparators protected static function Returns an array of decimal separators.
GeneralNumberFormatter::getExponentStyles protected static function Returns an array of scientific notation exponent styles.
GeneralNumberFormatter::getFieldPrefixes protected function Returns the array of field prefixes, if any.
GeneralNumberFormatter::getFieldSuffixes protected function Returns the array of field suffixes, if any.
GeneralNumberFormatter::getListStyles protected static function Returns an array of list styles.
GeneralNumberFormatter::getNegativeStyles protected static function Returns an array of negative styles.
GeneralNumberFormatter::getNotationStyles protected static function Returns an array of notation styles.
GeneralNumberFormatter::getPositiveStyles protected static function Returns an array of positive styles.
GeneralNumberFormatter::getThousandsSeparators protected static function Returns an array of thousands separators.
GeneralNumberFormatter::numberFormat protected function Format a number using the current settings. 1
GeneralNumberFormatter::numberFormatBasic protected function Formats a number using the basic set of formatting features.
GeneralNumberFormatter::numberFormatGeneral protected function Formats a number using the general set of formatting features.
GeneralNumberFormatter::numberFormatNumeral protected function Formats a number using a number system base.
GeneralNumberFormatter::numberFormatPercentage protected function Formats a number using a basic set of formatting features for percentages.
GeneralNumberFormatter::numberFormatScientific protected function Formats a number using scientific notation.
GeneralNumberFormatter::sanitizeSettings protected function Sanitize settings to insure that they are safe and valid. 2
GeneralNumberFormatter::selectPrefix protected function Returns a prefix selected based on the value.
GeneralNumberFormatter::selectSuffix protected function Returns a suffix selected based on the value.
GeneralNumberFormatter::settingsForm public function Returns a form to configure settings for the formatter. Overrides FormatterBase::settingsForm 2
GeneralNumberFormatter::settingsSummary public function Returns a short summary for the current formatter settings. Overrides FormatterBase::settingsSummary 2
GeneralNumberFormatter::viewElements public function Builds a renderable array for a field value. Overrides FormatterInterface::viewElements 1
GeneralNumberListFormatter::getDescription protected function Returns a brief description of the formatter. Overrides GeneralNumberFormatter::getDescription
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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.