🇨🇳China smiletrl
I was working on this issue these days, and this is one widget working for my string text field. It uses some code from field_collection module, adds a few customization. Maybe someone can get some idea for your customization.
namespace Drupal\bix_global\Plugin\Field\FieldWidget;
use Drupal\Component\Utility\Html;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextfieldWidget;
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
/**
* Plugin implementation of the custom string widget.
*
* @FieldWidget(
* id = "bix_global_string_textfield",
* label = @Translation("BIX Global Textfield"),
* field_types = {
* "string"
* },
* )
*/
class BixGlobalStringTextfieldWidget extends StringTextfieldWidget {
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
$field_name = $this->fieldDefinition->getName();
// Nest the field collection item entity form in a dedicated parent space,
// by appending [field_name, delta] to the current parent space.
// That way the form values of the field collection item are separated.
$parents = array_merge($element['#field_parents'], [$field_name, $delta]);
//$parents = $form['#parents'];
$element += [
//'#element_validate' => [[static::class, 'validate']],
'#parents' => $parents,
'#field_name' => $field_name,
];
// Put the remove button on unlimited cardinality field collection fields.
if ($this->fieldDefinition->getFieldStorageDefinition()->getCardinality() == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
$options = ['query' => ['element_parents' => implode('/', $element['#parents'])]];
$element['actions'] = [
'#type' => 'actions',
'remove_button' => [
'#delta' => $delta,
'#name' => implode('_', $parents) . '_remove_button',
'#type' => 'submit',
'#value' => t('Remove'),
'#validate' => [],
'#submit' => [[static::class, 'removeSubmit']],
'#limit_validation_errors' => [],
'#attributes' => array(
'class' => array('bix-global-custom-multi-field-remove-button'),
),
'#ajax' => [
'callback' => [$this, 'ajaxRemove'],
'options' => $options,
'effect' => 'fade',
'wrapper' => $form['#wrapper_id'],
],
'#weight' => 1000,
],
];
}
return $element;
}
/**
* {@inheritdoc}
*/
protected function formMultipleElements(FieldItemListInterface $items, array &$form, FormStateInterface $form_state) {
// We don't want to render empty items on field collection fields
// unless a) the field collection is empty ; b) the form is rebuilding,
// which means that the user clicked on "Add another item"; or
// c) we are creating a new entity.
if ((count($items) > 0) && !$form_state->isRebuilding() && !$items->getEntity()->isNew()) {
$field_name = $this->fieldDefinition->getName();
$cardinality = $this->fieldDefinition->getFieldStorageDefinition()->getCardinality();
$parents = $form['#parents'];
if ($cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
$field_state = static::getWidgetState($parents, $field_name, $form_state);
$field_state['items_count']--;
static::setWidgetState($parents, $field_name, $form_state, $field_state);
}
}
// Adjust wrapper identifiers as they are shared between parents and
// children in nested field collections.
$form['#wrapper_id'] = Html::getUniqueID($items->getName());
$elements = parent::formMultipleElements($items, $form, $form_state);
$elements['#prefix'] = '<div id="' . $form['#wrapper_id'] . '">';
$elements['#suffix'] = '</div>';
$elements['add_more']['#ajax']['wrapper'] = $form['#wrapper_id'];
return $elements;
}
/**
* Submit callback to remove an item from the field UI multiple wrapper.
*
* When a remove button is submitted, we need to find the item that it
* referenced and delete it. Since field UI has the deltas as a straight
* unbroken array key, we have to renumber everything down. Since we do this
* we *also* need to move all the deltas around in the $form_state->values
* and $form_state input so that user changed values follow. This is a bit
* of a complicated process.
*/
public static function removeSubmit($form, FormStateInterface $form_state) {
$button = $form_state->getTriggeringElement();
$delta = $button['#delta'];
// Where in the form we'll find the parent element.
$address = array_slice($button['#array_parents'], 0, -4);
$address_state = array_slice($button['#parents'], 0, -3);
// Go one level up in the form, to the widgets container.
$parent_element = NestedArray::getValue($form, array_merge($address, ['widget']));
$field_name = $parent_element['#field_name'];
$parents = $parent_element['#field_parents'];
$field_state = static::getWidgetState($parents, $field_name, $form_state);
// Go ahead and renumber everything from our delta to the last
// item down one. This will overwrite the item being removed.
for ($i = $delta; $i <= $field_state['items_count']; $i++) {
$old_element_address = array_merge($address, ['widget', $i + 1]);
$old_element_state_address = array_merge($address_state, [$i + 1]);
$new_element_state_address = array_merge($address_state, [$i]);
$moving_element = NestedArray::getValue($form, $old_element_address);
$moving_element_value = NestedArray::getValue($form_state->getValues(), $old_element_state_address);
$moving_element_input = NestedArray::getValue($form_state->getUserInput(), $old_element_state_address);
// Tell the element where it's being moved to.
$moving_element['#parents'] = $new_element_state_address;
// Move the element around.
$form_state->setValueForElement($moving_element, $moving_element_value);
$user_input = $form_state->getUserInput();
NestedArray::setValue($user_input, $moving_element['#parents'], $moving_element_input);
$form_state->setUserInput($user_input);
// Move the entity in our saved state.
if (isset($field_state['entity'][$i + 1])) {
$field_state['entity'][$i] = $field_state['entity'][$i + 1];
}
else {
unset($field_state['entity'][$i]);
}
}
// Then remove the last item. But we must not go negative.
if ($field_state['items_count'] > 0) {
$field_state['items_count']--;
}
else {
$form_state->setValue('empty_item', 1);
}
// Fix the weights. Field UI lets the weights be in a range of
// (-1 * item_count) to (item_count). This means that when we remove one,
// the range shrinks; weights outside of that range then get set to
// the first item in the select by the browser, floating them to the top.
// We use a brute force method because we lost weights on both ends
// and if the user has moved things around, we have to cascade because
// if I have items weight weights 3 and 4, and I change 4 to 3 but leave
// the 3, the order of the two 3s now is undefined and may not match what
// the user had selected.
$input = NestedArray::getValue($form_state->getUserInput(), $address_state);
// Sort by weight.
// This sort function depends on field_collection module.
uasort($input, '_field_collection_sort_items_helper');
// Reweight everything in the correct order.
$weight = -1 * $field_state['items_count'];
foreach ($input as $key => $item) {
if ($item) {
$input[$key]['_weight'] = $weight++;
}
}
$user_input = $form_state->getUserInput();
NestedArray::setValue($user_input, $address_state, $input);
$form_state->setUserInput($user_input);
static::setWidgetState($parents, $field_name, $form_state, $field_state);
$form_state->setRebuild();
}
/**
* Ajax callback to remove a field collection from a multi-valued field.
*
* @param array $form
* @param \Drupal\Core\Form\FormStateInterface $form_state
*
* @return \Drupal\Core\Ajax\AjaxResponse
* An AjaxResponse object.
*
* @see self::removeSubmit()
*/
function ajaxRemove(array $form, FormStateInterface &$form_state) {
// At this point, $this->removeSubmit() removed the element so we just need
// to return the parent element.
$button = $form_state->getTriggeringElement();
$element = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -3));
$delta = $element['#max_delta'];
if ($delta === 0) {
$empty_item_flag = $form_state->getValue('empty_item');
// Reset the last item's value to be NULL.
if ($empty_item_flag) {
$element[$delta]['value']['#value'] = '';
}
}
return $element;
}
/**
* {@inheritdoc}
*/
public static function addMoreSubmit(array $form, FormStateInterface $form_state) {
$button = $form_state->getTriggeringElement();
// Go one level up in the form, to the widgets container.
$element = NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -1));
$field_name = $element['#field_name'];
$parents = $element['#field_parents'];
// Increment the items count.
$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();
}
/**
* {@inheritdoc}
*/
public static function addMoreAjax(array $form, FormStateInterface $form_state) {
$element = parent::addMoreAjax($form, $form_state);
// Set the newest item empty value.
$delta = $element['#max_delta'];
$element[$delta]['value']['#default_value'] = '';
$element[$delta]['value']['#value'] = '';
return $element;
}
}