FieldStorageConfigEditForm.php

<?php

namespace Drupal\field_ui\Form;

use Drupal\Core\Entity\EntityForm;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\field\Entity\FieldConfig;
use Drupal\field_ui\FieldUI;
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;

/**
 * Provides a form for the "field storage" edit page.
 *
 * @internal
 */
class FieldStorageConfigEditForm extends EntityForm {
    
    /**
     * The entity being used by this form.
     *
     * @var \Drupal\field\FieldStorageConfigInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    public function getEntityFromRouteMatch(RouteMatchInterface $route_match, $entity_type_id) {
        // The URL of this entity form contains only the ID of the field_config
        // but we are actually editing a field_storage_config entity.
        $field_config = FieldConfig::load($route_match->getRawParameter('field_config'));
        if (!$field_config) {
            throw new NotFoundHttpException();
        }
        return $field_config->getFieldStorageDefinition();
    }
    
    /**
     * {@inheritdoc}
     *
     * @param array $form
     *   A nested array form elements comprising the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param string $field_config
     *   The ID of the field config whose field storage config is being edited.
     */
    public function buildForm(array $form, FormStateInterface $form_state, $field_config = NULL) {
        if ($field_config) {
            $field = FieldConfig::load($field_config);
            $form_state->set('field_config', $field);
            $form_state->set('entity_type_id', $field->getTargetEntityTypeId());
            $form_state->set('bundle', $field->getTargetBundle());
        }
        return parent::buildForm($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function form(array $form, FormStateInterface $form_state) {
        $form = parent::form($form, $form_state);
        $field_label = $form_state->get('field_config')
            ->label();
        $form['#title'] = $field_label;
        $form['#prefix'] = '<p>' . $this->t('These settings apply to the %field field everywhere it is used. These settings impact the way that data is stored in the database and cannot be changed once data has been created.', [
            '%field' => $field_label,
        ]) . '</p>';
        // See if data already exists for this field.
        // If so, prevent changes to the field settings.
        if ($this->entity
            ->hasData()) {
            $form['#prefix'] = '<div class="messages messages--error">' . $this->t('There is data for this field in the database. The field settings can no longer be changed.') . '</div>' . $form['#prefix'];
        }
        // Add settings provided by the field module. The field module is
        // responsible for not returning settings that cannot be changed if
        // the field already has data.
        $form['settings'] = [
            '#weight' => -10,
            '#tree' => TRUE,
        ];
        // Create an arbitrary entity object, so that we can have an instantiated
        // FieldItem.
        $ids = (object) [
            'entity_type' => $form_state->get('entity_type_id'),
            'bundle' => $form_state->get('bundle'),
            'entity_id' => NULL,
        ];
        $entity = _field_create_entity_from_ids($ids);
        $items = $entity->get($this->entity
            ->getName());
        $item = $items->first() ?: $items->appendItem();
        $form['settings'] += $item->storageSettingsForm($form, $form_state, $this->entity
            ->hasData());
        // Add the cardinality sub-form.
        $form['cardinality_container'] = $this->getCardinalityForm();
        return $form;
    }
    
    /**
     * Builds the cardinality form.
     *
     * @return array
     *   The cardinality form render array.
     */
    protected function getCardinalityForm() {
        $form = [
            // Reset #parents so the additional container does not appear.
'#parents' => [],
            '#type' => 'fieldset',
            '#title' => $this->t('Allowed number of values'),
            '#attributes' => [
                'class' => [
                    'container-inline',
                    'fieldgroup',
                    'form-composite',
                ],
            ],
        ];
        if ($enforced_cardinality = $this->getEnforcedCardinality()) {
            if ($enforced_cardinality === FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
                $markup = $this->t("This field cardinality is set to unlimited and cannot be configured.");
            }
            else {
                $markup = $this->t("This field cardinality is set to @cardinality and cannot be configured.", [
                    '@cardinality' => $enforced_cardinality,
                ]);
            }
            $form['cardinality'] = [
                '#markup' => $markup,
            ];
        }
        else {
            $form['#element_validate'][] = '::validateCardinality';
            $cardinality = $this->entity
                ->getCardinality();
            $form['cardinality'] = [
                '#type' => 'select',
                '#title' => $this->t('Allowed number of values'),
                '#title_display' => 'invisible',
                '#options' => [
                    'number' => $this->t('Limited'),
                    FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED => $this->t('Unlimited'),
                ],
                '#default_value' => $cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED : 'number',
            ];
            $form['cardinality_number'] = [
                '#type' => 'number',
                '#default_value' => $cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? $cardinality : 1,
                '#min' => 1,
                '#title' => $this->t('Limit'),
                '#title_display' => 'invisible',
                '#size' => 2,
                '#states' => [
                    'visible' => [
                        ':input[name="cardinality"]' => [
                            'value' => 'number',
                        ],
                    ],
                    'disabled' => [
                        ':input[name="cardinality"]' => [
                            'value' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
                        ],
                    ],
                ],
            ];
        }
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function actions(array $form, FormStateInterface $form_state) {
        $elements = parent::actions($form, $form_state);
        $elements['submit']['#value'] = $this->t('Save field settings');
        return $elements;
    }
    
    /**
     * Validates the cardinality.
     *
     * @param array $element
     *   The cardinality form render array.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The form state.
     */
    public function validateCardinality(array &$element, FormStateInterface $form_state) {
        $field_storage_definitions = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions($this->entity
            ->getTargetEntityTypeId());
        // Validate field cardinality.
        if ($form_state->getValue('cardinality') === 'number' && !$form_state->getValue('cardinality_number')) {
            $form_state->setError($element['cardinality_number'], $this->t('Number of values is required.'));
        }
        elseif (!$this->entity
            ->isNew() && isset($field_storage_definitions[$this->entity
            ->getName()]) && $form_state->getValue('cardinality') != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED) {
            // Get a count of entities that have a value in a delta higher than the
            // one selected. Deltas start with 0, so the selected value does not
            // need to be incremented.
            $entities_with_higher_delta = \Drupal::entityQuery($this->entity
                ->getTargetEntityTypeId())
                ->accessCheck(FALSE)
                ->condition($this->entity
                ->getName() . '.%delta', $form_state->getValue('cardinality'))
                ->count()
                ->execute();
            if ($entities_with_higher_delta) {
                $form_state->setError($element['cardinality_number'], $this->formatPlural($entities_with_higher_delta, 'There is @count entity with @delta or more values in this field.', 'There are @count entities with @delta or more values in this field.', [
                    '@delta' => $form_state->getValue('cardinality') + 1,
                ]));
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildEntity(array $form, FormStateInterface $form_state) {
        // Save field cardinality.
        if (!$this->getEnforcedCardinality() && $form_state->getValue('cardinality') === 'number' && $form_state->getValue('cardinality_number')) {
            $form_state->setValue('cardinality', $form_state->getValue('cardinality_number'));
        }
        return parent::buildEntity($form, $form_state);
    }
    
    /**
     * {@inheritdoc}
     */
    public function save(array $form, FormStateInterface $form_state) {
        $field_label = $form_state->get('field_config')
            ->label();
        try {
            $this->entity
                ->save();
            $this->messenger()
                ->addStatus($this->t('Updated field %label field settings.', [
                '%label' => $field_label,
            ]));
            $request = $this->getRequest();
            if (($destinations = $request->query
                ->get('destinations')) && ($next_destination = FieldUI::getNextDestination($destinations))) {
                $request->query
                    ->remove('destinations');
                $form_state->setRedirectUrl($next_destination);
            }
            else {
                $form_state->setRedirectUrl(FieldUI::getOverviewRouteInfo($form_state->get('entity_type_id'), $form_state->get('bundle')));
            }
        } catch (\Exception $e) {
            $this->messenger()
                ->addStatus($this->t('Attempt to update field %label failed: %message.', [
                '%label' => $field_label,
                '%message' => $e->getMessage(),
            ]));
        }
    }
    
    /**
     * Returns the cardinality enforced by the field type.
     *
     * Some field types choose to enforce a fixed cardinality. This method
     * returns that cardinality or NULL if no cardinality has been enforced.
     *
     * @return int|null
     */
    protected function getEnforcedCardinality() {
        
        /** @var \Drupal\Core\Field\FieldTypePluginManager $field_type_manager */
        $field_type_manager = \Drupal::service('plugin.manager.field.field_type');
        $definition = $field_type_manager->getDefinition($this->entity
            ->getType());
        return $definition['cardinality'] ?? NULL;
    }

}