class DecimalItem

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

Defines the 'decimal' field type.

Plugin annotation

  id = "decimal",
  label = @Translation("Number (decimal)"),
  description = @Translation("This field stores a number in the database in a fixed decimal format."),
  category = @Translation("Number"),
  default_widget = "number",
  default_formatter = "number_decimal"


Expanded class hierarchy of DecimalItem


core/lib/Drupal/Core/Field/Plugin/Field/FieldType/DecimalItem.php, line 23


View source
class DecimalItem extends NumericItemBase {
     * {@inheritdoc}
    public static function defaultStorageSettings() {
        return [
            'precision' => 10,
            'scale' => 2,
        ] + parent::defaultStorageSettings();
     * {@inheritdoc}
    public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
        $properties['value'] = DataDefinition::create('string')->setLabel(new TranslatableMarkup('Decimal value'))
        return $properties;
     * {@inheritdoc}
    public static function schema(FieldStorageDefinitionInterface $field_definition) {
        return [
            'columns' => [
                'value' => [
                    'type' => 'numeric',
                    'precision' => $field_definition->getSetting('precision'),
                    'scale' => $field_definition->getSetting('scale'),
     * {@inheritdoc}
    public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
        $element = [];
        $settings = $this->getSettings();
        $element['precision'] = [
            '#type' => 'number',
            '#title' => $this->t('Precision'),
            '#min' => 10,
            '#max' => 32,
            '#default_value' => $settings['precision'],
            '#description' => $this->t('The total number of digits to store in the database, including those to the right of the decimal.'),
            '#disabled' => $has_data,
        $element['scale'] = [
            '#type' => 'number',
            '#title' => $this->t('Scale', [], [
                'context' => 'decimal places',
            '#min' => 0,
            '#max' => 10,
            '#default_value' => $settings['scale'],
            '#description' => $this->t('The number of digits to the right of the decimal.'),
            '#disabled' => $has_data,
        return $element;
     * {@inheritdoc}
    public function getConstraints() {
        $constraint_manager = \Drupal::typedDataManager()->getValidationConstraintManager();
        $constraints = parent::getConstraints();
        $constraints[] = $constraint_manager->create('ComplexData', [
            'value' => [
                'Regex' => [
                    'pattern' => '/^[+-]?((\\d+(\\.\\d*)?)|(\\.\\d+))$/i',
        return $constraints;
     * {@inheritdoc}
    public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
        $element = parent::fieldSettingsForm($form, $form_state);
        $settings = $this->getSettings();
        $element['min']['#step'] = pow(0.1, $settings['scale']);
        $element['max']['#step'] = pow(0.1, $settings['scale']);
        return $element;
     * {@inheritdoc}
    public function preSave() {
        $this->value = round($this->value, $this->getSetting('scale'));
     * {@inheritdoc}
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $settings = $field_definition->getSettings();
        $precision = $settings['precision'] ?: 10;
        $scale = $settings['scale'] ?: 2;
        // $precision - $scale is the number of digits on the left of the decimal
        // point.
        // The maximum number you can get with 3 digits is 10^3 - 1 --> 999.
        // The minimum number you can get with 3 digits is -1 * (10^3 - 1).
        $max = is_numeric($settings['max']) ? $settings['max'] : pow(10, $precision - $scale) - 1;
        $min = is_numeric($settings['min']) ? $settings['min'] : -pow(10, $precision - $scale) + 1;
        // Get the number of decimal digits for the $max
        $decimal_digits = self::getDecimalDigits($max);
        // Do the same for the min and keep the higher number of decimal digits.
        $decimal_digits = max(self::getDecimalDigits($min), $decimal_digits);
        // If $min = 1.234 and $max = 1.33 then $decimal_digits = 3
        $scale = rand($decimal_digits, $scale);
        // @see "Example #1 Calculate a random floating-point number" in
        $random_decimal = $min + mt_rand() / mt_getrandmax() * ($max - $min);
        $values['value'] = self::truncateDecimal($random_decimal, $scale);
        return $values;
     * Helper method to get the number of decimal digits out of a decimal number.
     * @param int $decimal
     *   The number to calculate the number of decimals digits from.
     * @return int
     *   The number of decimal digits.
    protected static function getDecimalDigits($decimal) {
        $digits = 0;
        while ($decimal - round($decimal)) {
            $decimal *= 10;
        return $digits;



Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DecimalItem::defaultStorageSettings public static function Defines the storage-level settings for this plugin. Overrides FieldItemBase::defaultStorageSettings
DecimalItem::fieldSettingsForm public function Returns a form for the field-level settings. Overrides NumericItemBase::fieldSettingsForm
DecimalItem::generateSampleValue public static function Generates placeholder field values. Overrides FieldItemBase::generateSampleValue
DecimalItem::getConstraints public function Gets a list of validation constraints. Overrides NumericItemBase::getConstraints
DecimalItem::getDecimalDigits protected static function Helper method to get the number of decimal digits out of a decimal number.
DecimalItem::preSave public function Defines custom presave behavior for field values. Overrides FieldItemBase::preSave
DecimalItem::propertyDefinitions public static function Defines field item properties. Overrides FieldItemInterface::propertyDefinitions
DecimalItem::schema public static function Returns the schema for the field. Overrides FieldItemInterface::schema
DecimalItem::storageSettingsForm public function Returns a form for the storage-level settings. Overrides FieldItemBase::storageSettingsForm
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldItemBase::calculateDependencies public static function Calculates dependencies for field items. Overrides FieldItemInterface::calculateDependencies 2
FieldItemBase::calculateStorageDependencies public static function Calculates dependencies for field items on the storage level. Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::delete public function Defines custom delete behavior for field values. Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Defines custom revision delete behavior for field values. Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Gets the entity that field belongs to. Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Gets the field definition. Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Gets the langcode of the field values held in the object. Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::mainPropertyName public static function Returns the name of the main property, if any. Overrides FieldItemInterface::mainPropertyName 8
FieldItemBase::onDependencyRemoval public static function Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Defines custom post-save behavior for field values. Overrides FieldItemInterface::postSave 2
FieldItemBase::setValue public function Overrides \Drupal\Core\TypedData\TypedData::setValue(). Overrides Map::setValue 4
FieldItemBase::storageSettingsFromConfigData public static function Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsToConfigData public static function Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Returns a renderable array for a single field item. Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet.
Overrides Map::writePropertyValue
FieldItemBase::__construct public function Constructs a TypedData object given its definition and context. Overrides TypedData::__construct 1
FieldItemBase::__get public function Magic method: Gets a property value. Overrides FieldItemInterface::__get 2
FieldItemBase::__isset public function Magic method: Determines whether a property is set. Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Magic method: Sets a property value. Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Magic method: Unsets a property. Overrides FieldItemInterface::__unset
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Applies the default value. Overrides TypedData::applyDefaultValue 4
Map::get public function Gets a property object. Overrides ComplexDataInterface::get
Map::getIterator public function
Map::getProperties public function Gets an array of property objects. Overrides ComplexDataInterface::getProperties
Map::getString public function Returns a string representation of the data. Overrides TypedData::getString
Map::getValue public function Gets the data value. Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Sets a property value. Overrides ComplexDataInterface::set
Map::toArray public function Returns an array of all property values. Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
NumericItemBase::defaultFieldSettings public static function Defines the field-level settings for this plugin. Overrides FieldItemBase::defaultFieldSettings 1
NumericItemBase::isEmpty public function Determines whether the data structure is empty. Overrides Map::isEmpty
NumericItemBase::truncateDecimal protected static function Helper method to truncate a decimal number to a given number of decimals.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
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.
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2

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