IntegerItem.php

Same filename and directory in other branches
  1. 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php
  2. 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php
  3. 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php

Namespace

Drupal\Core\Field\Plugin\Field\FieldType

File

core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php

View source
<?php

namespace Drupal\Core\Field\Plugin\Field\FieldType;

use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\TypedData\DataDefinition;

/**
 * Defines the 'integer' field type.
 *
 * @FieldType(
 *   id = "integer",
 *   label = @Translation("Number (integer)"),
 *   description = @Translation("This field stores a number in the database as an integer."),
 *   category = @Translation("Number"),
 *   default_widget = "number",
 *   default_formatter = "number_integer"
 * )
 */
class IntegerItem extends NumericItemBase {
    
    /**
     * {@inheritdoc}
     */
    public static function defaultStorageSettings() {
        return [
            'unsigned' => FALSE,
            // Valid size property values include: 'tiny', 'small', 'medium', 'normal'
            // and 'big'.
'size' => 'normal',
        ] + parent::defaultStorageSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function defaultFieldSettings() {
        return [
            'min' => '',
            'max' => '',
            'prefix' => '',
            'suffix' => '',
        ] + parent::defaultFieldSettings();
    }
    
    /**
     * {@inheritdoc}
     */
    public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
        $properties['value'] = DataDefinition::create('integer')->setLabel(t('Integer value'))
            ->setRequired(TRUE);
        return $properties;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getConstraints() {
        $constraints = parent::getConstraints();
        // If this is an unsigned integer, add a validation constraint for the
        // integer to be positive.
        if ($this->getSetting('unsigned')) {
            $constraint_manager = \Drupal::typedDataManager()->getValidationConstraintManager();
            $constraints[] = $constraint_manager->create('ComplexData', [
                'value' => [
                    'Range' => [
                        'min' => 0,
                        'minMessage' => t('%name: The integer must be larger or equal to %min.', [
                            '%name' => $this->getFieldDefinition()
                                ->getLabel(),
                            '%min' => 0,
                        ]),
                    ],
                ],
            ]);
        }
        return $constraints;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function schema(FieldStorageDefinitionInterface $field_definition) {
        return [
            'columns' => [
                'value' => [
                    'type' => 'int',
                    // Expose the 'unsigned' setting in the field item schema.
'unsigned' => $field_definition->getSetting('unsigned'),
                    // Expose the 'size' setting in the field item schema. For instance,
                    // supply 'big' as a value to produce a 'bigint' type.
'size' => $field_definition->getSetting('size'),
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
        $min = $field_definition->getSetting('min') ?: 0;
        $max = $field_definition->getSetting('max') ?: 999;
        $values['value'] = mt_rand($min, $max);
        return $values;
    }

}

Classes

Title Deprecated Summary
IntegerItem Defines the 'integer' field type.

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