class FieldStorageConfigEditForm

Same name in other branches
  1. 8.9.x core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php \Drupal\field_ui\Form\FieldStorageConfigEditForm
  2. 10 core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php \Drupal\field_ui\Form\FieldStorageConfigEditForm
  3. 11.x core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php \Drupal\field_ui\Form\FieldStorageConfigEditForm

Provides a form for the "field storage" edit page.

@internal

Hierarchy

Expanded class hierarchy of FieldStorageConfigEditForm

File

core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php, line 18

Namespace

Drupal\field_ui\Form
View source
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;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
EntityForm::$moduleHandler protected property The module handler service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 6
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::init protected function Initialize the form state and the entity before the first form build. 3
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 3
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::submitForm public function This is the default entity object builder function. It is called before any
other submit handler to build the new entity object to be used by the
following submit handlers. At this point of the form workflow the entity is
validated and the form state…
Overrides FormInterface::submitForm 20
FieldStorageConfigEditForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
FieldStorageConfigEditForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
FieldStorageConfigEditForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityForm::buildEntity
FieldStorageConfigEditForm::buildForm public function Overrides EntityForm::buildForm
FieldStorageConfigEditForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
FieldStorageConfigEditForm::getCardinalityForm protected function Builds the cardinality form.
FieldStorageConfigEditForm::getEnforcedCardinality protected function Returns the cardinality enforced by the field type.
FieldStorageConfigEditForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
FieldStorageConfigEditForm::save public function Form submission handler for the &#039;save&#039; action. Overrides EntityForm::save
FieldStorageConfigEditForm::validateCardinality public function Validates the cardinality.
FormBase::$configFactory protected property The config factory. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 3
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 105
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 73
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.