class AdjustmentDefaultWidget in Commerce Core 8.2
Plugin implementation of 'commerce_adjustment_default'.
Plugin annotation
@FieldWidget(
id = "commerce_adjustment_default",
label = @Translation("Adjustment"),
field_types = {
"commerce_adjustment"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\commerce_order\Plugin\Field\FieldWidget\AdjustmentDefaultWidget
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of AdjustmentDefaultWidget
1 file declares its use of AdjustmentDefaultWidget
- commerce_order_test.module in modules/
order/ tests/ modules/ commerce_order_test/ commerce_order_test.module - A test module for the commerce_order module.
File
- modules/
order/ src/ Plugin/ Field/ FieldWidget/ AdjustmentDefaultWidget.php, line 22
Namespace
Drupal\commerce_order\Plugin\Field\FieldWidgetView source
class AdjustmentDefaultWidget extends WidgetBase {
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
/** @var \Drupal\commerce_order\Adjustment $adjustment */
$adjustment = $items[$delta]->value;
$element['#type'] = 'container';
$element['#attributes']['class'][] = 'form--inline';
$element['#attached']['library'][] = 'commerce_price/admin';
/** @var \Drupal\Component\Plugin\PluginManagerInterface $plugin_manager */
$plugin_manager = \Drupal::service('plugin.manager.commerce_adjustment_type');
$types = [
'_none' => $this
->t('- Select -'),
];
foreach ($plugin_manager
->getDefinitions() as $id => $definition) {
if (!empty($definition['has_ui'])) {
$types[$id] = $definition['label'];
}
}
$element['type'] = [
'#type' => 'select',
'#title' => $this
->t('Type'),
'#options' => $types,
'#weight' => 1,
'#default_value' => $adjustment ? $adjustment
->getType() : '_none',
];
// If this is being added through the UI, the source ID should be empty,
// and we will want to default it to custom.
$source_id = $adjustment ? $adjustment
->getSourceId() : NULL;
$element['source_id'] = [
'#type' => 'value',
'#value' => empty($source_id) ? 'custom' : $source_id,
];
// If this is being added through the UI, the adjustment should be locked.
// UI added adjustments need to be locked to persist after an order refresh.
$element['locked'] = [
'#type' => 'value',
'#value' => $adjustment ? $adjustment
->isLocked() : TRUE,
];
$states_selector_name = $this->fieldDefinition
->getName() . "[{$delta}][type]";
$element['definition'] = [
'#type' => 'container',
'#weight' => 2,
'#states' => [
'invisible' => [
'select[name="' . $states_selector_name . '"]' => [
'value' => '_none',
],
],
],
];
$element['definition']['label'] = [
'#type' => 'textfield',
'#title' => $this
->t('Label'),
'#size' => 20,
'#default_value' => $adjustment ? $adjustment
->getLabel() : '',
];
$element['definition']['amount'] = [
'#type' => 'commerce_price',
'#title' => $this
->t('Amount'),
'#default_value' => $adjustment ? $adjustment
->getAmount()
->toArray() : NULL,
'#allow_negative' => TRUE,
'#states' => [
'optional' => [
'select[name="' . $states_selector_name . '"]' => [
'value' => '_none',
],
],
],
'#attributes' => [
'class' => [
'clearfix',
],
],
];
$element['definition']['included'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Included in the base price'),
'#default_value' => $adjustment ? $adjustment
->isIncluded() : FALSE,
];
return $element;
}
/**
* {@inheritdoc}
*/
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
foreach ($values as $key => $value) {
if ($value['type'] == '_none') {
continue;
}
// The method can be called with invalid or incomplete data, in
// preparation for validation. Passing such data to the Adjustment
// object would result in an exception.
if (empty($value['definition']['label'])) {
$form_state
->setErrorByName('adjustments[' . $key . '][definition][label]', $this
->t('The adjustment label field is required.'));
continue;
}
$values[$key] = new Adjustment([
'type' => $value['type'],
'label' => $value['definition']['label'],
'amount' => new Price($value['definition']['amount']['number'], $value['definition']['amount']['currency_code']),
'source_id' => $value['source_id'],
'included' => $value['definition']['included'],
'locked' => $value['locked'],
]);
}
return $values;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AdjustmentDefaultWidget:: |
public | function |
Returns the form for a single field widget. Overrides WidgetInterface:: |
|
AdjustmentDefaultWidget:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetBase:: |
|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
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 | |
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public static | function |
Defines the default settings for this plugin. Overrides PluginSettingsInterface:: |
42 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
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. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface:: |
8 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public | function |
Returns a form to configure settings for the widget. Overrides WidgetInterface:: |
16 |
WidgetBase:: |
public | function |
Returns a short summary for the current widget settings. Overrides WidgetInterface:: |
15 |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |