You are here

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

class FieldConfigEditForm in Zircon Profile 8

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

Provides a form for the field settings form.

Hierarchy

Expanded class hierarchy of FieldConfigEditForm

File

core/modules/field_ui/src/Form/FieldConfigEditForm.php, line 21
Contains \Drupal\field_ui\Form\FieldConfigEditForm.

Namespace

Drupal\field_ui\Form
View source 
class FieldConfigEditForm extends EntityForm {
  use AllowedTagsXssTrait;

  /**
   * The entity being used by this form.
   *
   * @var \Drupal\field\FieldConfigInterface
   */
  protected $entity;

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $field_storage = $this->entity
      ->getFieldStorageDefinition();
    $bundles = $this->entityManager
      ->getBundleInfo($this->entity
      ->getTargetEntityTypeId());
    $form_title = $this
      ->t('%field settings for %bundle', array(
      '%field' => $this->entity
        ->getLabel(),
      '%bundle' => $bundles[$this->entity
        ->getTargetBundle()]['label'],
    ));
    $form['#title'] = $form_title;
    if ($field_storage
      ->isLocked()) {
      $form['locked'] = array(
        '#markup' => $this
          ->t('The field %field is locked and cannot be edited.', array(
          '%field' => $this->entity
            ->getLabel(),
        )),
      );
      return $form;
    }

    // Build the configurable field values.
    $form['label'] = array(
      '#type' => 'textfield',
      '#title' => $this
        ->t('Label'),
      '#default_value' => $this->entity
        ->getLabel() ?: $field_storage
        ->getName(),
      '#required' => TRUE,
      '#weight' => -20,
    );
    $form['description'] = array(
      '#type' => 'textarea',
      '#title' => $this
        ->t('Help text'),
      '#default_value' => $this->entity
        ->getDescription(),
      '#rows' => 5,
      '#description' => $this
        ->t('Instructions to present to the user below this field on the editing form.<br />Allowed HTML tags: @tags', array(
        '@tags' => FieldFilteredMarkup::displayAllowedTags(),
      )) . '<br />' . $this
        ->t('This field supports tokens.'),
      '#weight' => -10,
    );
    $form['required'] = array(
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Required field'),
      '#default_value' => $this->entity
        ->isRequired(),
      '#weight' => -5,
    );

    // Create an arbitrary entity object (used by the 'default value' widget).
    $ids = (object) array(
      'entity_type' => $this->entity
        ->getTargetEntityTypeId(),
      'bundle' => $this->entity
        ->getTargetBundle(),
      'entity_id' => NULL,
    );
    $form['#entity'] = _field_create_entity_from_ids($ids);
    $items = $form['#entity']
      ->get($this->entity
      ->getName());
    $item = $items
      ->first() ?: $items
      ->appendItem();

    // Add field settings for the field type and a container for third party
    // settings that modules can add to via hook_form_FORM_ID_alter().
    $form['settings'] = array(
      '#tree' => TRUE,
      '#weight' => 10,
    );
    $form['settings'] += $item
      ->fieldSettingsForm($form, $form_state);
    $form['third_party_settings'] = array(
      '#tree' => TRUE,
      '#weight' => 11,
    );

    // Add handling for default value.
    if ($element = $items
      ->defaultValuesForm($form, $form_state)) {
      $element = array_merge($element, array(
        '#type' => 'details',
        '#title' => $this
          ->t('Default value'),
        '#open' => TRUE,
        '#tree' => TRUE,
        '#description' => $this
          ->t('The default value for this field, used when creating new content.'),
      ));
      $form['default_value'] = $element;
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    $actions = parent::actions($form, $form_state);
    $actions['submit']['#value'] = $this
      ->t('Save settings');
    if (!$this->entity
      ->isNew()) {
      $target_entity_type = $this->entityManager
        ->getDefinition($this->entity
        ->getTargetEntityTypeId());
      $route_parameters = [
        'field_config' => $this->entity
          ->id(),
      ] + FieldUI::getRouteBundleParameter($target_entity_type, $this->entity
        ->getTargetBundle());
      $url = new Url('entity.field_config.' . $target_entity_type
        ->id() . '_field_delete_form', $route_parameters);
      if ($this
        ->getRequest()->query
        ->has('destination')) {
        $query = $url
          ->getOption('query');
        $query['destination'] = $this
          ->getRequest()->query
          ->get('destination');
        $url
          ->setOption('query', $query);
      }
      $actions['delete'] = array(
        '#type' => 'link',
        '#title' => $this
          ->t('Delete'),
        '#url' => $url,
        '#access' => $this->entity
          ->access('delete'),
        '#attributes' => array(
          'class' => array(
            'button',
            'button--danger',
          ),
        ),
      );
    }
    return $actions;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
    if (isset($form['default_value'])) {
      $item = $form['#entity']
        ->get($this->entity
        ->getName());
      $item
        ->defaultValuesFormValidate($form['default_value'], $form, $form_state);
    }
  }

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

    // Handle the default value.
    $default_value = array();
    if (isset($form['default_value'])) {
      $items = $form['#entity']
        ->get($this->entity
        ->getName());
      $default_value = $items
        ->defaultValuesFormSubmit($form['default_value'], $form, $form_state);
    }
    $this->entity
      ->setDefaultValue($default_value);
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    $this->entity
      ->save();
    drupal_set_message($this
      ->t('Saved %label configuration.', array(
      '%label' => $this->entity
        ->getLabel(),
    )));
    $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($this->entity
        ->getTargetEntityTypeId(), $this->entity
        ->getTargetBundle()));
    }
  }

  /**
   * The _title_callback for the field settings form.
   *
   * @param \Drupal\field\FieldConfigInterface $field_config
   *   The field.
   *
   * @return string
   *   The label of the field.
   */
  public function getTitle(FieldConfigInterface $field_config) {
    return $field_config
      ->label();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AllowedTagsXssTrait::allowedTags public function Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss().
AllowedTagsXssTrait::displayAllowedTags public function Returns a human-readable list of allowed tags for display in help texts.
AllowedTagsXssTrait::fieldFilterXss public function Filters an HTML string to prevent XSS vulnerabilities.
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::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 2
EntityForm::buildForm public function Form constructor. Overrides FormInterface::buildForm 7
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::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 2
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
FieldConfigEditForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
FieldConfigEditForm::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
FieldConfigEditForm::form public function Gets the actual form array to be built. Overrides EntityForm::form
FieldConfigEditForm::getTitle public function The _title_callback for the field settings form.
FieldConfigEditForm::save public function Form submission handler for the 'save' action. Overrides EntityForm::save
FieldConfigEditForm::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 EntityForm::submitForm
FieldConfigEditForm::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.