You are here

Home » API reference » Zircon Profile 8 » FieldStorageConfigEditForm.php

class FieldStorageConfigEditForm in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php \Drupal\field_ui\Form\FieldStorageConfigEditForm

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

Hierarchy

Expanded class hierarchy of FieldStorageConfigEditForm

File

core/modules/field_ui/src/Form/FieldStorageConfigEditForm.php, line 20
Contains \Drupal\field_ui\Form\FieldStorageConfigEditForm.

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'));
    return $field_config
      ->getFieldStorageDefinition();
  }

  /**
   * {@inheritdoc}
   *
   * @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.', array(
      '%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'] = array(
      '#weight' => -10,
      '#tree' => TRUE,
    );

    // Create an arbitrary entity object, so that we can have an instantiated
    // FieldItem.
    $ids = (object) array(
      '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());

    // Build the configurable field values.
    $cardinality = $this->entity
      ->getCardinality();
    $form['cardinality_container'] = array(
      // Reset #parents so the additional container does not appear.
      '#parents' => array(),
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Allowed number of values'),
      '#attributes' => array(
        'class' => array(
          'container-inline',
          'fieldgroup',
          'form-composite',
        ),
      ),
    );
    $form['cardinality_container']['cardinality'] = array(
      '#type' => 'select',
      '#title' => $this
        ->t('Allowed number of values'),
      '#title_display' => 'invisible',
      '#options' => array(
        'number' => $this
          ->t('Limited'),
        FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED => $this
          ->t('Unlimited'),
      ),
      '#default_value' => $cardinality == FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED : 'number',
    );
    $form['cardinality_container']['cardinality_number'] = array(
      '#type' => 'number',
      '#default_value' => $cardinality != FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED ? $cardinality : 1,
      '#min' => 1,
      '#title' => $this
        ->t('Limit'),
      '#title_display' => 'invisible',
      '#size' => 2,
      '#states' => array(
        'visible' => array(
          ':input[name="cardinality"]' => array(
            'value' => 'number',
          ),
        ),
        'disabled' => array(
          ':input[name="cardinality"]' => array(
            '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;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    // Validate field cardinality.
    if ($form_state
      ->getValue('cardinality') === 'number' && !$form_state
      ->getValue('cardinality_number')) {
      $form_state
        ->setErrorByName('cardinality_number', $this
        ->t('Number of values is required.'));
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildEntity(array $form, FormStateInterface $form_state) {

    // Save field cardinality.
    if ($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();
      drupal_set_message($this
        ->t('Updated field %label field settings.', array(
        '%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) {
      drupal_set_message($this
        ->t('Attempt to update field %label failed: %message.', array(
        '%label' => $field_label,
        '%message' => $e
          ->getMessage(),
      )), 'error');
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
EntityForm::$entityManager Deprecated protected property The entity manager. 7
EntityForm::$entityTypeManager protected property The entity type manager.
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 3
EntityForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId 4
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 9
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. 5
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::setEntityManager public function Sets the entity manager for this form. Overrides EntityFormInterface::setEntityManager
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 18
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::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 'save' action. Overrides EntityForm::save
FieldStorageConfigEditForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
FormBase::$configFactory protected property The config factory. 3
FormBase::$loggerFactory protected property The logger factory.
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 84
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::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.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator protected function Returns the link generator.
LinkGeneratorTrait::l protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator public function Sets the link generator service.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' 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.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator protected function Returns the URL generator service.
UrlGeneratorTrait::redirect protected function Returns a redirect response object for the specified route.
UrlGeneratorTrait::setUrlGenerator public function Sets the URL generator service.
UrlGeneratorTrait::url protected function Generates a URL or path for a specific route based on the given parameters.