Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php \Drupal\Core\Field\Plugin\Field\FieldType\IntegerItem
- 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldType/IntegerItem.php \Drupal\Core\Field\Plugin\Field\FieldType\IntegerItem
Defines the 'integer' field type.
Plugin annotation
@FieldType(
id = "integer",
label = @Translation("Number (integer)"),
description = {
@Translation("Number without decimals"),
@Translation("For example, 123"),
},
category = "number",
weight = -50,
default_widget = "number",
default_formatter = "number_integer"
)
Hierarchy
- class \Drupal\Core\Field\FieldItemBase extends \Drupal\Core\TypedData\Plugin\DataType\Map implements FieldItemInterface
- class \Drupal\Core\Field\Plugin\Field\FieldType\NumericItemBase
- class \Drupal\Core\Field\Plugin\Field\FieldType\IntegerItem
- class \Drupal\Core\Field\Plugin\Field\FieldType\NumericItemBase
Expanded class hierarchy of IntegerItem
2 files declare their use of IntegerItem
- AutoIncrementingTestItem.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Plugin/ Field/ FieldType/ AutoIncrementingTestItem.php - XmlEntityNormalizationQuirksTrait.php in core/
modules/ rest/ tests/ src/ Functional/ EntityResource/ XmlEntityNormalizationQuirksTrait.php
File
- core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldType/ IntegerItem.php, line 26
Namespace
Drupal\Core\Field\Plugin\Field\FieldTypeView source
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(new TranslatableMarkup('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' => $this
->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;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComplexDataInterface:: |
public | function | Gets a property object. | |
ComplexDataInterface:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 1 |
ComplexDataInterface:: |
public | function | Sets a property value. | 1 |
ComplexDataInterface:: |
public | function | Returns an array of all property values. | 1 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Calculates dependencies for field items on the storage level. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Defines custom delete behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom revision delete behavior for field values. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a short summary of the field's field-level settings. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Gets the entity that field belongs to. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the field definition. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Gets the langcode of the field values held in the object. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
protected | function | Returns the value of a field setting. | |
FieldItemBase:: |
protected | function | Returns the array of field settings. | |
FieldItemBase:: |
public static | function |
Returns the name of the main property, if any. Overrides FieldItemInterface:: |
8 |
FieldItemBase:: |
public static | function |
Informs the plugin that a dependency of the field will be deleted. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Defines custom presave behavior for field values. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public | function |
Sets the data value. Overrides TypedDataInterface:: |
3 |
FieldItemBase:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemInterface:: |
6 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public static | function |
Returns a short summary of the field's storage-level settings. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Returns a renderable array for a single field item. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
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. | |
FieldItemBase:: |
public | function | 1 | |
FieldItemBase:: |
public | function |
Magic method: Gets a property value. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Magic method: Determines whether a property is set. Overrides FieldItemInterface:: |
|
FieldItemBase:: |
public | function |
Magic method: Sets a property value. Overrides FieldItemInterface:: |
1 |
FieldItemBase:: |
public | function |
Magic method: Unsets a property. Overrides FieldItemInterface:: |
|
IntegerItem:: |
public static | function |
Defines the field-level settings for this plugin. Overrides NumericItemBase:: |
|
IntegerItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides FieldItemBase:: |
|
IntegerItem:: |
public static | function |
Generates placeholder field values. Overrides FieldItemBase:: |
|
IntegerItem:: |
public | function |
Gets a list of validation constraints. Overrides NumericItemBase:: |
|
IntegerItem:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
|
IntegerItem:: |
public static | function |
Returns the schema for the field. Overrides FieldItemInterface:: |
|
NumericItemBase:: |
public | function |
Returns a form for the field-level settings. Overrides FieldItemBase:: |
2 |
NumericItemBase:: |
public | function |
Determines whether the data structure is empty. Overrides ComplexDataInterface:: |
|
NumericItemBase:: |
protected static | function | Helper method to truncate a decimal number to a given number of decimals. | |
NumericItemBase:: |
public static | function | Validates that the minimum value is less than the maximum. | |
TraversableTypedDataInterface:: |
public | function | React to changes to a child property or item. | 5 |
TypedDataInterface:: |
public | function | Applies the default value. | 6 |
TypedDataInterface:: |
public static | function | Constructs a TypedData object given its definition and context. | 1 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 1 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 1 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 1 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 1 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 1 |
TypedDataInterface:: |
public | function | Gets the data value. | 1 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 1 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 1 |