class NumericField
Same name in other branches
- 9 core/modules/views/src/Plugin/views/field/NumericField.php \Drupal\views\Plugin\views\field\NumericField
- 8.9.x core/modules/views/src/Plugin/views/field/NumericField.php \Drupal\views\Plugin\views\field\NumericField
- 11.x core/modules/views/src/Plugin/views/field/NumericField.php \Drupal\views\Plugin\views\field\NumericField
Render a field as a numeric value.
Definition terms:
- float: If true this field contains a decimal value. If unset this field will be assumed to be integer.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\views\Plugin\views\field\NumericField extends \Drupal\views\Plugin\views\field\FieldPluginBase
- class \Drupal\views\Plugin\views\field\FieldPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements \Drupal\views\Plugin\views\field\FieldHandlerInterface
- class \Drupal\views\Plugin\views\HandlerBase extends \Drupal\views\Plugin\views\PluginBase implements \Drupal\views\Plugin\views\ViewsHandlerInterface
- class \Drupal\views\Plugin\views\PluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\views\Plugin\views\ViewsPluginInterface, \Drupal\Component\Plugin\DependentPluginInterface, \Drupal\Core\Security\TrustedCallbackInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of NumericField
Related topics
4 files declare their use of NumericField
- MappingTest.php in core/
modules/ views/ tests/ modules/ views_test_data/ src/ Plugin/ views/ style/ MappingTest.php - NodeNewComments.php in core/
modules/ comment/ src/ Plugin/ views/ field/ NodeNewComments.php - Score.php in core/
modules/ search/ src/ Plugin/ views/ field/ Score.php - StatisticsNumeric.php in core/
modules/ statistics/ src/ Plugin/ views/ field/ StatisticsNumeric.php
File
-
core/
modules/ views/ src/ Plugin/ views/ field/ NumericField.php, line 20
Namespace
Drupal\views\Plugin\views\fieldView source
class NumericField extends FieldPluginBase {
/**
* {@inheritdoc}
*/
protected function defineOptions() {
$options = parent::defineOptions();
$options['set_precision'] = [
'default' => FALSE,
];
$options['precision'] = [
'default' => 0,
];
$options['decimal'] = [
'default' => '.',
];
$options['separator'] = [
'default' => ',',
];
$options['format_plural'] = [
'default' => FALSE,
];
$options['format_plural_string'] = [
'default' => '1' . PoItem::DELIMITER . '@count',
];
$options['prefix'] = [
'default' => '',
];
$options['suffix'] = [
'default' => '',
];
return $options;
}
/**
* {@inheritdoc}
*/
public function buildOptionsForm(&$form, FormStateInterface $form_state) {
if (!empty($this->definition['float'])) {
$form['set_precision'] = [
'#type' => 'checkbox',
'#title' => $this->t('Round'),
'#description' => $this->t('If checked, the number will be rounded.'),
'#default_value' => $this->options['set_precision'],
];
$form['precision'] = [
'#type' => 'textfield',
'#title' => $this->t('Precision'),
'#default_value' => $this->options['precision'],
'#description' => $this->t('Specify how many digits to print after the decimal point.'),
'#states' => [
'visible' => [
':input[name="options[set_precision]"]' => [
'checked' => TRUE,
],
],
],
'#size' => 2,
];
$form['decimal'] = [
'#type' => 'textfield',
'#title' => $this->t('Decimal point'),
'#default_value' => $this->options['decimal'],
'#description' => $this->t('What single character to use as a decimal point.'),
'#size' => 2,
];
}
$form['separator'] = [
'#type' => 'select',
'#title' => $this->t('Thousands marker'),
'#options' => [
'' => $this->t('- None -'),
',' => $this->t('Comma'),
' ' => $this->t('Space'),
'.' => $this->t('Decimal'),
'\'' => $this->t('Apostrophe'),
],
'#default_value' => $this->options['separator'],
'#description' => $this->t('What single character to use as the thousands separator.'),
'#size' => 2,
];
$form['format_plural'] = [
'#type' => 'checkbox',
'#title' => $this->t('Format plural'),
'#description' => $this->t('If checked, special handling will be used for plurality.'),
'#default_value' => $this->options['format_plural'],
];
$form['format_plural_string'] = [
'#type' => 'value',
'#default_value' => $this->options['format_plural_string'],
];
$plural_array = explode(PoItem::DELIMITER, $this->options['format_plural_string']);
$plurals = $this->getNumberOfPlurals($this->view->storage
->get('langcode'));
for ($i = 0; $i < $plurals; $i++) {
$form['format_plural_values'][$i] = [
'#type' => 'textfield',
// @todo Should use better labels https://www.drupal.org/node/2499639
'#title' => $i == 0 ? $this->t('Singular form') : $this->formatPlural($i, 'First plural form', '@count. plural form'),
'#default_value' => $plural_array[$i] ?? '',
'#description' => $this->t('Text to use for this variant, @count will be replaced with the value.'),
'#states' => [
'visible' => [
':input[name="options[format_plural]"]' => [
'checked' => TRUE,
],
],
],
];
}
if ($plurals == 2) {
// Simplify interface text for the most common case.
$form['format_plural_values'][0]['#description'] = $this->t('Text to use for the singular form, @count will be replaced with the value.');
$form['format_plural_values'][1]['#title'] = $this->t('Plural form');
$form['format_plural_values'][1]['#description'] = $this->t('Text to use for the plural form, @count will be replaced with the value.');
}
$form['prefix'] = [
'#type' => 'textfield',
'#title' => $this->t('Prefix'),
'#default_value' => $this->options['prefix'],
'#description' => $this->t('Text to put before the number, such as currency symbol.'),
];
$form['suffix'] = [
'#type' => 'textfield',
'#title' => $this->t('Suffix'),
'#default_value' => $this->options['suffix'],
'#description' => $this->t('Text to put after the number, such as currency symbol.'),
];
parent::buildOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function submitOptionsForm(&$form, FormStateInterface $form_state) {
// Merge plural format options into one string and drop the individual
// option values.
$options =& $form_state->getValue('options');
$options['format_plural_string'] = implode(PoItem::DELIMITER, $options['format_plural_values']);
unset($options['format_plural_values']);
parent::submitOptionsForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
public function render(ResultRow $values) {
$value = $this->getValue($values);
// Check to see if hiding should happen before adding prefix and suffix
// and before rewriting.
if ($this->options['hide_empty'] && empty($value) && ($value !== 0 || $this->options['empty_zero'])) {
return '';
}
// After the hide_empty check NULL values should be treated as a 0 value.
$value = $value ?? 0;
if (!empty($this->options['set_precision'])) {
$precision = $this->options['precision'];
}
elseif ($decimal_position = strpos($value, '.')) {
$precision = strlen($value) - $decimal_position - 1;
}
else {
$precision = 0;
}
// Use round first to avoid negative zeros.
$value = round($value, $precision);
// Test against both integer zero and float zero.
if ($this->options['empty_zero'] && ($value === 0 || $value === 0.0)) {
return '';
}
$value = number_format($value, $precision, $this->options['decimal'], $this->options['separator']);
// If we should format as plural, take the (possibly) translated plural
// setting and format with the current language.
if (!empty($this->options['format_plural'])) {
$value = PluralTranslatableMarkup::createFromTranslatedString($value, $this->options['format_plural_string']);
}
return $this->sanitizeValue($this->options['prefix'], 'xss') . $this->sanitizeValue($value) . $this->sanitizeValue($this->options['suffix'], 'xss');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DerivativeInspectionInterface::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | 1 | ||
DerivativeInspectionInterface::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | 1 | ||
FieldPluginBase::$additional_fields | public | property | ||||
FieldPluginBase::$aliases | public | property | ||||
FieldPluginBase::$field_alias | public | property | ||||
FieldPluginBase::$lastRenderIndex | protected | property | Keeps track of the last render index. | |||
FieldPluginBase::$last_render | public | property | ||||
FieldPluginBase::$last_render_text | public | property | ||||
FieldPluginBase::$last_tokens | public | property | ||||
FieldPluginBase::$linkGenerator | protected | property | The link generator. | |||
FieldPluginBase::$original_value | public | property | ||||
FieldPluginBase::$renderer | protected | property | Stores the render API renderer. | Overrides PluginBase::$renderer | 1 | |
FieldPluginBase::addAdditionalFields | protected | function | Add 'additional' fields to the query. | |||
FieldPluginBase::addSelfTokens | protected | function | Add any special tokens this field might use for itself. | 4 | ||
FieldPluginBase::adminLabel | public | function | Overrides HandlerBase::adminLabel | |||
FieldPluginBase::adminSummary | public | function | Provide extra data to the administration form. | Overrides HandlerBase::adminSummary | ||
FieldPluginBase::advancedRender | public | function | Overrides FieldHandlerInterface::advancedRender | |||
FieldPluginBase::allowAdvancedRender | protected | function | Determine if this field can allow advanced rendering. | |||
FieldPluginBase::clickSort | public | function | Overrides FieldHandlerInterface::clickSort | 1 | ||
FieldPluginBase::clickSortable | public | function | Overrides FieldHandlerInterface::clickSortable | 5 | ||
FieldPluginBase::documentSelfTokens | protected | function | Document any special tokens this field might use for itself. | 3 | ||
FieldPluginBase::elementClasses | public | function | Overrides FieldHandlerInterface::elementClasses | |||
FieldPluginBase::elementLabelClasses | public | function | Overrides FieldHandlerInterface::elementLabelClasses | |||
FieldPluginBase::elementLabelType | public | function | Overrides FieldHandlerInterface::elementLabelType | |||
FieldPluginBase::elementType | public | function | Overrides FieldHandlerInterface::elementType | 1 | ||
FieldPluginBase::elementWrapperClasses | public | function | Overrides FieldHandlerInterface::elementWrapperClasses | |||
FieldPluginBase::elementWrapperType | public | function | Overrides FieldHandlerInterface::elementWrapperType | |||
FieldPluginBase::getElements | public | function | Overrides FieldHandlerInterface::getElements | |||
FieldPluginBase::getEntity | public | function | Overrides FieldHandlerInterface::getEntity | |||
FieldPluginBase::getFieldTokenPlaceholder | protected | function | Returns a token placeholder for the current field. | |||
FieldPluginBase::getPreviousFieldLabels | protected | function | Returns all field labels of fields before this field. | |||
FieldPluginBase::getRenderer | protected | function | Returns the render API renderer. | Overrides PluginBase::getRenderer | ||
FieldPluginBase::getRenderTokens | public | function | Overrides FieldHandlerInterface::getRenderTokens | |||
FieldPluginBase::getTokenValuesRecursive | protected | function | Recursive function to add replacements for nested query string parameters. | |||
FieldPluginBase::getValue | public | function | Overrides FieldHandlerInterface::getValue | 2 | ||
FieldPluginBase::init | public | function | Overrides HandlerBase::init | 13 | ||
FieldPluginBase::isValueEmpty | public | function | Overrides FieldHandlerInterface::isValueEmpty | |||
FieldPluginBase::label | public | function | Overrides FieldHandlerInterface::label | |||
FieldPluginBase::linkGenerator | protected | function | Gets the link generator. | |||
FieldPluginBase::postRender | public | function | Overrides FieldHandlerInterface::postRender | |||
FieldPluginBase::preRender | public | function | Overrides FieldHandlerInterface::preRender | 10 | ||
FieldPluginBase::query | public | function | Called to add the field to a query. | Overrides HandlerBase::query | 19 | |
FieldPluginBase::renderAltered | protected | function | Render this field as user-defined altered text. | |||
FieldPluginBase::renderAsLink | protected | function | Render this field as a link, with the info from a fieldset set by the user. | |||
FieldPluginBase::renderText | public | function | Overrides FieldHandlerInterface::renderText | |||
FieldPluginBase::renderTrimText | protected | function | Trims the field down to the specified length. | |||
FieldPluginBase::RENDER_TEXT_PHASE_COMPLETELY | constant | Indicator of the renderText() method for rendering the whole element. | ||||
FieldPluginBase::RENDER_TEXT_PHASE_EMPTY | constant | Indicator of the renderText() method for rendering the empty text. | ||||
FieldPluginBase::RENDER_TEXT_PHASE_SINGLE_ITEM | constant | Indicator of the renderText() method for rendering a single item. | ||||
FieldPluginBase::theme | public | function | Overrides FieldHandlerInterface::theme | |||
FieldPluginBase::themeFunctions | public | function | Overrides PluginBase::themeFunctions | |||
FieldPluginBase::tokenizeValue | public | function | Overrides FieldHandlerInterface::tokenizeValue | |||
FieldPluginBase::trimText | public static | function | Trims the field down to the specified length. | |||
FieldPluginBase::useStringGroupBy | public | function | Overrides FieldHandlerInterface::useStringGroupBy | |||
HandlerBase::$field | public | property | With field you can override the realField if the real field is not set. | |||
HandlerBase::$is_handler | public | property | ||||
HandlerBase::$moduleHandler | protected | property | The module handler. | 2 | ||
HandlerBase::$query | public | property | Where the $query object will reside. | 7 | ||
HandlerBase::$realField | public | property | The real field. | |||
HandlerBase::$relationship | public | property | The relationship used for this field. | |||
HandlerBase::$table | public | property | The table this handler is attached to. | |||
HandlerBase::$tableAlias | public | property | The alias of the table of this handler which is used in the query. | |||
HandlerBase::$viewsData | protected | property | The views data service. | |||
HandlerBase::acceptExposedInput | public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | ||
HandlerBase::access | public | function | Overrides ViewsHandlerInterface::access | 5 | ||
HandlerBase::breakString | public static | function | Overrides ViewsHandlerInterface::breakString | |||
HandlerBase::broken | public | function | Overrides ViewsHandlerInterface::broken | |||
HandlerBase::buildExposedForm | public | function | Render our chunk of the exposed handler form when selecting. | 1 | ||
HandlerBase::buildExposeForm | public | function | Form for exposed handler options. | 2 | ||
HandlerBase::buildExtraOptionsForm | public | function | Provide a form for setting options. | 1 | ||
HandlerBase::buildGroupByForm | public | function | Provide a form for aggregation settings. | 1 | ||
HandlerBase::calculateDependencies | public | function | Overrides PluginBase::calculateDependencies | 10 | ||
HandlerBase::canExpose | public | function | Determine if a handler can be exposed. | 2 | ||
HandlerBase::caseTransform | protected | function | Transform a string by a certain method. | |||
HandlerBase::defaultExposeOptions | public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 | ||
HandlerBase::defineExtraOptions | public | function | Provide defaults for the handler. | |||
HandlerBase::displayExposedForm | public | function | Displays the Expose form. | |||
HandlerBase::ensureMyTable | public | function | Overrides ViewsHandlerInterface::ensureMyTable | 2 | ||
HandlerBase::exposedInfo | public | function | Get information about the exposed form for the form renderer. | 1 | ||
HandlerBase::getDateField | public | function | Creates cross-database SQL dates. | 2 | ||
HandlerBase::getDateFormat | public | function | Creates cross-database SQL date formatting. | 2 | ||
HandlerBase::getEntityType | public | function | Overrides ViewsHandlerInterface::getEntityType | |||
HandlerBase::getField | public | function | Overrides ViewsHandlerInterface::getField | |||
HandlerBase::getJoin | public | function | Overrides ViewsHandlerInterface::getJoin | |||
HandlerBase::getModuleHandler | protected | function | Gets the module handler. | |||
HandlerBase::getTableJoin | public static | function | Overrides ViewsHandlerInterface::getTableJoin | |||
HandlerBase::getViewsData | protected | function | Gets views data service. | |||
HandlerBase::hasExtraOptions | public | function | Determines if the handler has extra options. | 1 | ||
HandlerBase::isAGroup | public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 | ||
HandlerBase::isExposed | public | function | Determine if this item is 'exposed'. | |||
HandlerBase::multipleExposedInput | public | function | Define if the exposed input has to be submitted multiple times. | 1 | ||
HandlerBase::placeholder | protected | function | Provides a unique placeholders for handlers. | |||
HandlerBase::postExecute | public | function | Overrides ViewsHandlerInterface::postExecute | |||
HandlerBase::preQuery | public | function | Overrides ViewsHandlerInterface::preQuery | 2 | ||
HandlerBase::sanitizeValue | public | function | Overrides ViewsHandlerInterface::sanitizeValue | |||
HandlerBase::setModuleHandler | public | function | Sets the module handler. | |||
HandlerBase::setRelationship | public | function | Overrides ViewsHandlerInterface::setRelationship | |||
HandlerBase::setViewsData | public | function | ||||
HandlerBase::showExposeButton | public | function | Shortcut to display the expose/hide button. | 2 | ||
HandlerBase::showExposeForm | public | function | Shortcut to display the exposed options form. | Overrides ViewsHandlerInterface::showExposeForm | ||
HandlerBase::storeExposedInput | public | function | If set to remember exposed input in the session, store it there. | 1 | ||
HandlerBase::submitExposed | public | function | Submit the exposed handler form. | |||
HandlerBase::submitExposeForm | public | function | Perform any necessary changes to the form exposes prior to storage. | |||
HandlerBase::submitExtraOptionsForm | public | function | Perform any necessary changes to the form values prior to storage. | |||
HandlerBase::submitFormCalculateOptions | public | function | Calculates options stored on the handler. | 1 | ||
HandlerBase::submitGroupByForm | public | function | Perform any necessary changes to the form values prior to storage. | 1 | ||
HandlerBase::submitTemporaryForm | public | function | Submits a temporary form. | |||
HandlerBase::usesGroupBy | public | function | Provides the handler some groupby. | 13 | ||
HandlerBase::validate | public | function | Overrides PluginBase::validate | 2 | ||
HandlerBase::validateExposed | public | function | Validate the exposed handler form. | 4 | ||
HandlerBase::validateExposeForm | public | function | Validate the options form. | 2 | ||
HandlerBase::validateExtraOptionsForm | public | function | Validate the options form. | |||
HandlerBase::__construct | public | function | Constructs a Handler object. | Overrides PluginBase::__construct | 42 | |
NumericField::buildOptionsForm | public | function | Overrides FieldPluginBase::buildOptionsForm | 1 | ||
NumericField::defineOptions | protected | function | Overrides FieldPluginBase::defineOptions | 1 | ||
NumericField::render | public | function | Overrides FieldPluginBase::render | 2 | ||
NumericField::submitOptionsForm | public | function | Overrides FieldPluginBase::submitOptionsForm | |||
PluginBase::$definition | public | property | Plugins' definition. | |||
PluginBase::$displayHandler | public | property | The display object this plugin is for. | |||
PluginBase::$options | public | property | Options for this plugin will be held here. | |||
PluginBase::$position | public | property | The handler position. | |||
PluginBase::$usesOptions | protected | property | Denotes whether the plugin has an additional options form. | 8 | ||
PluginBase::$view | public | property | The top object of a view. | 1 | ||
PluginBase::create | public static | function | Overrides ContainerFactoryPluginInterface::create | 60 | ||
PluginBase::destroy | public | function | Overrides ViewsPluginInterface::destroy | 2 | ||
PluginBase::doFilterByDefinedOptions | protected | function | Do the work to filter out stored options depending on the defined options. | |||
PluginBase::filterByDefinedOptions | public | function | Overrides ViewsPluginInterface::filterByDefinedOptions | |||
PluginBase::getAvailableGlobalTokens | public | function | Overrides ViewsPluginInterface::getAvailableGlobalTokens | |||
PluginBase::getProvider | public | function | Overrides ViewsPluginInterface::getProvider | |||
PluginBase::globalTokenForm | public | function | Overrides ViewsPluginInterface::globalTokenForm | |||
PluginBase::globalTokenReplace | public | function | Overrides ViewsPluginInterface::globalTokenReplace | |||
PluginBase::INCLUDE_ENTITY | constant | Include entity row languages when listing languages. | ||||
PluginBase::INCLUDE_NEGOTIATED | constant | Include negotiated languages when listing languages. | ||||
PluginBase::listLanguages | protected | function | Makes an array of languages, optionally including special languages. | |||
PluginBase::pluginTitle | public | function | Overrides ViewsPluginInterface::pluginTitle | |||
PluginBase::preRenderAddFieldsetMarkup | public static | function | Overrides ViewsPluginInterface::preRenderAddFieldsetMarkup | |||
PluginBase::preRenderFlattenData | public static | function | Overrides ViewsPluginInterface::preRenderFlattenData | |||
PluginBase::queryLanguageSubstitutions | public static | function | Returns substitutions for Views queries for languages. | |||
PluginBase::setOptionDefaults | protected | function | Fills up the options of the plugin with defaults. | |||
PluginBase::summaryTitle | public | function | Overrides ViewsPluginInterface::summaryTitle | 6 | ||
PluginBase::trustedCallbacks | public static | function | Overrides TrustedCallbackInterface::trustedCallbacks | 6 | ||
PluginBase::unpackOptions | public | function | Overrides ViewsPluginInterface::unpackOptions | |||
PluginBase::usesOptions | public | function | Overrides ViewsPluginInterface::usesOptions | 8 | ||
PluginBase::validateOptionsForm | public | function | Overrides ViewsPluginInterface::validateOptionsForm | 15 | ||
PluginBase::viewsTokenReplace | protected | function | Replaces Views' tokens in a given string. | 1 | ||
PluginBase::VIEWS_QUERY_LANGUAGE_SITE_DEFAULT | constant | Query string to indicate the site default language. | ||||
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 | ||
TrustedCallbackInterface::THROW_EXCEPTION | constant | Untrusted callbacks throw exceptions. | ||||
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION | constant | Untrusted callbacks trigger silenced E_USER_DEPRECATION errors. | ||||
TrustedCallbackInterface::TRIGGER_WARNING | Deprecated | constant | Untrusted callbacks trigger E_USER_WARNING errors. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.