class ComputedDecimalItem in Computed Field 8.2
Same name and namespace in other branches
- 3.x src/Plugin/Field/FieldType/ComputedDecimalItem.php \Drupal\computed_field\Plugin\Field\FieldType\ComputedDecimalItem
Plugin implementation of the 'computed_decimal' field type.
Plugin annotation
@FieldType(
id = "computed_decimal",
label = @Translation("Computed (decimal)"),
description = @Translation("This field defines a decimal field whose value is computed by PHP-Code"),
category = @Translation("Computed"),
default_widget = "computed_number_widget",
default_formatter = "computed_decimal",
permission = "administer computed field",
)
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements PluginInspectionInterface, TypedDataInterface uses DependencySerializationTrait, StringTranslationTrait, TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\computed_field\Plugin\Field\FieldType\ComputedFieldItemBase uses ComputedFieldItemTrait
- class \Drupal\computed_field\Plugin\Field\FieldType\ComputedDecimalItem
- class \Drupal\computed_field\Plugin\Field\FieldType\ComputedFieldItemBase uses ComputedFieldItemTrait
- class \Drupal\Core\Field\FieldItemBase implements FieldItemInterface
- class \Drupal\Core\TypedData\Plugin\DataType\Map implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, ComplexDataInterface
Expanded class hierarchy of ComputedDecimalItem
File
- src/
Plugin/ Field/ FieldType/ ComputedDecimalItem.php, line 24
Namespace
Drupal\computed_field\Plugin\Field\FieldTypeView source
class ComputedDecimalItem extends ComputedFieldItemBase {
/**
* {@inheritdoc}
*/
public static function defaultStorageSettings() {
return [
'precision' => 10,
'scale' => 2,
] + parent::defaultStorageSettings();
}
/**
* {@inheritdoc}
*/
public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
// Prevent early t() calls by using the TranslatableMarkup.
$properties['value'] = DataDefinition::create('string')
->setLabel(new TranslatableMarkup('Decimal value'))
->setRequired(TRUE);
return $properties;
}
/**
* {@inheritdoc}
*/
public static function schema(FieldStorageDefinitionInterface $field_definition) {
$settings = $field_definition
->getSettings();
$schema = [
'columns' => [
'value' => [
'type' => 'numeric',
'precision' => $settings['precision'],
'scale' => $settings['scale'],
],
],
];
return $schema;
}
/**
* {@inheritdoc}
*
* @todo Add useful code.
*/
public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
$values['value'] = 0;
return $values;
}
/**
* {@inheritdoc}
*/
public function fieldSettingsForm(array $form, FormStateInterface $form_state) {
$element = parent::fieldSettingsForm($form, $form_state);
$settings = $this
->getSettings();
$element['code']['#title'] = $this
->t('Code (PHP) to compute the <em>decimal</em> value');
$element['code']['#description'] .= '<p>' . t('The value will be rounded to @scale decimals.', [
'@scale' => $settings['scale'],
]) . '</p>';
return $element;
}
/**
* {@inheritdoc}
*/
public function storageSettingsForm(array &$form, FormStateInterface $form_state, $has_data) {
$element = [];
$settings = $this
->getSettings();
$precision_range = range(10, 32);
$element['precision'] = [
'#type' => 'select',
'#title' => t('Precision'),
'#options' => array_combine($precision_range, $precision_range),
'#default_value' => $settings['precision'],
'#description' => t('The total number of digits to store in the database, including those to the right of the decimal.'),
'#disabled' => $has_data,
];
$scale_range = range(0, 10);
$element['scale'] = [
'#type' => 'select',
'#title' => t('Scale', [], [
'context' => 'decimal places',
]),
'#options' => array_combine($scale_range, $scale_range),
'#default_value' => $settings['scale'],
'#description' => t('The number of digits to the right of the decimal.'),
'#disabled' => $has_data,
];
return $element;
}
/**
* {@inheritdoc}
*
* @return float
* The floating point number.
*/
public function executeCode() {
return round(parent::executeCode(), $this
->getSettings()['scale']);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComputedDecimalItem:: |
public static | function |
Defines the storage-level settings for this plugin. Overrides FieldItemBase:: |
|
ComputedDecimalItem:: |
public | function |
Overrides ComputedFieldItemTrait:: |
|
ComputedDecimalItem:: |
public | function |
Returns a form for the field-level settings. Overrides ComputedFieldItemBase:: |
|
ComputedDecimalItem:: |
public static | function |
@todo Add useful code. Overrides FieldItemBase:: |
|
ComputedDecimalItem:: |
public static | function |
Defines field item properties. Overrides FieldItemInterface:: |
|
ComputedDecimalItem:: |
public static | function |
Returns the schema for the field. Overrides FieldItemInterface:: |
|
ComputedDecimalItem:: |
public | function |
Returns a form for the storage-level settings. Overrides FieldItemBase:: |
|
ComputedFieldItemBase:: |
public static | function |
Defines the field-level settings for this plugin. Overrides FieldItemBase:: |
|
ComputedFieldItemTrait:: |
protected | function | Determines if a compute function exists for this field. | |
ComputedFieldItemTrait:: |
public | function | Aliased as: getFieldSettingsFormBase | |
ComputedFieldItemTrait:: |
protected | function | Fetches this field's compute function name for implementing elsewhere. | |
ComputedFieldItemTrait:: |
public | function | ||
ComputedFieldItemTrait:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
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:: |
1 |
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 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:: |
1 |
FieldItemBase:: |
public | function |
Defines custom post-save behavior for field values. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public | function |
Sets the data value. Overrides Map:: |
4 |
FieldItemBase:: |
public static | function |
Returns a settings array in the field type's canonical representation. Overrides FieldItemInterface:: |
2 |
FieldItemBase:: |
public static | function |
Returns a settings array that can be stored as a configuration value. Overrides FieldItemInterface:: |
2 |
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. Overrides Map:: |
|
FieldItemBase:: |
public | function |
Constructs a TypedData object given its definition and context. Overrides TypedData:: |
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:: |
|
Map:: |
protected | property |
The data definition. Overrides TypedData:: |
|
Map:: |
protected | property | The array of properties. | |
Map:: |
protected | property | An array of values for the contained properties. | |
Map:: |
public | function |
Applies the default value. Overrides TypedData:: |
4 |
Map:: |
public | function |
Gets a property object. Overrides ComplexDataInterface:: |
|
Map:: |
public | function | ||
Map:: |
public | function |
Gets an array of property objects. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns a string representation of the data. Overrides TypedData:: |
|
Map:: |
public | function |
Gets the data value. Overrides TypedData:: |
1 |
Map:: |
public | function |
Overrides TraversableTypedDataInterface:: |
4 |
Map:: |
public | function |
Sets a property value. Overrides ComplexDataInterface:: |
|
Map:: |
public | function |
Returns an array of all property values. Overrides ComplexDataInterface:: |
1 |
Map:: |
public | function | Magic method: Implements a deep clone. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
TypedData:: |
protected | property | The property name. | |
TypedData:: |
protected | property | The parent typed data object. | |
TypedData:: |
public static | function |
Constructs a TypedData object given its definition and context. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets a list of validation constraints. Overrides TypedDataInterface:: |
9 |
TypedData:: |
public | function |
Gets the data definition. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the name of a property or item. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
TypedData:: |
public | function |
Returns the property path of the data. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Returns the root of the typed data tree. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface:: |
|
TypedData:: |
public | function |
Validates the currently set data value. Overrides TypedDataInterface:: |
|
TypedDataTrait:: |
protected | property | The typed data manager used for creating the data types. | |
TypedDataTrait:: |
public | function | Gets the typed data manager. | 2 |
TypedDataTrait:: |
public | function | Sets the typed data manager. | 2 |