class FieldStorageAddForm

class FieldStorageAddForm extends FormBase {
  
  /**
   * The name of the entity type.
   *
   * @var string
   */
  protected $entityTypeId;
  
  /**
   * The entity bundle.
   *
   * @var string
   */
  protected $bundle;
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;
  
  /**
   * The field type plugin manager.
   *
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypePluginManager;
  
  /**
   * The configuration factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;
  
  /**
   * Constructs a new FieldStorageAddForm object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_plugin_manager
   *   The field type plugin manager.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The configuration factory.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   (optional) The entity field manager.
   * @param \Drupal\Core\TempStore\PrivateTempStore|null $tempStore
   *   The private tempstore.
   * @param \Drupal\Core\Field\FieldTypeCategoryManagerInterface|null $fieldTypeCategoryManager
   *   The field type category plugin manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager, FieldTypePluginManagerInterface $field_type_plugin_manager, ConfigFactoryInterface $config_factory, EntityFieldManagerInterface $entity_field_manager, protected ?PrivateTempStore $tempStore = NULL, protected ?FieldTypeCategoryManagerInterface $fieldTypeCategoryManager = NULL) {
    $this->entityTypeManager = $entity_type_manager;
    $this->fieldTypePluginManager = $field_type_plugin_manager;
    $this->configFactory = $config_factory;
    $this->entityFieldManager = $entity_field_manager;
    if ($this->tempStore === NULL) {
      @trigger_error('Calling FieldStorageAddForm::__construct() without the $tempStore argument is deprecated in drupal:10.2.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3383719', E_USER_DEPRECATED);
      $this->tempStore = \Drupal::service('tempstore.private')->get('field_ui');
    }
    if ($this->fieldTypeCategoryManager === NULL) {
      @trigger_error('Calling FieldStorageAddForm::__construct() without the $fieldTypeCategoryManager argument is deprecated in drupal:10.2.0 and will be required in drupal:11.0.0. See https://www.drupal.org/node/3375740', E_USER_DEPRECATED);
      $this->fieldTypeCategoryManager = \Drupal::service('plugin.manager.field.field_type_category');
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container->get('entity_type.manager'), $container->get('plugin.manager.field.field_type'), $container->get('config.factory'), $container->get('entity_field.manager'), $container->get('tempstore.private')
      ->get('field_ui'), $container->get('plugin.manager.field.field_type_category'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'field_ui_field_storage_add_form';
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL, $bundle = NULL) {
    if (!$form_state->get('entity_type_id')) {
      $form_state->set('entity_type_id', $entity_type_id);
    }
    if (!$form_state->get('bundle')) {
      $form_state->set('bundle', $bundle);
    }
    $this->entityTypeId = $form_state->get('entity_type_id');
    $this->bundle = $form_state->get('bundle');
    if (!$form_state->has('field_type_options') || !$form_state->has('unique_definitions')) {
      $this->processFieldDefinitions($form_state);
    }
    // Place the 'translatable' property as an explicit value so that contrib
    // modules can form_alter() the value for newly created fields. By default
    // we create field storage as translatable so it will be possible to enable
    // translation at field level.
    $form['translatable'] = [
      '#type' => 'value',
      '#value' => TRUE,
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this->t('Continue'),
      '#button_type' => 'primary',
    ];
    $form['#attached']['library'] = [
      'field_ui/drupal.field_ui',
      'field_ui/drupal.field_ui.manage_fields',
      'core/drupal.ajax',
    ];
    if ($form_state->hasValue('new_storage_type')) {
      // A group is already selected. Show field types for that group.
      $this->addFieldOptionsForGroup($form, $form_state);
    }
    else {
      // Show options for groups and ungrouped field types.
      $this->addGroupFieldOptions($form, $form_state);
    }
    return $form;
  }
  
  /**
   * Save field type definitions and categories in the form state.
   *
   * Get all field type definitions and store each one twice:
   * - field_type_options: each field type is indexed by its category plugin ID
   *   or its label.
   * - unique_definitions: each field type is indexed by its category and name.
   *
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  protected function processFieldDefinitions(FormStateInterface $form_state) : void {
    $field_type_options = $unique_definitions = [];
    $grouped_definitions = $this->fieldTypePluginManager
      ->getGroupedDefinitions($this->fieldTypePluginManager
      ->getEntityTypeUiDefinitions($this->entityTypeId), 'label', 'id');
    foreach ($grouped_definitions as $category => $field_types) {
      foreach ($field_types as $name => $field_type) {
        $definition = [
          'unique_identifier' => $name,
        ] + $field_type;
        $category_info = $this->fieldTypeCategoryManager
          ->createInstance($field_type['category'], $definition);
        $definition['display_as_group'] = !$category_info instanceof FallbackFieldTypeCategory;
        $id = $this->fieldTypeCategoryManager
          ->hasDefinition($category) ? $category_info->getPluginId() : (string) $field_type['label'];
        $field_type_options[$id] = $definition;
        $unique_definitions[$category][$name] = $definition;
      }
    }
    $form_state->set('field_type_options', $field_type_options);
    $form_state->set('unique_definitions', $unique_definitions);
  }
  
  /**
   * Adds ungrouped field types and field type groups to the form.
   *
   * When a group is selected, the related fields are shown when the form is
   * rebuilt.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  protected function addGroupFieldOptions(array &$form, FormStateInterface $form_state) : void {
    $field_type_options_radios = [];
    foreach ($form_state->get('field_type_options') as $id => $field_type) {
      /** @var  \Drupal\Core\Field\FieldTypeCategoryInterface $category_info */
      $category_info = $this->fieldTypeCategoryManager
        ->createInstance($field_type['category'], $field_type);
      $display_as_group = $field_type['display_as_group'];
      $cleaned_class_name = Html::getClass($field_type['unique_identifier']);
      $field_type_options_radios[$id] = [
        '#type' => 'container',
        '#attributes' => [
          'class' => [
            'field-option',
            'js-click-to-select',
          ],
        ],
        '#weight' => $category_info->getWeight(),
        'thumb' => [
          '#type' => 'container',
          '#attributes' => [
            'class' => [
              'field-option__thumb',
            ],
          ],
          'icon' => [
            '#type' => 'container',
            '#attributes' => [
              'class' => [
                'field-option__icon',
                $display_as_group ? "field-icon-{$field_type['category']}" : "field-icon-{$cleaned_class_name}",
              ],
            ],
          ],
        ],
        'radio' => [
          '#type' => 'radio',
          '#title' => $category_info->getLabel(),
          '#parents' => [
            'new_storage_type',
          ],
          '#title_display' => 'before',
          '#description_display' => 'before',
          '#theme_wrappers' => [
            'form_element__new_storage_type',
          ],
          // If it is a category, set return value as the category label.
          // Otherwise, set it as the field type id.
'#return_value' => $display_as_group ? $field_type['category'] : $field_type['unique_identifier'],
          '#attributes' => [
            'class' => [
              'field-option-radio',
            ],
          ],
          '#description' => [
            '#type' => 'container',
            '#attributes' => [
              'class' => [
                'field-option__description',
              ],
            ],
            '#markup' => $category_info->getDescription(),
          ],
          '#variant' => 'field-option',
        ],
      ];
      if ($libraries = $category_info->getLibraries()) {
        $field_type_options_radios[$id]['#attached']['library'] = $libraries;
      }
    }
    uasort($field_type_options_radios, [
      SortArray::class,
      'sortByWeightProperty',
    ]);
    $form['add-label'] = [
      '#type' => 'label',
      '#title' => $this->t('Choose a type of field'),
      '#required' => TRUE,
    ];
    $form['add'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => 'add-field-container',
      ],
    ];
    $form['add']['new_storage_type'] = $field_type_options_radios;
    $form['actions']['submit']['#validate'][] = '::validateGroupOrField';
    $form['actions']['submit']['#submit'][] = '::rebuildWithOptions';
  }
  
  /**
   * Adds field types for the selected group to the form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  protected function addFieldOptionsForGroup(array &$form, FormStateInterface $form_state) : void {
    // Field label and field_name.
    $form['new_storage_wrapper'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'field-ui-new-storage-wrapper',
        ],
      ],
    ];
    $form['new_storage_wrapper']['label'] = [
      '#type' => 'textfield',
      '#title' => $this->t('Label'),
      '#size' => 30,
    ];
    $field_prefix = $this->config('field_ui.settings')
      ->get('field_prefix');
    $form['new_storage_wrapper']['field_name'] = [
      '#type' => 'machine_name',
      '#field_prefix' => $field_prefix,
      '#size' => 15,
      '#description' => $this->t('A unique machine-readable name containing letters, numbers, and underscores.'),
      // Calculate characters depending on the length of the field prefix
      // setting. Maximum length is 32.
'#maxlength' => FieldStorageConfig::NAME_MAX_LENGTH - strlen($field_prefix),
      '#machine_name' => [
        'source' => [
          'new_storage_wrapper',
          'label',
        ],
        'exists' => [
          $this,
          'fieldNameExists',
        ],
      ],
      '#required' => FALSE,
    ];
    $form['actions']['submit']['#validate'][] = '::validateFieldType';
    $form['actions']['back'] = [
      '#type' => 'submit',
      '#value' => $this->t('Back'),
      '#submit' => [
        '::startOver',
      ],
    ];
    $field_type_options = $form_state->get('field_type_options');
    $new_storage_type = $form_state->getValue('new_storage_type');
    $form['new_storage_type'] = [
      '#type' => 'value',
      '#value' => $new_storage_type,
    ];
    if (!isset($new_storage_type) || !$field_type_options[$new_storage_type]['display_as_group']) {
      return;
    }
    // Create a wrapper for all the field options to be provided.
    $form['group_field_options_wrapper'] = [
      '#prefix' => '<div id="group-field-options-wrapper" class="group-field-options-wrapper">',
      '#suffix' => '</div>',
    ];
    $form['group_field_options_wrapper']['label'] = [
      '#type' => 'label',
      '#title' => $this->t('Choose an option below'),
      '#required' => TRUE,
    ];
    $form['group_field_options_wrapper']['fields'] = [
      '#type' => 'container',
      '#attributes' => [
        'class' => [
          'group-field-options',
        ],
      ],
    ];
    $unique_definitions = $form_state->get('unique_definitions')[$new_storage_type] ?? [];
    $group_field_options = [];
    foreach ($unique_definitions as $option) {
      $identifier = $option['unique_identifier'];
      // If the field type plugin's annotation defines description as an
      // array, render it as an item_list.
      $description = !is_array($option['description']) ? $option['description'] : [
        '#theme' => 'item_list',
        '#items' => $option['description'],
      ];
      $radio_element = [
        '#type' => 'radio',
        '#theme_wrappers' => [
          'form_element__new_storage_type',
        ],
        '#title' => $option['label'],
        '#description' => $description,
        '#id' => $identifier,
        '#weight' => $option['weight'],
        '#parents' => [
          'group_field_options_wrapper',
        ],
        '#attributes' => [
          'class' => [
            'field-option-radio',
          ],
          'data-once' => 'field-click-to-select',
        ],
        '#wrapper_attributes' => [
          'class' => [
            'js-click-to-select',
            'subfield-option',
          ],
        ],
        '#variant' => 'field-suboption',
        '#return_value' => $identifier,
      ];
      if ($identifier === 'entity_reference') {
        $radio_element['#title'] = 'Other';
        $radio_element['#weight'] = 10;
      }
      $group_field_options[$identifier] = $radio_element;
    }
    uasort($group_field_options, [
      SortArray::class,
      'sortByWeightProperty',
    ]);
    $form['group_field_options_wrapper']['fields'] += $group_field_options;
  }
  
  /**
   * Validates the first step of the form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateGroupOrField(array &$form, FormStateInterface $form_state) {
    if (!$form_state->getValue('new_storage_type')) {
      $form_state->setErrorByName('add', $this->t('You need to select a field type.'));
    }
  }
  
  /**
   * Validates the second step (field storage selection and label) of the form.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateFieldType(array $form, FormStateInterface $form_state) {
    // Missing label.
    if (!$form_state->getValue('label')) {
      $form_state->setErrorByName('label', $this->t('Add new field: you need to provide a label.'));
    }
    // Missing field name.
    if (!$form_state->getValue('field_name')) {
      $form_state->setErrorByName('field_name', $this->t('Add new field: you need to provide a machine name for the field.'));
    }
    else {
      $field_name = $form_state->getValue('field_name');
      // Add the field prefix.
      $field_name = $this->configFactory
        ->get('field_ui.settings')
        ->get('field_prefix') . $field_name;
      $form_state->setValueForElement($form['new_storage_wrapper']['field_name'], $field_name);
    }
    if (isset($form['group_field_options_wrapper']['fields']) && !$form_state->getValue('group_field_options_wrapper')) {
      $form_state->setErrorByName('group_field_options_wrapper', $this->t('You need to choose an option.'));
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state->getValues();
    $entity_type = $this->entityTypeManager
      ->getDefinition($this->entityTypeId);
    $field_storage_type = $values['group_field_options_wrapper'] ?? $values['new_storage_type'];
    $field_name = $values['field_name'];
    $field_values = [
      'entity_type' => $this->entityTypeId,
      'bundle' => $this->bundle,
    ];
    // Check if we're dealing with a preconfigured field.
    if (str_starts_with($field_storage_type, 'field_ui:')) {
      [
        ,
        $field_type,
        $preset_key,
      ] = explode(':', $field_storage_type, 3);
      $default_options = $this->getNewFieldDefaults($field_type, $preset_key);
    }
    else {
      $field_type = $field_storage_type;
      $default_options = [];
    }
    $field_values += [
      $default_options['field_config'] ?? [],
      'field_name' => $field_name,
      'label' => $values['label'],
      // Field translatability should be explicitly enabled by the users.
'translatable' => FALSE,
    ];
    $field_storage_values = [
      $default_options['field_storage_config'] ?? [],
      'field_name' => $field_name,
      'type' => $field_type,
      'entity_type' => $this->entityTypeId,
      'translatable' => $values['translatable'],
    ];
    try {
      $field_storage_entity = $this->entityTypeManager
        ->getStorage('field_storage_config')
        ->create($field_storage_values);
    } catch (\Exception $e) {
      $this->messenger()
        ->addError($this->t('There was a problem creating field %label: @message', [
        '%label' => $values['label'],
        '@message' => $e->getMessage(),
      ]));
      return;
    }
    // Save field and field storage values in tempstore.
    $this->tempStore
      ->set($this->entityTypeId . ':' . $field_name, [
      'field_storage' => $field_storage_entity,
      'field_config_values' => $field_values,
      'default_options' => $default_options,
    ]);
    // Configure next steps in the multi-part form.
    $destinations = [];
    $route_parameters = [
      'entity_type' => $this->entityTypeId,
      'field_name' => $field_name,
    ] + FieldUI::getRouteBundleParameter($entity_type, $this->bundle);
    $destinations[] = [
      'route_name' => "field_ui.field_add_{$this->entityTypeId}",
      'route_parameters' => $route_parameters,
    ];
    $destinations[] = [
      'route_name' => "entity.{$this->entityTypeId}.field_ui_fields",
      'route_parameters' => $route_parameters,
    ];
    $destination = $this->getDestinationArray();
    $destinations[] = $destination['destination'];
    $form_state->setRedirectUrl(FieldUI::getNextDestination($destinations));
    // Store new field information for any additional submit handlers.
    $form_state->set([
      'fields_added',
      '_add_new_field',
    ], $field_name);
  }
  
  /**
   * Get default options from preconfigured options for a new field.
   *
   * @param string $field_name
   *   The machine name of the field.
   * @param string $preset_key
   *   A key in the preconfigured options array for the field.
   *
   * @return array
   *   An array of settings with keys 'field_storage_config', 'field_config',
   *   'entity_form_display', and 'entity_view_display'.
   *
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   *
   * @see \Drupal\Core\Field\PreconfiguredFieldUiOptionsInterface::getPreconfiguredOptions()
   */
  protected function getNewFieldDefaults(string $field_name, string $preset_key) : array {
    $field_type_definition = $this->fieldTypePluginManager
      ->getDefinition($field_name);
    $options = $this->fieldTypePluginManager
      ->getPreconfiguredOptions($field_type_definition['id']);
    $field_options = $options[$preset_key] ?? [];
    $default_options = [];
    // Merge in preconfigured field storage options.
    if (isset($field_options['field_storage_config'])) {
      foreach ([
        'cardinality',
        'settings',
      ] as $key) {
        if (isset($field_options['field_storage_config'][$key])) {
          $default_options['field_storage_config'][$key] = $field_options['field_storage_config'][$key];
        }
      }
    }
    // Merge in preconfigured field options.
    if (isset($field_options['field_config'])) {
      foreach ([
        'required',
        'settings',
      ] as $key) {
        if (isset($field_options['field_config'][$key])) {
          $default_options['field_config'][$key] = $field_options['field_config'][$key];
        }
      }
    }
    // Preconfigured options only apply to the default display modes.
    foreach ([
      'entity_form_display',
      'entity_view_display',
    ] as $key) {
      if (isset($field_options[$key])) {
        $default_options[$key] = [
          'default' => array_intersect_key($field_options[$key], [
            'type' => '',
            'settings' => [],
          ]),
        ];
      }
      else {
        $default_options[$key] = [
          'default' => [],
        ];
      }
    }
    return $default_options;
  }
  
  /**
   * Checks if a field machine name is taken.
   *
   * @param string $value
   *   The machine name, not prefixed.
   * @param array $element
   *   An array containing the structure of the 'field_name' element.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return bool
   *   Whether or not the field machine name is taken.
   */
  public function fieldNameExists($value, $element, FormStateInterface $form_state) {
    // Add the field prefix.
    $field_name = $this->configFactory
      ->get('field_ui.settings')
      ->get('field_prefix') . $value;
    $field_storage_definitions = $this->entityFieldManager
      ->getFieldStorageDefinitions($this->entityTypeId);
    return isset($field_storage_definitions[$field_name]);
  }
  
  /**
   * Submit handler for displaying fields after a group is selected.
   */
  public static function rebuildWithOptions($form, FormStateInterface &$form_state) {
    $form_state->setRebuild();
  }
  
  /**
   * Submit handler for resetting the form.
   */
  public static function startOver($form, FormStateInterface &$form_state) {
    $form_state->unsetValue('new_storage_type');
    $form_state->setRebuild();
  }

}