abstract class EntityDisplayFormBase in Drupal 9

Same name and namespace in other branches

8 core/modules/field_ui/src/Form/EntityDisplayFormBase.php \Drupal\field_ui\Form\EntityDisplayFormBase

Base class for EntityDisplay edit forms.

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\Core\Entity\EntityForm implements EntityFormInterface
  - class \Drupal\field_ui\Form\EntityDisplayFormBase

Expanded class hierarchy of EntityDisplayFormBase

File

core/modules/field_ui/src/Form/EntityDisplayFormBase.php, line 22

Namespace

Drupal\field_ui\Form

View source

abstract class EntityDisplayFormBase extends EntityForm {

  /**
   * The display context. Either 'view' or 'form'.
   *
   * @var string
   */
  protected $displayContext;

  /**
   * The widget or formatter plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerBase
   */
  protected $pluginManager;

  /**
   * The entity display repository.
   *
   * @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface
   */
  protected $entityDisplayRepository;

  /**
   * The entity field manager.
   *
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * A list of field types.
   *
   * @var array
   */
  protected $fieldTypes;

  /**
   * The entity being used by this form.
   *
   * @var \Drupal\Core\Entity\Display\EntityDisplayInterface
   */
  protected $entity;

  /**
   * Constructs a new EntityDisplayFormBase.
   *
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type manager.
   * @param \Drupal\Component\Plugin\PluginManagerBase $plugin_manager
   *   The widget or formatter plugin manager.
   * @param \Drupal\Core\Entity\EntityDisplayRepositoryInterface|null $entity_display_repository
   *   (optional) The entity display_repository.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface|null $entity_field_manager
   *   (optional) The entity field manager.
   */
  public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager) {
    $this->fieldTypes = $field_type_manager
      ->getDefinitions();
    $this->pluginManager = $plugin_manager;
    $this->entityDisplayRepository = $entity_display_repository;
    $this->entityFieldManager = $entity_field_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function getEntityFromRouteMatch(RouteMatchInterface $route_match, $entity_type_id) {
    $route_parameters = $route_match
      ->getParameters()
      ->all();
    return $this
      ->getEntityDisplay($route_parameters['entity_type_id'], $route_parameters['bundle'], $route_parameters[$this->displayContext . '_mode_name']);
  }

  /**
   * Get the regions needed to create the overview form.
   *
   * @return array
   *   Example usage:
   *   @code
   *     return array(
   *       'content' => array(
   *         // label for the region.
   *         'title' => $this->t('Content'),
   *         // Indicates if the region is visible in the UI.
   *         'invisible' => TRUE,
   *         // A message to indicate that there is nothing to be displayed in
   *         // the region.
   *         'message' => $this->t('No field is displayed.'),
   *       ),
   *     );
   *   @endcode
   */
  public function getRegions() {
    return [
      'content' => [
        'title' => $this
          ->t('Content'),
        'invisible' => TRUE,
        'message' => $this
          ->t('No field is displayed.'),
      ],
      'hidden' => [
        'title' => $this
          ->t('Disabled', [], [
          'context' => 'Plural',
        ]),
        'message' => $this
          ->t('No field is hidden.'),
      ],
    ];
  }

  /**
   * Returns an associative array of all regions.
   *
   * @return array
   *   An array containing the region options.
   */
  public function getRegionOptions() {
    $options = [];
    foreach ($this
      ->getRegions() as $region => $data) {
      $options[$region] = $data['title'];
    }
    return $options;
  }

  /**
   * Collects the definitions of fields whose display is configurable.
   *
   * @return \Drupal\Core\Field\FieldDefinitionInterface[]
   *   The array of field definitions
   */
  protected function getFieldDefinitions() {
    $context = $this->displayContext;
    return array_filter($this->entityFieldManager
      ->getFieldDefinitions($this->entity
      ->getTargetEntityTypeId(), $this->entity
      ->getTargetBundle()), function (FieldDefinitionInterface $field_definition) use ($context) {
      return $field_definition
        ->isDisplayConfigurable($context);
    });
  }

  /**
   * {@inheritdoc}
   */
  public function form(array $form, FormStateInterface $form_state) {
    $form = parent::form($form, $form_state);
    $field_definitions = $this
      ->getFieldDefinitions();
    $extra_fields = $this
      ->getExtraFields();
    $form += [
      '#entity_type' => $this->entity
        ->getTargetEntityTypeId(),
      '#bundle' => $this->entity
        ->getTargetBundle(),
      '#fields' => array_keys($field_definitions),
      '#extra' => array_keys($extra_fields),
    ];
    if (empty($field_definitions) && empty($extra_fields) && ($route_info = FieldUI::getOverviewRouteInfo($this->entity
      ->getTargetEntityTypeId(), $this->entity
      ->getTargetBundle()))) {
      $this
        ->messenger()
        ->addWarning($this
        ->t('There are no fields yet added. You can add new fields on the <a href=":link">Manage fields</a> page.', [
        ':link' => $route_info
          ->toString(),
      ]));
      return $form;
    }
    $table = [
      '#type' => 'field_ui_table',
      '#header' => $this
        ->getTableHeader(),
      '#regions' => $this
        ->getRegions(),
      '#attributes' => [
        'class' => [
          'field-ui-overview',
        ],
        'id' => 'field-display-overview',
      ],
      '#tabledrag' => [
        [
          'action' => 'order',
          'relationship' => 'sibling',
          'group' => 'field-weight',
        ],
        [
          'action' => 'match',
          'relationship' => 'parent',
          'group' => 'field-parent',
          'subgroup' => 'field-parent',
          'source' => 'field-name',
        ],
        [
          'action' => 'match',
          'relationship' => 'parent',
          'group' => 'field-region',
          'subgroup' => 'field-region',
          'source' => 'field-name',
        ],
      ],
    ];

    // Field rows.
    foreach ($field_definitions as $field_name => $field_definition) {
      $table[$field_name] = $this
        ->buildFieldRow($field_definition, $form, $form_state);
    }

    // Non-field elements.
    foreach ($extra_fields as $field_id => $extra_field) {
      $table[$field_id] = $this
        ->buildExtraFieldRow($field_id, $extra_field);
    }
    $form['fields'] = $table;

    // Custom display settings.
    if ($this->entity
      ->getMode() == 'default') {

      // Only show the settings if there is at least one custom display mode.
      $display_mode_options = $this
        ->getDisplayModeOptions();

      // Unset default option.
      unset($display_mode_options['default']);
      if ($display_mode_options) {
        $form['modes'] = [
          '#type' => 'details',
          '#title' => $this
            ->t('Custom display settings'),
        ];

        // Prepare default values for the 'Custom display settings' checkboxes.
        $default = [];
        if ($enabled_displays = array_filter($this
          ->getDisplayStatuses())) {
          $default = array_keys(array_intersect_key($display_mode_options, $enabled_displays));
        }
        natcasesort($display_mode_options);
        $form['modes']['display_modes_custom'] = [
          '#type' => 'checkboxes',
          '#title' => $this
            ->t('Use custom display settings for the following @display_context modes', [
            '@display_context' => $this->displayContext,
          ]),
          '#options' => $display_mode_options,
          '#default_value' => $default,
        ];

        // Provide link to manage display modes.
        $form['modes']['display_modes_link'] = $this
          ->getDisplayModesLink();
      }
    }

    // In overviews involving nested rows from contributed modules (i.e
    // field_group), the 'plugin type' selects can trigger a series of changes
    // in child rows. The #ajax behavior is therefore not attached directly to
    // the selects, but triggered by the client-side script through a hidden
    // #ajax 'Refresh' button. A hidden 'refresh_rows' input tracks the name of
    // affected rows.
    $form['refresh_rows'] = [
      '#type' => 'hidden',
    ];
    $form['refresh'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Refresh'),
      '#op' => 'refresh_table',
      '#submit' => [
        '::multistepSubmit',
      ],
      '#ajax' => [
        'callback' => '::multistepAjax',
        'wrapper' => 'field-display-overview-wrapper',
        'effect' => 'fade',
        // The button stays hidden, so we hide the Ajax spinner too. Ad-hoc
        // spinners will be added manually by the client-side script.
        'progress' => 'none',
      ],
      '#attributes' => [
        'class' => [
          'visually-hidden',
        ],
      ],
    ];
    $form['actions'] = [
      '#type' => 'actions',
    ];
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#button_type' => 'primary',
      '#value' => $this
        ->t('Save'),
    ];
    $form['#attached']['library'][] = 'field_ui/drupal.field_ui';
    return $form;
  }

  /**
   * Builds the table row structure for a single field.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The field definition.
   * @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.
   *
   * @return array
   *   A table row array.
   */
  protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) {
    $field_name = $field_definition
      ->getName();
    $display_options = $this->entity
      ->getComponent($field_name);
    $label = $field_definition
      ->getLabel();

    // Disable fields without any applicable plugins.
    if (empty($this
      ->getApplicablePluginOptions($field_definition))) {
      $this->entity
        ->removeComponent($field_name)
        ->save();
      $display_options = $this->entity
        ->getComponent($field_name);
    }
    $regions = array_keys($this
      ->getRegions());
    $field_row = [
      '#attributes' => [
        'class' => [
          'draggable',
          'tabledrag-leaf',
        ],
      ],
      '#row_type' => 'field',
      '#region_callback' => [
        $this,
        'getRowRegion',
      ],
      '#js_settings' => [
        'rowHandler' => 'field',
        'defaultPlugin' => $this
          ->getDefaultPlugin($field_definition
          ->getType()),
      ],
      'human_name' => [
        '#plain_text' => $label,
      ],
      'weight' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $label,
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $display_options ? $display_options['weight'] : '0',
        '#size' => 3,
        '#attributes' => [
          'class' => [
            'field-weight',
          ],
        ],
      ],
      'parent_wrapper' => [
        'parent' => [
          '#type' => 'select',
          '#title' => $this
            ->t('Label display for @title', [
            '@title' => $label,
          ]),
          '#title_display' => 'invisible',
          '#options' => array_combine($regions, $regions),
          '#empty_value' => '',
          '#attributes' => [
            'class' => [
              'js-field-parent',
              'field-parent',
            ],
          ],
          '#parents' => [
            'fields',
            $field_name,
            'parent',
          ],
        ],
        'hidden_name' => [
          '#type' => 'hidden',
          '#default_value' => $field_name,
          '#attributes' => [
            'class' => [
              'field-name',
            ],
          ],
        ],
      ],
      'region' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Region for @title', [
          '@title' => $label,
        ]),
        '#title_display' => 'invisible',
        '#options' => $this
          ->getRegionOptions(),
        '#default_value' => $display_options ? $display_options['region'] : 'hidden',
        '#attributes' => [
          'class' => [
            'field-region',
          ],
        ],
      ],
    ];
    $field_row['plugin'] = [
      'type' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Plugin for @title', [
          '@title' => $label,
        ]),
        '#title_display' => 'invisible',
        '#options' => $this
          ->getApplicablePluginOptions($field_definition),
        '#default_value' => $display_options ? $display_options['type'] : 'hidden',
        '#parents' => [
          'fields',
          $field_name,
          'type',
        ],
        '#attributes' => [
          'class' => [
            'field-plugin-type',
          ],
        ],
      ],
      'settings_edit_form' => [],
    ];

    // Get the corresponding plugin object.
    $plugin = $this->entity
      ->getRenderer($field_name);

    // Base button element for the various plugin settings actions.
    $base_button = [
      '#submit' => [
        '::multistepSubmit',
      ],
      '#ajax' => [
        'callback' => '::multistepAjax',
        'wrapper' => 'field-display-overview-wrapper',
        'effect' => 'fade',
      ],
      '#field_name' => $field_name,
    ];
    if ($form_state
      ->get('plugin_settings_edit') == $field_name) {

      // We are currently editing this field's plugin settings. Display the
      // settings form and submit buttons.
      $field_row['plugin']['settings_edit_form'] = [];
      if ($plugin) {

        // Generate the settings form and allow other modules to alter it.
        $settings_form = $plugin
          ->settingsForm($form, $form_state);
        $third_party_settings_form = $this
          ->thirdPartySettingsForm($plugin, $field_definition, $form, $form_state);
        if ($settings_form || $third_party_settings_form) {
          $field_row['plugin']['#cell_attributes'] = [
            'colspan' => 3,
          ];
          $field_row['plugin']['settings_edit_form'] = [
            '#type' => 'container',
            '#attributes' => [
              'class' => [
                'field-plugin-settings-edit-form',
              ],
            ],
            '#parents' => [
              'fields',
              $field_name,
              'settings_edit_form',
            ],
            'label' => [
              '#markup' => $this
                ->t('Plugin settings'),
            ],
            'settings' => $settings_form,
            'third_party_settings' => $third_party_settings_form,
            'actions' => [
              '#type' => 'actions',
              'save_settings' => $base_button + [
                '#type' => 'submit',
                '#button_type' => 'primary',
                '#name' => $field_name . '_plugin_settings_update',
                '#value' => $this
                  ->t('Update'),
                '#op' => 'update',
              ],
              'cancel_settings' => $base_button + [
                '#type' => 'submit',
                '#name' => $field_name . '_plugin_settings_cancel',
                '#value' => $this
                  ->t('Cancel'),
                '#op' => 'cancel',
                // Do not check errors for the 'Cancel' button, but make sure we
                // get the value of the 'plugin type' select.
                '#limit_validation_errors' => [
                  [
                    'fields',
                    $field_name,
                    'type',
                  ],
                ],
              ],
            ],
          ];
          $field_row['#attributes']['class'][] = 'field-plugin-settings-editing';
        }
      }
    }
    else {
      $field_row['settings_summary'] = [];
      $field_row['settings_edit'] = [];
      if ($plugin) {

        // Display a summary of the current plugin settings, and (if the
        // summary is not empty) a button to edit them.
        $summary = $plugin
          ->settingsSummary();

        // Allow other modules to alter the summary.
        $this
          ->alterSettingsSummary($summary, $plugin, $field_definition);
        if (!empty($summary)) {
          $field_row['settings_summary'] = [
            '#type' => 'inline_template',
            '#template' => '<div class="field-plugin-summary">{{ summary|safe_join("<br />") }}</div>',
            '#context' => [
              'summary' => $summary,
            ],
            '#cell_attributes' => [
              'class' => [
                'field-plugin-summary-cell',
              ],
            ],
          ];
        }

        // Check selected plugin settings to display edit link or not.
        $settings_form = $plugin
          ->settingsForm($form, $form_state);
        $third_party_settings_form = $this
          ->thirdPartySettingsForm($plugin, $field_definition, $form, $form_state);
        if (!empty($settings_form) || !empty($third_party_settings_form)) {
          $field_row['settings_edit'] = $base_button + [
            '#type' => 'image_button',
            '#name' => $field_name . '_settings_edit',
            '#src' => 'core/misc/icons/787878/cog.svg',
            '#attributes' => [
              'class' => [
                'field-plugin-settings-edit',
              ],
              'alt' => $this
                ->t('Edit'),
            ],
            '#op' => 'edit',
            // Do not check errors for the 'Edit' button, but make sure we get
            // the value of the 'plugin type' select.
            '#limit_validation_errors' => [
              [
                'fields',
                $field_name,
                'type',
              ],
            ],
            '#prefix' => '<div class="field-plugin-settings-edit-wrapper">',
            '#suffix' => '</div>',
          ];
        }
      }
    }
    return $field_row;
  }

  /**
   * Builds the table row structure for a single extra field.
   *
   * @param string $field_id
   *   The field ID.
   * @param array $extra_field
   *   The pseudo-field element.
   *
   * @return array
   *   A table row array.
   */
  protected function buildExtraFieldRow($field_id, $extra_field) {
    $display_options = $this->entity
      ->getComponent($field_id);
    $regions = array_keys($this
      ->getRegions());
    $extra_field_row = [
      '#attributes' => [
        'class' => [
          'draggable',
          'tabledrag-leaf',
        ],
      ],
      '#row_type' => 'extra_field',
      '#region_callback' => [
        $this,
        'getRowRegion',
      ],
      '#js_settings' => [
        'rowHandler' => 'field',
      ],
      'human_name' => [
        '#markup' => $extra_field['label'],
      ],
      'weight' => [
        '#type' => 'textfield',
        '#title' => $this
          ->t('Weight for @title', [
          '@title' => $extra_field['label'],
        ]),
        '#title_display' => 'invisible',
        '#default_value' => $display_options ? $display_options['weight'] : 0,
        '#size' => 3,
        '#attributes' => [
          'class' => [
            'field-weight',
          ],
        ],
      ],
      'parent_wrapper' => [
        'parent' => [
          '#type' => 'select',
          '#title' => $this
            ->t('Parents for @title', [
            '@title' => $extra_field['label'],
          ]),
          '#title_display' => 'invisible',
          '#options' => array_combine($regions, $regions),
          '#empty_value' => '',
          '#attributes' => [
            'class' => [
              'js-field-parent',
              'field-parent',
            ],
          ],
          '#parents' => [
            'fields',
            $field_id,
            'parent',
          ],
        ],
        'hidden_name' => [
          '#type' => 'hidden',
          '#default_value' => $field_id,
          '#attributes' => [
            'class' => [
              'field-name',
            ],
          ],
        ],
      ],
      'region' => [
        '#type' => 'select',
        '#title' => $this
          ->t('Region for @title', [
          '@title' => $extra_field['label'],
        ]),
        '#title_display' => 'invisible',
        '#options' => $this
          ->getRegionOptions(),
        '#default_value' => $display_options ? $display_options['region'] : 'hidden',
        '#attributes' => [
          'class' => [
            'field-region',
          ],
        ],
      ],
      'plugin' => [
        'type' => [
          '#type' => 'hidden',
          '#value' => $display_options ? 'visible' : 'hidden',
          '#parents' => [
            'fields',
            $field_id,
            'type',
          ],
          '#attributes' => [
            'class' => [
              'field-plugin-type',
            ],
          ],
        ],
      ],
      'settings_summary' => [],
      'settings_edit' => [],
    ];
    return $extra_field_row;
  }

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

    // If the main "Save" button was submitted while a field settings subform
    // was being edited, update the new incoming settings when rebuilding the
    // entity, just as if the subform's "Update" button had been submitted.
    if ($edit_field = $form_state
      ->get('plugin_settings_edit')) {
      $form_state
        ->set('plugin_settings_update', $edit_field);
    }
    parent::submitForm($form, $form_state);
    $form_values = $form_state
      ->getValues();

    // Handle the 'display modes' checkboxes if present.
    if ($this->entity
      ->getMode() == 'default' && !empty($form_values['display_modes_custom'])) {
      $display_modes = $this
        ->getDisplayModes();
      $current_statuses = $this
        ->getDisplayStatuses();
      $statuses = [];
      foreach ($form_values['display_modes_custom'] as $mode => $value) {
        if (!empty($value) && empty($current_statuses[$mode])) {

          // If no display exists for the newly enabled view mode, initialize
          // it with those from the 'default' view mode, which were used so
          // far.
          if (!$this->entityTypeManager
            ->getStorage($this->entity
            ->getEntityTypeId())
            ->load($this->entity
            ->getTargetEntityTypeId() . '.' . $this->entity
            ->getTargetBundle() . '.' . $mode)) {
            $display = $this
              ->getEntityDisplay($this->entity
              ->getTargetEntityTypeId(), $this->entity
              ->getTargetBundle(), 'default')
              ->createCopy($mode);
            $display
              ->save();
          }
          $display_mode_label = $display_modes[$mode]['label'];
          $url = $this
            ->getOverviewUrl($mode);
          $this
            ->messenger()
            ->addStatus($this
            ->t('The %display_mode mode now uses custom display settings. You might want to <a href=":url">configure them</a>.', [
            '%display_mode' => $display_mode_label,
            ':url' => $url
              ->toString(),
          ]));
        }
        $statuses[$mode] = !empty($value);
      }
      $this
        ->saveDisplayStatuses($statuses);
    }
    $this
      ->messenger()
      ->addStatus($this
      ->t('Your settings have been saved.'));
  }

  /**
   * {@inheritdoc}
   */
  protected function copyFormValuesToEntity(EntityInterface $entity, array $form, FormStateInterface $form_state) {
    $form_values = $form_state
      ->getValues();
    if ($this->entity instanceof EntityWithPluginCollectionInterface) {

      // Do not manually update values represented by plugin collections.
      $form_values = array_diff_key($form_values, $this->entity
        ->getPluginCollections());
    }

    // Collect data for 'regular' fields.
    foreach ($form['#fields'] as $field_name) {
      $values = $form_values['fields'][$field_name];
      if ($values['region'] == 'hidden') {
        $entity
          ->removeComponent($field_name);
      }
      else {
        $options = $entity
          ->getComponent($field_name);

        // Update field settings only if the submit handler told us to.
        if ($form_state
          ->get('plugin_settings_update') === $field_name) {

          // Only store settings actually used by the selected plugin.
          $default_settings = $this->pluginManager
            ->getDefaultSettings($options['type']);
          $options['settings'] = isset($values['settings_edit_form']['settings']) ? array_intersect_key($values['settings_edit_form']['settings'], $default_settings) : [];
          $options['third_party_settings'] = isset($values['settings_edit_form']['third_party_settings']) ? $values['settings_edit_form']['third_party_settings'] : [];
          $form_state
            ->set('plugin_settings_update', NULL);
        }
        $options['type'] = $values['type'];
        $options['weight'] = $values['weight'];
        $options['region'] = $values['region'];

        // Only formatters have configurable label visibility.
        if (isset($values['label'])) {
          $options['label'] = $values['label'];
        }
        $entity
          ->setComponent($field_name, $options);
      }
    }

    // Collect data for 'extra' fields.
    foreach ($form['#extra'] as $name) {
      if ($form_values['fields'][$name]['region'] == 'hidden') {
        $entity
          ->removeComponent($name);
      }
      else {
        $entity
          ->setComponent($name, [
          'weight' => $form_values['fields'][$name]['weight'],
          'region' => $form_values['fields'][$name]['region'],
        ]);
      }
    }
  }

  /**
   * Form submission handler for multistep buttons.
   */
  public function multistepSubmit($form, FormStateInterface $form_state) {
    $trigger = $form_state
      ->getTriggeringElement();
    $op = $trigger['#op'];
    switch ($op) {
      case 'edit':

        // Store the field whose settings are currently being edited.
        $field_name = $trigger['#field_name'];
        $form_state
          ->set('plugin_settings_edit', $field_name);
        break;
      case 'update':

        // Set the field back to 'non edit' mode, and update $this->entity with
        // the new settings fro the next rebuild.
        $field_name = $trigger['#field_name'];
        $form_state
          ->set('plugin_settings_edit', NULL);
        $form_state
          ->set('plugin_settings_update', $field_name);
        $this->entity = $this
          ->buildEntity($form, $form_state);
        break;
      case 'cancel':

        // Set the field back to 'non edit' mode.
        $form_state
          ->set('plugin_settings_edit', NULL);
        break;
      case 'refresh_table':

        // If the currently edited field is one of the rows to be refreshed, set
        // it back to 'non edit' mode.
        $updated_rows = explode(' ', $form_state
          ->getValue('refresh_rows'));
        $plugin_settings_edit = $form_state
          ->get('plugin_settings_edit');
        if ($plugin_settings_edit && in_array($plugin_settings_edit, $updated_rows)) {
          $form_state
            ->set('plugin_settings_edit', NULL);
        }
        break;
    }
    $form_state
      ->setRebuild();
  }

  /**
   * Ajax handler for multistep buttons.
   */
  public function multistepAjax($form, FormStateInterface $form_state) {
    $trigger = $form_state
      ->getTriggeringElement();
    $op = $trigger['#op'];

    // Pick the elements that need to receive the ajax-new-content effect.
    switch ($op) {
      case 'edit':
        $updated_rows = [
          $trigger['#field_name'],
        ];
        $updated_columns = [
          'plugin',
        ];
        break;
      case 'update':
      case 'cancel':
        $updated_rows = [
          $trigger['#field_name'],
        ];
        $updated_columns = [
          'plugin',
          'settings_summary',
          'settings_edit',
        ];
        break;
      case 'refresh_table':
        $updated_rows = array_values(explode(' ', $form_state
          ->getValue('refresh_rows')));
        $updated_columns = [
          'settings_summary',
          'settings_edit',
        ];
        break;
    }
    foreach ($updated_rows as $name) {
      foreach ($updated_columns as $key) {
        $element =& $form['fields'][$name][$key];
        $element['#prefix'] = '<div class="ajax-new-content">' . (isset($element['#prefix']) ? $element['#prefix'] : '');
        $element['#suffix'] = (isset($element['#suffix']) ? $element['#suffix'] : '') . '</div>';
      }
    }

    // Return the whole table.
    return $form['fields'];
  }

  /**
   * Returns the extra fields of the entity type and bundle used by this form.
   *
   * @return array
   *   An array of extra field info.
   *
   * @see \Drupal\Core\Entity\EntityFieldManagerInterface::getExtraFields()
   */
  protected function getExtraFields() {
    $context = $this->displayContext == 'view' ? 'display' : $this->displayContext;
    $extra_fields = $this->entityFieldManager
      ->getExtraFields($this->entity
      ->getTargetEntityTypeId(), $this->entity
      ->getTargetBundle());
    return isset($extra_fields[$context]) ? $extra_fields[$context] : [];
  }

  /**
   * Returns an entity display object to be used by this form.
   *
   * @param string $entity_type_id
   *   The target entity type ID of the entity display.
   * @param string $bundle
   *   The target bundle of the entity display.
   * @param string $mode
   *   A view or form mode.
   *
   * @return \Drupal\Core\Entity\Display\EntityDisplayInterface
   *   An entity display.
   */
  protected abstract function getEntityDisplay($entity_type_id, $bundle, $mode);

  /**
   * Returns an array of applicable widget or formatter options for a field.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The field definition.
   *
   * @return array
   *   An array of applicable widget or formatter options.
   */
  protected function getApplicablePluginOptions(FieldDefinitionInterface $field_definition) {
    $options = $this->pluginManager
      ->getOptions($field_definition
      ->getType());
    $applicable_options = [];
    foreach ($options as $option => $label) {
      $plugin_class = DefaultFactory::getPluginClass($option, $this->pluginManager
        ->getDefinition($option));
      if ($plugin_class::isApplicable($field_definition)) {
        $applicable_options[$option] = $label;
      }
    }
    return $applicable_options;
  }

  /**
   * Returns the ID of the default widget or formatter plugin for a field type.
   *
   * @param string $field_type
   *   The field type.
   *
   * @return string
   *   The widget or formatter plugin ID.
   */
  protected abstract function getDefaultPlugin($field_type);

  /**
   * Returns the form or view modes used by this form.
   *
   * @return array
   *   An array of form or view mode info.
   */
  protected abstract function getDisplayModes();

  /**
   * Returns an array of form or view mode options.
   *
   * @return array
   *   An array of form or view mode options.
   */
  protected abstract function getDisplayModeOptions();

  /**
   * Returns a link to the form or view mode admin page.
   *
   * @return array
   *   An array of a form element to be rendered as a link.
   */
  protected abstract function getDisplayModesLink();

  /**
   * Returns the region to which a row in the display overview belongs.
   *
   * @param array $row
   *   The row element.
   *
   * @return string|null
   *   The region name this row belongs to.
   */
  public function getRowRegion(&$row) {
    $regions = $this
      ->getRegions();
    if (!isset($regions[$row['region']['#value']])) {
      $row['region']['#value'] = 'hidden';
    }
    return $row['region']['#value'];
  }

  /**
   * Returns entity (form) displays for the current entity display type.
   *
   * @return \Drupal\Core\Entity\Display\EntityDisplayInterface[]
   *   An array holding entity displays or entity form displays.
   */
  protected function getDisplays() {
    $load_ids = [];
    $display_entity_type = $this->entity
      ->getEntityTypeId();
    $entity_type = $this->entityTypeManager
      ->getDefinition($display_entity_type);
    $config_prefix = $entity_type
      ->getConfigPrefix();
    $ids = $this
      ->configFactory()
      ->listAll($config_prefix . '.' . $this->entity
      ->getTargetEntityTypeId() . '.' . $this->entity
      ->getTargetBundle() . '.');
    foreach ($ids as $id) {
      $config_id = str_replace($config_prefix . '.', '', $id);
      list(, , $display_mode) = explode('.', $config_id);
      if ($display_mode != 'default') {
        $load_ids[] = $config_id;
      }
    }
    return $this->entityTypeManager
      ->getStorage($display_entity_type)
      ->loadMultiple($load_ids);
  }

  /**
   * Returns form or view modes statuses for the bundle used by this form.
   *
   * @return array
   *   An array of form or view mode statuses.
   */
  protected function getDisplayStatuses() {
    $display_statuses = [];
    $displays = $this
      ->getDisplays();
    foreach ($displays as $display) {
      $display_statuses[$display
        ->get('mode')] = $display
        ->status();
    }
    return $display_statuses;
  }

  /**
   * Saves the updated display mode statuses.
   *
   * @param array $display_statuses
   *   An array holding updated form or view mode statuses.
   */
  protected function saveDisplayStatuses($display_statuses) {
    $displays = $this
      ->getDisplays();
    foreach ($displays as $display) {

      // Only update the display if the status is changing.
      $new_status = $display_statuses[$display
        ->get('mode')];
      if ($new_status !== $display
        ->status()) {
        $display
          ->set('status', $new_status);
        $display
          ->save();
      }
    }
  }

  /**
   * Returns an array containing the table headers.
   *
   * @return array
   *   The table header.
   */
  protected abstract function getTableHeader();

  /**
   * Returns the Url object for a specific entity (form) display edit form.
   *
   * @param string $mode
   *   The form or view mode.
   *
   * @return \Drupal\Core\Url
   *   A Url object for the overview route.
   */
  protected abstract function getOverviewUrl($mode);

  /**
   * Adds the widget or formatter third party settings forms.
   *
   * @param \Drupal\Core\Field\PluginSettingsInterface $plugin
   *   The widget or formatter.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The field definition.
   * @param array $form
   *   The (entire) configuration form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The form state.
   *
   * @return array
   *   The widget or formatter third party settings form.
   */
  protected abstract function thirdPartySettingsForm(PluginSettingsInterface $plugin, FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state);

  /**
   * Alters the widget or formatter settings summary.
   *
   * @param array $summary
   *   The widget or formatter settings summary.
   * @param \Drupal\Core\Field\PluginSettingsInterface $plugin
   *   The widget or formatter.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The field definition.
   */
  protected abstract function alterSettingsSummary(array &$summary, PluginSettingsInterface $plugin, FieldDefinitionInterface $field_definition);

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
EntityDisplayFormBase::$displayContext	protected	property	The display context. Either 'view' or 'form'.	2
EntityDisplayFormBase::$entity	protected	property	The entity being used by this form. Overrides EntityForm::$entity	1
EntityDisplayFormBase::$entityDisplayRepository	protected	property	The entity display repository.
EntityDisplayFormBase::$entityFieldManager	protected	property	The entity field manager.
EntityDisplayFormBase::$fieldTypes	protected	property	A list of field types.
EntityDisplayFormBase::$pluginManager	protected	property	The widget or formatter plugin manager.
EntityDisplayFormBase::alterSettingsSummary	abstract protected	function	Alters the widget or formatter settings summary.	2
EntityDisplayFormBase::buildExtraFieldRow	protected	function	Builds the table row structure for a single extra field.	1
EntityDisplayFormBase::buildFieldRow	protected	function	Builds the table row structure for a single field.	2
EntityDisplayFormBase::copyFormValuesToEntity	protected	function	Copies top-level form values to entity properties. Overrides EntityForm::copyFormValuesToEntity	1
EntityDisplayFormBase::form	public	function	Gets the actual form array to be built. Overrides EntityForm::form	1
EntityDisplayFormBase::getApplicablePluginOptions	protected	function	Returns an array of applicable widget or formatter options for a field.
EntityDisplayFormBase::getDefaultPlugin	abstract protected	function	Returns the ID of the default widget or formatter plugin for a field type.	2
EntityDisplayFormBase::getDisplayModeOptions	abstract protected	function	Returns an array of form or view mode options.	2
EntityDisplayFormBase::getDisplayModes	abstract protected	function	Returns the form or view modes used by this form.	2
EntityDisplayFormBase::getDisplayModesLink	abstract protected	function	Returns a link to the form or view mode admin page.	2
EntityDisplayFormBase::getDisplays	protected	function	Returns entity (form) displays for the current entity display type.
EntityDisplayFormBase::getDisplayStatuses	protected	function	Returns form or view modes statuses for the bundle used by this form.
EntityDisplayFormBase::getEntityDisplay	abstract protected	function	Returns an entity display object to be used by this form.	2
EntityDisplayFormBase::getEntityFromRouteMatch	public	function	Determines which entity will be used by this form from a RouteMatch object. Overrides EntityForm::getEntityFromRouteMatch
EntityDisplayFormBase::getExtraFields	protected	function	Returns the extra fields of the entity type and bundle used by this form.
EntityDisplayFormBase::getFieldDefinitions	protected	function	Collects the definitions of fields whose display is configurable.
EntityDisplayFormBase::getOverviewUrl	abstract protected	function	Returns the Url object for a specific entity (form) display edit form.	2
EntityDisplayFormBase::getRegionOptions	public	function	Returns an associative array of all regions.
EntityDisplayFormBase::getRegions	public	function	Get the regions needed to create the overview form.
EntityDisplayFormBase::getRowRegion	public	function	Returns the region to which a row in the display overview belongs.
EntityDisplayFormBase::getTableHeader	abstract protected	function	Returns an array containing the table headers.	2
EntityDisplayFormBase::multistepAjax	public	function	Ajax handler for multistep buttons.
EntityDisplayFormBase::multistepSubmit	public	function	Form submission handler for multistep buttons.
EntityDisplayFormBase::saveDisplayStatuses	protected	function	Saves the updated display mode statuses.
EntityDisplayFormBase::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
EntityDisplayFormBase::thirdPartySettingsForm	abstract protected	function	Adds the widget or formatter third party settings forms.	2
EntityDisplayFormBase::__construct	public	function	Constructs a new EntityDisplayFormBase.	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::actions	protected	function	Returns an array of supported actions for the current entity form.	35
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	3
EntityForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	13
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::save	public	function	Form submission handler for the 'save' action. Overrides EntityFormInterface::save	47
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
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	72
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.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
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.	4
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.

You are here

abstract class EntityDisplayFormBase in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation