View source
<?php
namespace Drupal\Core\Field;
use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\NestedArray;
use Drupal\Component\Utility\SortArray;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Render\Element;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\Validator\ConstraintViolationInterface;
use Symfony\Component\Validator\ConstraintViolationListInterface;
abstract class WidgetBase extends PluginSettingsBase implements WidgetInterface, ContainerFactoryPluginInterface {
protected $fieldDefinition;
protected $settings;
public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings) {
parent::__construct([], $plugin_id, $plugin_definition);
$this->fieldDefinition = $field_definition;
$this->settings = $settings;
$this->thirdPartySettings = $third_party_settings;
}
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings']);
}
public function form(FieldItemListInterface $items, array &$form, FormStateInterface $form_state, $get_delta = NULL) {
$field_name = $this->fieldDefinition
->getName();
$parents = $form['#parents'];
if (!static::getWidgetState($parents, $field_name, $form_state)) {
$field_state = [
'items_count' => count($items),
'array_parents' => [],
];
static::setWidgetState($parents, $field_name, $form_state, $field_state);
}
$elements = [];
if ($this
->handlesMultipleValues() || isset($get_delta)) {
$delta = isset($get_delta) ? $get_delta : 0;
$element = [
'#title' => $this->fieldDefinition
->getLabel(),
'#description' => $this
->getFilteredDescription(),
];
$element = $this
->formSingleElement($items, $delta, $element, $form, $form_state);
if ($element) {
if (isset($get_delta)) {
$elements[$delta] = $element;
}
else {
$elements = $element;
}
}
}
else {
$elements = $this
->formMultipleElements($items, $form, $form_state);
}
$context = [
'form' => $form,
'widget' => $this,
'items' => $items,
'default' => $this
->isDefaultValueWidget($form_state),
];
\Drupal::moduleHandler()
->alterDeprecated('Deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use hook_field_widget_complete_form_alter or hook_field_widget_complete_WIDGET_TYPE_form_alter instead. See https://www.drupal.org/node/3180429.', [
'field_widget_multivalue_form',
'field_widget_multivalue_' . $this
->getPluginId() . '_form',
], $elements, $form_state, $context);
$elements['#after_build'][] = [
static::class,
'afterBuild',
];
$elements['#field_name'] = $field_name;
$elements['#field_parents'] = $parents;
$elements['#parents'] = array_merge($parents, [
$field_name,
]);
$elements += [
'#tree' => TRUE,
];
$field_widget_complete_form = [
'#type' => 'container',
'#parents' => array_merge($parents, [
$field_name . '_wrapper',
]),
'#attributes' => [
'class' => [
'field--type-' . Html::getClass($this->fieldDefinition
->getType()),
'field--name-' . Html::getClass($field_name),
'field--widget-' . Html::getClass($this
->getPluginId()),
],
],
'widget' => $elements,
];
$context = [
'form' => $form,
'widget' => $this,
'items' => $items,
'default' => $this
->isDefaultValueWidget($form_state),
];
\Drupal::moduleHandler()
->alter([
'field_widget_complete_form',
'field_widget_complete_' . $this
->getPluginId() . '_form',
], $field_widget_complete_form, $form_state, $context);
return $field_widget_complete_form;
}
protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
$field_name = $this->fieldDefinition
->getName();
$cardinality = $this->fieldDefinition
->getFieldStorageDefinition()
->getCardinality();
$parents = $form['#parents'];
switch ($cardinality) {
case FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED:
$field_state = static::getWidgetState($parents, $field_name, $form_state);
$max = $field_state['items_count'];
$is_multiple = TRUE;
break;
default:
$max = $cardinality - 1;
$is_multiple = $cardinality > 1;
break;
}
$title = $this->fieldDefinition
->getLabel();
$description = $this
->getFilteredDescription();
$elements = [];
for ($delta = 0; $delta <= $max; $delta++) {
if (!isset($items[$delta])) {
$items
->appendItem();
}
if ($is_multiple) {
$element = [
'#title' => $this
->t('@title (value @number)', [
'@title' => $title,
'@number' => $delta + 1,
]),
'#title_display' => 'invisible',
'#description' => '',
];
}
else {
$element = [
'#title' => $title,
'#title_display' => 'before',
'#description' => $description,
];
}
$element = $this
->formSingleElement($items, $delta, $element, $form, $form_state);
if ($element) {
if ($is_multiple) {
$element['_weight'] = [
'#type' => 'weight',
'#title' => $this
->t('Weight for row @number', [
'@number' => $delta + 1,
]),
'#title_display' => 'invisible',
'#delta' => $max,
'#default_value' => $items[$delta]->_weight ?: $delta,
'#weight' => 100,
];
}
$elements[$delta] = $element;
}
}
if ($elements) {
$elements += [
'#theme' => 'field_multiple_value_form',
'#field_name' => $field_name,
'#cardinality' => $cardinality,
'#cardinality_multiple' => $this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple(),
'#required' => $this->fieldDefinition
->isRequired(),
'#title' => $title,
'#description' => $description,
'#max_delta' => $max,
];
if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED && !$form_state
->isProgrammed()) {
$id_prefix = implode('-', array_merge($parents, [
$field_name,
]));
$wrapper_id = Html::getUniqueId($id_prefix . '-add-more-wrapper');
$elements['#prefix'] = '<div id="' . $wrapper_id . '">';
$elements['#suffix'] = '</div>';
$elements['add_more'] = [
'#type' => 'submit',
'#name' => strtr($id_prefix, '-', '_') . '_add_more',
'#value' => t('Add another item'),
'#attributes' => [
'class' => [
'field-add-more-submit',
],
],
'#limit_validation_errors' => [
array_merge($parents, [
$field_name,
]),
],
'#submit' => [
[
static::class,
'addMoreSubmit',
],
],
'#ajax' => [
'callback' => [
static::class,
'addMoreAjax',
],
'wrapper' => $wrapper_id,
'effect' => 'fade',
],
];
}
}
return $elements;
}
public static function afterBuild(array $element, FormStateInterface $form_state) {
$parents = $element['#field_parents'];
$field_name = $element['#field_name'];
$field_state = static::getWidgetState($parents, $field_name, $form_state);
$field_state['array_parents'] = $element['#array_parents'];
static::setWidgetState($parents, $field_name, $form_state, $field_state);
return $element;
}
public static function addMoreSubmit(array $form, FormStateInterface $form_state) {
$button = $form_state
->getTriggeringElement();
$element = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -1));
$field_name = $element['#field_name'];
$parents = $element['#field_parents'];
$field_state = static::getWidgetState($parents, $field_name, $form_state);
$field_state['items_count']++;
static::setWidgetState($parents, $field_name, $form_state, $field_state);
$form_state
->setRebuild();
}
public static function addMoreAjax(array $form, FormStateInterface $form_state) {
$button = $form_state
->getTriggeringElement();
$element = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -1));
if ($element['#cardinality'] != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
return;
}
$delta = $element['#max_delta'];
$element[$delta]['#prefix'] = '<div class="ajax-new-content">' . (isset($element[$delta]['#prefix']) ? $element[$delta]['#prefix'] : '');
$element[$delta]['#suffix'] = (isset($element[$delta]['#suffix']) ? $element[$delta]['#suffix'] : '') . '</div>';
return $element;
}
protected function formSingleElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element += [
'#field_parents' => $form['#parents'],
'#required' => $delta == 0 && $this->fieldDefinition
->isRequired(),
'#delta' => $delta,
'#weight' => $delta,
];
$element = $this
->formElement($items, $delta, $element, $form, $form_state);
if ($element) {
$context = [
'form' => $form,
'widget' => $this,
'items' => $items,
'delta' => $delta,
'default' => $this
->isDefaultValueWidget($form_state),
];
\Drupal::moduleHandler()
->alterDeprecated('Deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Use hook_field_widget_single_element_form_alter or hook_field_widget_single_element_WIDGET_TYPE_form_alter instead. See https://www.drupal.org/node/3180429.', [
'field_widget_form',
'field_widget_' . $this
->getPluginId() . '_form',
], $element, $form_state, $context);
\Drupal::moduleHandler()
->alter([
'field_widget_single_element_form',
'field_widget_single_element_' . $this
->getPluginId() . '_form',
], $element, $form_state, $context);
}
return $element;
}
public function extractFormValues(FieldItemListInterface $items, array $form, FormStateInterface $form_state) {
$field_name = $this->fieldDefinition
->getName();
$path = array_merge($form['#parents'], [
$field_name,
]);
$key_exists = NULL;
$values = NestedArray::getValue($form_state
->getValues(), $path, $key_exists);
if ($key_exists) {
if (!$this
->handlesMultipleValues()) {
unset($values['add_more']);
foreach ($values as $delta => &$value) {
$value['_original_delta'] = $delta;
}
usort($values, function ($a, $b) {
return SortArray::sortByKeyInt($a, $b, '_weight');
});
}
$values = $this
->massageFormValues($values, $form, $form_state);
$items
->setValue($values);
$items
->filterEmptyItems();
$field_state = static::getWidgetState($form['#parents'], $field_name, $form_state);
foreach ($items as $delta => $item) {
$field_state['original_deltas'][$delta] = isset($item->_original_delta) ? $item->_original_delta : $delta;
unset($item->_original_delta, $item->_weight);
}
static::setWidgetState($form['#parents'], $field_name, $form_state, $field_state);
}
}
public function flagErrors(FieldItemListInterface $items, ConstraintViolationListInterface $violations, array $form, FormStateInterface $form_state) {
$field_name = $this->fieldDefinition
->getName();
$field_state = static::getWidgetState($form['#parents'], $field_name, $form_state);
if ($violations
->count()) {
$element = NestedArray::getValue($form_state
->getCompleteForm(), $field_state['array_parents']);
$element_path = implode('][', $element['#parents']);
if ($reported_errors = $form_state
->getErrors()) {
foreach (array_keys($reported_errors) as $error_path) {
if (strpos($error_path, $element_path) === 0) {
return;
}
}
}
if (Element::isVisibleElement($element)) {
$handles_multiple = $this
->handlesMultipleValues();
$violations_by_delta = $item_list_violations = [];
foreach ($violations as $violation) {
$property_path = explode('.', $violation
->getPropertyPath());
$delta = array_shift($property_path);
if (is_numeric($delta)) {
$violations_by_delta[$delta][] = $violation;
}
else {
$item_list_violations[] = $violation;
}
$violation->arrayPropertyPath = $property_path;
}
foreach ($violations_by_delta as $delta => $delta_violations) {
if ($handles_multiple) {
$delta_element = $element;
}
else {
$original_delta = $field_state['original_deltas'][$delta];
$delta_element = $element[$original_delta];
}
foreach ($delta_violations as $violation) {
$error_element = $this
->errorElement($delta_element, $violation, $form, $form_state);
if ($error_element !== FALSE) {
$form_state
->setError($error_element, $violation
->getMessage());
}
}
}
foreach ($item_list_violations as $violation) {
$form_state
->setError($element, $violation
->getMessage());
}
}
}
}
public static function getWidgetState(array $parents, $field_name, FormStateInterface $form_state) {
return NestedArray::getValue($form_state
->getStorage(), static::getWidgetStateParents($parents, $field_name));
}
public static function setWidgetState(array $parents, $field_name, FormStateInterface $form_state, array $field_state) {
NestedArray::setValue($form_state
->getStorage(), static::getWidgetStateParents($parents, $field_name), $field_state);
}
protected static function getWidgetStateParents(array $parents, $field_name) {
return array_merge([
'field_storage',
'#parents',
], $parents, [
'#fields',
$field_name,
]);
}
public function settingsForm(array $form, FormStateInterface $form_state) {
return [];
}
public function settingsSummary() {
return [];
}
public function errorElement(array $element, ConstraintViolationInterface $error, array $form, FormStateInterface $form_state) {
return $element;
}
public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
return $values;
}
protected function getFieldSettings() {
return $this->fieldDefinition
->getSettings();
}
protected function getFieldSetting($setting_name) {
return $this->fieldDefinition
->getSetting($setting_name);
}
protected function handlesMultipleValues() {
$definition = $this
->getPluginDefinition();
return $definition['multiple_values'];
}
public static function isApplicable(FieldDefinitionInterface $field_definition) {
return TRUE;
}
protected function isDefaultValueWidget(FormStateInterface $form_state) {
return (bool) $form_state
->get('default_value_widget');
}
protected function getFilteredDescription() {
return FieldFilteredMarkup::create(\Drupal::token()
->replace($this->fieldDefinition
->getDescription()));
}
}