class WebformElementMultiple in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Element/WebformElementMultiple.php \Drupal\webform\Element\WebformElementMultiple
Provides a webform element for element multiple property.
This element displays the #multiple property so that it looks like the cardinality setting included in the Field API.
Plugin annotation
@FormElement("webform_element_multiple");
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\webform\Element\WebformElementMultiple
- class \Drupal\Core\Render\Element\FormElement implements FormElementInterface
- class \Drupal\Core\Render\Element\RenderElement implements ElementInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of WebformElementMultiple
See also
\Drupal\field_ui\Form\FieldStorageConfigEditForm::form
1 #type use of WebformElementMultiple
- WebformElementBase::form in src/
Plugin/ WebformElementBase.php - Gets the actual configuration webform array to be built.
File
- src/
Element/ WebformElementMultiple.php, line 19
Namespace
Drupal\webform\ElementView source
class WebformElementMultiple extends FormElement {
/**
* {@inheritdoc}
*/
public function getInfo() {
$class = get_class($this);
return [
'#input' => TRUE,
'#min' => 1,
'#process' => [
[
$class,
'processWebformElementMultiple',
],
],
'#theme_wrappers' => [
'form_element',
],
];
}
/**
* {@inheritdoc}
*/
public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
if ($input === FALSE) {
if (empty($element['#default_value'])) {
return 1;
}
elseif ($element['#default_value'] === TRUE) {
return WebformMultiple::CARDINALITY_UNLIMITED;
}
else {
return $element['#default_value'];
}
}
return NULL;
}
/**
* Processes element multiple.
*/
public static function processWebformElementMultiple(&$element, FormStateInterface $form_state, &$complete_form) {
$cardinality = (int) $element['#value'];
$element['#tree'] = TRUE;
$element['container'] = [
'#type' => 'container',
'#attributes' => [
'class' => [
'container-inline',
],
],
];
$element['container']['cardinality'] = [
'#type' => 'select',
'#title' => t('Allowed number of values'),
'#title_display' => 'invisible',
'#options' => [
'number' => t('Limited'),
WebformMultiple::CARDINALITY_UNLIMITED => t('Unlimited'),
],
'#default_value' => $cardinality === WebformMultiple::CARDINALITY_UNLIMITED ? WebformMultiple::CARDINALITY_UNLIMITED : 'number',
];
$element['container']['cardinality_number'] = [
'#type' => 'number',
'#default_value' => $cardinality !== WebformMultiple::CARDINALITY_UNLIMITED ? $cardinality : $element['#min'],
'#min' => $element['#min'],
'#title' => t('Limit'),
'#title_display' => 'invisible',
'#size' => 2,
'#states' => [
'visible' => [
':input[data-drupal-selector="edit-' . implode('-', $element['#parents']) . '-container-cardinality"]' => [
'value' => 'number',
],
],
],
];
// Set disabled.
if (!empty($element['#disabled'])) {
$element['container']['cardinality']['#disabled'] = TRUE;
$element['container']['cardinality_number']['#disabled'] = TRUE;
}
// Add validate callback.
$element += [
'#element_validate' => [],
];
array_unshift($element['#element_validate'], [
get_called_class(),
'validateWebformElementMultiple',
]);
// Set #type to item to apply #states.
// @see \Drupal\Core\Form\FormHelper::processStates
$element['#type'] = 'item';
return $element;
}
/**
* Validates element multiple.
*/
public static function validateWebformElementMultiple(&$element, FormStateInterface $form_state, &$complete_form) {
if (!Element::isVisibleElement($element)) {
$multiple = $element['#value'];
}
elseif (!empty($element['#disabled'])) {
$multiple = $element['#default_value'];
}
else {
$cardinality = (int) $element['#value']['container']['cardinality'];
$cardinality_number = (int) $element['#value']['container']['cardinality_number'];
if ($cardinality === WebformMultiple::CARDINALITY_UNLIMITED) {
$multiple = WebformMultiple::CARDINALITY_UNLIMITED;
}
else {
$multiple = $cardinality_number;
}
}
if ($multiple === WebformMultiple::CARDINALITY_UNLIMITED) {
$multiple = TRUE;
}
elseif ($multiple === 1) {
$multiple = FALSE;
}
$form_state
->setValueForElement($element['container']['cardinality'], NULL);
$form_state
->setValueForElement($element['container']['cardinality_number'], NULL);
$element['#value'] = $multiple;
$form_state
->setValueForElement($element, $multiple);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormElement:: |
public static | function | Adds autocomplete functionality to elements. | |
FormElement:: |
public static | function | #process callback for #pattern form element property. | |
FormElement:: |
public static | function | #element_validate callback for #pattern form element property. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
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:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginBase:: |
public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | 98 |
RenderElement:: |
public static | function | Adds Ajax information about an element to communicate with JavaScript. | |
RenderElement:: |
public static | function | Adds members of this group as actual elements for rendering. | |
RenderElement:: |
public static | function | Form element processing handler for the #ajax form property. | 1 |
RenderElement:: |
public static | function | Arranges elements into groups. | |
RenderElement:: |
public static | function |
Sets a form element's class attribute. Overrides ElementInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
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. | |
WebformElementMultiple:: |
public | function |
Returns the element properties for this element. Overrides ElementInterface:: |
|
WebformElementMultiple:: |
public static | function | Processes element multiple. | |
WebformElementMultiple:: |
public static | function | Validates element multiple. | |
WebformElementMultiple:: |
public static | function |
Determines how user input is mapped to an element's #value property. Overrides FormElement:: |