DisplayOverview.php 6.06 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Contains \Drupal\field_ui\DisplayOverview.
6 7 8 9
 */

namespace Drupal\field_ui;

10 11 12
use Drupal\Component\Utility\NestedArray;
use Drupal\entity\EntityDisplayBaseInterface;
use Drupal\field\FieldInstanceInterface;
13
use Symfony\Component\DependencyInjection\ContainerInterface;
14 15 16 17

/**
 * Field UI display overview form.
 */
18
class DisplayOverview extends DisplayOverviewBase {
19 20 21 22 23 24

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

31
  /**
32
   * {@inheritdoc}
33
   */
34
  public function getFormId() {
35 36
    return 'field_ui_display_overview_form';
  }
37

38 39 40 41 42 43 44 45 46 47 48
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, array &$form_state, $entity_type = NULL, $bundle = NULL) {
    if ($this->getRequest()->attributes->has('view_mode_name')) {
      $this->mode = $this->getRequest()->attributes->get('view_mode_name');
    }

    return parent::buildForm($form, $form_state, $entity_type, $bundle);
  }

49
  /**
50
   * {@inheritdoc}
51
   */
52 53 54 55 56 57 58 59
  protected function buildFieldRow($field_id, FieldInstanceInterface $instance, EntityDisplayBaseInterface $entity_display, array $form, array &$form_state) {
    $field_row = parent::buildFieldRow($field_id, $instance, $entity_display, $form, $form_state);
    $display_options = $entity_display->getComponent($field_id);

    // Insert the label column.
    $label = array(
      'label' => array(
        '#type' => 'select',
60
        '#title' => $this->t('Label display for @title', array('@title' => $instance->getLabel())),
61 62 63
        '#title_display' => 'invisible',
        '#options' => $this->getFieldLabelOptions(),
        '#default_value' => $display_options ? $display_options['label'] : 'above',
64 65 66
      ),
    );

67 68
    $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);
69

70
    // Update the (invisible) title of the 'plugin' column.
71
    $field_row['plugin']['#title'] = $this->t('Formatter for @title', array('@title' => $instance->getLabel()));
72 73
    if (!empty($field_row['plugin']['settings_edit_form'])) {
      $plugin_type_info = $entity_display->getRenderer($field_id)->getPluginDefinition();
74
      $field_row['plugin']['settings_edit_form']['label']['#markup'] = $this->t('Format settings:') . ' <span class="plugin-name">' . $plugin_type_info['label'] . '</span>';
75 76
    }

77 78
    return $field_row;
  }
79

80 81 82 83 84 85 86 87 88 89 90
  /**
   * {@inheritdoc}
   */
  protected function buildExtraFieldRow($field_id, $extra_field, $entity_display) {
    $extra_field_row = parent::buildExtraFieldRow($field_id, $extra_field, $entity_display);

    // Insert an empty placeholder for the label column.
    $label = array(
      'empty_cell' => array(
        '#markup' => '&nbsp;'
      )
91
    );
92 93
    $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);
94

95
    return $extra_field_row;
96 97 98
  }

  /**
99
   * {@inheritdoc}
100
   */
101 102 103
  protected function getEntityDisplay($mode) {
    return entity_get_display($this->entity_type, $this->bundle, $mode);
  }
104

105 106 107 108 109 110
  /**
   * {@inheritdoc}
   */
  protected function getExtraFields() {
    return field_info_extra_fields($this->entity_type, $this->bundle, 'display');
  }
111

112 113 114 115 116 117 118 119 120 121 122 123
  /**
   * {@inheritdoc}
   */
  protected function getPlugin($instance, $configuration) {
    $plugin = NULL;

    if ($configuration && $configuration['type'] != 'hidden') {
      $plugin = $this->pluginManager->getInstance(array(
        'field_definition' => $instance,
        'view_mode' => $this->mode,
        'configuration' => $configuration
      ));
124
    }
125

126
    return $plugin;
127 128 129
  }

  /**
130
   * {@inheritdoc}
131
   */
132
  protected function getPluginOptions($field_type) {
133
    return parent::getPluginOptions($field_type) + array('hidden' => '- ' . $this->t('Hidden') . ' -');
134
  }
135

136 137 138 139 140 141
  /**
   * {@inheritdoc}
   */
  protected function getDefaultPlugin($field_type) {
    return $this->fieldTypes[$field_type]['default_formatter'];
  }
142

143 144 145 146 147
  /**
   * {@inheritdoc}
   */
  protected function getDisplayModes() {
    return entity_get_view_modes($this->entity_type);
148 149 150
  }

  /**
151
   * {@inheritdoc}
152
   */
153 154
  protected function getDisplayType() {
    return 'entity_display';
155
  }
156

157 158 159 160 161
  /**
   * {@inheritdoc
   */
  protected function getTableHeader() {
    return array(
162 163 164 165 166
      $this->t('Field'),
      $this->t('Weight'),
      $this->t('Parent'),
      $this->t('Label'),
      array('data' => $this->t('Format'), 'colspan' => 3),
167 168
    );
  }
169

170 171 172 173 174 175
  /**
   * {@inheritdoc}
   */
  protected function getOverviewPath($mode) {
    return $this->entityManager->getAdminPath($this->entity_type, $this->bundle) . "/display/$mode";
  }
176

177 178 179 180 181 182 183 184
  /**
   * Returns an array of visibility options for field labels.
   *
   * @return array
   *   An array of visibility options.
   */
  protected function getFieldLabelOptions() {
    return array(
185 186 187
      'above' => $this->t('Above'),
      'inline' => $this->t('Inline'),
      'hidden' => '- ' . $this->t('Hidden') . ' -',
188 189
    );
  }
190

191 192 193 194 195 196 197 198 199 200 201 202
  /**
   * {@inheritdoc}
   */
  protected function alterSettingsForm(array &$settings_form, $plugin, FieldInstanceInterface $instance, array $form, array &$form_state) {
    $context = array(
      'formatter' => $plugin,
      'field' => $instance->getField(),
      'instance' => $instance,
      'view_mode' => $this->mode,
      'form' => $form,
    );
    drupal_alter('field_formatter_settings_form', $settings_form, $form_state, $context);
203
  }
204 205

  /**
206
   * {@inheritdoc}
207
   */
208 209 210 211 212 213 214 215
  protected function alterSettingsSummary(array &$summary, $plugin, FieldInstanceInterface $instance) {
    $context = array(
      'formatter' => $plugin,
      'field' => $instance->getField(),
      'instance' => $instance,
      'view_mode' => $this->mode,
    );
    drupal_alter('field_formatter_settings_summary', $summary, $context);
216 217
  }

218
}