You are here

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

class EntityViewDisplayEditForm in Zircon Profile 8

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

Edit form for the EntityViewDisplay entity type.

Hierarchy

Expanded class hierarchy of EntityViewDisplayEditForm

File

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

Namespace

Drupal\field_ui\Form
View source 
class EntityViewDisplayEditForm extends EntityDisplayFormBase {

  /**
   * {@inheritdoc}
   */
  protected $displayContext = 'view';

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.field.field_type'), $container
      ->get('plugin.manager.field.formatter'));
  }

  /**
   * {@inheritdoc}
   */
  protected function buildFieldRow(FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) {
    $field_row = parent::buildFieldRow($field_definition, $form, $form_state);
    $field_name = $field_definition
      ->getName();
    $display_options = $this->entity
      ->getComponent($field_name);

    // Insert the label column.
    $label = array(
      'label' => array(
        '#type' => 'select',
        '#title' => $this
          ->t('Label display for @title', array(
          '@title' => $field_definition
            ->getLabel(),
        )),
        '#title_display' => 'invisible',
        '#options' => $this
          ->getFieldLabelOptions(),
        '#default_value' => $display_options ? $display_options['label'] : 'above',
      ),
    );
    $label_position = array_search('plugin', array_keys($field_row));
    $field_row = array_slice($field_row, 0, $label_position, TRUE) + $label + array_slice($field_row, $label_position, count($field_row) - 1, TRUE);

    // Update the (invisible) title of the 'plugin' column.
    $field_row['plugin']['#title'] = $this
      ->t('Formatter for @title', array(
      '@title' => $field_definition
        ->getLabel(),
    ));
    if (!empty($field_row['plugin']['settings_edit_form']) && ($plugin = $this->entity
      ->getRenderer($field_name))) {
      $plugin_type_info = $plugin
        ->getPluginDefinition();
      $field_row['plugin']['settings_edit_form']['label']['#markup'] = $this
        ->t('Format settings:') . ' <span class="plugin-name">' . $plugin_type_info['label'] . '</span>';
    }
    return $field_row;
  }

  /**
   * {@inheritdoc}
   */
  protected function buildExtraFieldRow($field_id, $extra_field) {
    $extra_field_row = parent::buildExtraFieldRow($field_id, $extra_field);

    // Insert an empty placeholder for the label column.
    $label = array(
      'empty_cell' => array(
        '#markup' => '&nbsp;',
      ),
    );
    $label_position = array_search('plugin', array_keys($extra_field_row));
    $extra_field_row = array_slice($extra_field_row, 0, $label_position, TRUE) + $label + array_slice($extra_field_row, $label_position, count($extra_field_row) - 1, TRUE);
    return $extra_field_row;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEntityDisplay($entity_type_id, $bundle, $mode) {
    return entity_get_display($entity_type_id, $bundle, $mode);
  }

  /**
   * {@inheritdoc}
   */
  protected function getDefaultPlugin($field_type) {
    return isset($this->fieldTypes[$field_type]['default_formatter']) ? $this->fieldTypes[$field_type]['default_formatter'] : NULL;
  }

  /**
   * {@inheritdoc}
   */
  protected function getDisplayModes() {
    return $this->entityManager
      ->getViewModes($this->entity
      ->getTargetEntityTypeId());
  }

  /**
   * {@inheritdoc}
   */
  protected function getDisplayModeOptions() {
    return $this->entityManager
      ->getViewModeOptions($this->entity
      ->getTargetEntityTypeId());
  }

  /**
   * {@inheritdoc}
   */
  protected function getTableHeader() {
    return array(
      $this
        ->t('Field'),
      $this
        ->t('Weight'),
      $this
        ->t('Parent'),
      $this
        ->t('Label'),
      array(
        'data' => $this
          ->t('Format'),
        'colspan' => 3,
      ),
    );
  }

  /**
   * {@inheritdoc}
   */
  protected function getOverviewUrl($mode) {
    $entity_type = $this->entityManager
      ->getDefinition($this->entity
      ->getTargetEntityTypeId());
    return Url::fromRoute('entity.entity_view_display.' . $this->entity
      ->getTargetEntityTypeId() . '.view_mode', [
      'view_mode_name' => $mode,
    ] + FieldUI::getRouteBundleParameter($entity_type, $this->entity
      ->getTargetBundle()));
  }

  /**
   * Returns an array of visibility options for field labels.
   *
   * @return array
   *   An array of visibility options.
   */
  protected function getFieldLabelOptions() {
    return array(
      'above' => $this
        ->t('Above'),
      'inline' => $this
        ->t('Inline'),
      'hidden' => '- ' . $this
        ->t('Hidden') . ' -',
      'visually_hidden' => '- ' . $this
        ->t('Visually Hidden') . ' -',
    );
  }

  /**
   * {@inheritdoc}
   */
  protected function thirdPartySettingsForm(PluginSettingsInterface $plugin, FieldDefinitionInterface $field_definition, array $form, FormStateInterface $form_state) {
    $settings_form = array();

    // Invoke hook_field_formatter_third_party_settings_form(), keying resulting
    // subforms by module name.
    foreach ($this->moduleHandler
      ->getImplementations('field_formatter_third_party_settings_form') as $module) {
      $settings_form[$module] = $this->moduleHandler
        ->invoke($module, 'field_formatter_third_party_settings_form', array(
        $plugin,
        $field_definition,
        $this->entity
          ->getMode(),
        $form,
        $form_state,
      ));
    }
    return $settings_form;
  }

  /**
   * {@inheritdoc}
   */
  protected function alterSettingsSummary(array &$summary, PluginSettingsInterface $plugin, FieldDefinitionInterface $field_definition) {
    $context = array(
      'formatter' => $plugin,
      'field_definition' => $field_definition,
      'view_mode' => $this->entity
        ->getMode(),
    );
    $this->moduleHandler
      ->alter('field_formatter_settings_summary', $summary, $context);
  }

}

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
EntityDisplayFormBase::$entity protected property The entity being used by this form. Overrides EntityForm::$entity
EntityDisplayFormBase::$fieldTypes protected property A list of field types.
EntityDisplayFormBase::$pluginManager protected property The widget or formatter plugin manager.
EntityDisplayFormBase::copyFormValuesToEntity protected function Copies top-level form values to entity properties Overrides EntityForm::copyFormValuesToEntity
EntityDisplayFormBase::form public function Gets the actual form array to be built. Overrides EntityForm::form
EntityDisplayFormBase::getApplicablePluginOptions protected function Returns an array of applicable widget or formatter options for a field.
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::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::getExtraFieldVisibilityOptions protected function Returns an array of visibility options for extra fields.
EntityDisplayFormBase::getFieldDefinitions protected function Collects the definitions of fields whose display is configurable.
EntityDisplayFormBase::getPluginOptions protected function Returns an array of widget or formatter options for a field.
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::multistepAjax public function Ajax handler for multistep buttons.
EntityDisplayFormBase::multistepSubmit public function Form submission handler for multistep buttons.
EntityDisplayFormBase::reduceOrder Deprecated public function Determines the rendering order of an array representing a tree.
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::tablePreRender Deprecated public function Performs pre-render tasks on field_ui_table elements.
EntityDisplayFormBase::__construct public function Constructs a new EntityDisplayFormBase.
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::actions protected function Returns an array of supported actions for the current entity form. 30
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::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::save public function Form submission handler for the 'save' action. Overrides EntityFormInterface::save 36
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
EntityViewDisplayEditForm::$displayContext protected property The display context. Either 'view' or 'form'. Overrides EntityDisplayFormBase::$displayContext
EntityViewDisplayEditForm::alterSettingsSummary protected function Alters the widget or formatter settings summary. Overrides EntityDisplayFormBase::alterSettingsSummary
EntityViewDisplayEditForm::buildExtraFieldRow protected function Builds the table row structure for a single extra field. Overrides EntityDisplayFormBase::buildExtraFieldRow
EntityViewDisplayEditForm::buildFieldRow protected function Builds the table row structure for a single field. Overrides EntityDisplayFormBase::buildFieldRow
EntityViewDisplayEditForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
EntityViewDisplayEditForm::getDefaultPlugin protected function Returns the ID of the default widget or formatter plugin for a field type. Overrides EntityDisplayFormBase::getDefaultPlugin
EntityViewDisplayEditForm::getDisplayModeOptions protected function Returns an array of form or view mode options. Overrides EntityDisplayFormBase::getDisplayModeOptions
EntityViewDisplayEditForm::getDisplayModes protected function Returns the form or view modes used by this form. Overrides EntityDisplayFormBase::getDisplayModes
EntityViewDisplayEditForm::getEntityDisplay protected function Returns an entity display object to be used by this form. Overrides EntityDisplayFormBase::getEntityDisplay
EntityViewDisplayEditForm::getFieldLabelOptions protected function Returns an array of visibility options for field labels.
EntityViewDisplayEditForm::getOverviewUrl protected function Returns the Url object for a specific entity (form) display edit form. Overrides EntityDisplayFormBase::getOverviewUrl
EntityViewDisplayEditForm::getTableHeader protected function Returns an array containing the table headers. Overrides EntityDisplayFormBase::getTableHeader
EntityViewDisplayEditForm::thirdPartySettingsForm protected function Adds the widget or formatter third party settings forms. Overrides EntityDisplayFormBase::thirdPartySettingsForm
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::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.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 64
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.