Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
<?php
/**
* @file
* Definition of Drupal\field_ui\DisplayOverview.
*/
namespace Drupal\field_ui;
use Drupal\field_ui\OverviewBase;
/**
* Field UI display overview form.
*/
class DisplayOverview extends OverviewBase {
/**
* Implements Drupal\field_ui\OverviewBase::getRegions().
*/
public function getRegions() {
return array(
'content' => array(
'title' => t('Content'),
'invisible' => TRUE,
'message' => t('No field is displayed.')
),
'hidden' => array(
'title' => t('Disabled'),
'message' => t('No field is hidden.')
),
);
}
/**
* Overrides Drupal\field_ui\OverviewBase::form().
*
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
* A reference to a keyed array containing the current state of the form.
*
* @return array
* The array containing the complete form.
*/
public function form(array $form, array &$form_state) {
$form = parent::form($form, $form_state);
// Gather type information.
$instances = field_info_instances($this->entity_type, $this->bundle);
$field_types = field_info_field_types();
$extra_fields = field_info_extra_fields($this->entity_type, $this->bundle, 'display');
$form_state += array(
'formatter_settings_edit' => NULL,
);
$form += array(
'#entity_type' => $this->entity_type,
'#bundle' => $this->bundle,
'#view_mode' => $this->view_mode,
'#fields' => array_keys($instances),
'#extra' => array_keys($extra_fields),
);
if (empty($instances) && empty($extra_fields)) {
drupal_set_message(t('There are no fields yet added. You can add new fields on the <a href="@link">Manage fields</a> page.', array('@link' => url($this->adminPath . '/fields'))), 'warning');
return $form;
}
$table = array(
'#type' => 'field_ui_table',
'#tree' => TRUE,
'#header' => array(
t('Field'),
t('Weight'),
t('Parent'),
t('Label'),
array('data' => t('Format'), 'colspan' => 3),
),
'#regions' => $this->getRegions(),
'#parent_options' => drupal_map_assoc(array_keys($this->getRegions())),
'#attributes' => array(
'class' => array('field-ui-overview'),
'id' => 'field-display-overview',
),
// Add Ajax wrapper.
'#prefix' => '<div id="field-display-overview-wrapper">',
'#suffix' => '</div>',
);
$field_label_options = array(
'above' => t('Above'),
'inline' => t('Inline'),
'hidden' => t('<Hidden>'),
);
$extra_visibility_options = array(
'content' => t('Visible'),
'hidden' => t('Hidden'),
);
// Field rows.
foreach ($instances as $name => $instance) {
$field = field_info_field($instance['field_name']);
if (isset($instance['display'][$this->view_mode])) {
$display = $instance['display'][$this->view_mode];
}
else {
$display = array(
'type' => 'hidden',
'label' => 'above',
'weight' => 0,
);
}
catch
committed
$table[$name] = array(
'#attributes' => array('class' => array('draggable', 'tabledrag-leaf')),
'#row_type' => 'field',
'#region_callback' => 'field_ui_display_overview_row_region',
'#js_settings' => array(
'rowHandler' => 'field',
'defaultFormatter' => $field_types[$field['type']]['default_formatter'],
),
'human_name' => array(
'#markup' => check_plain($instance['label']),
),
'weight' => array(
'#type' => 'textfield',
'#title' => t('Weight for @title', array('@title' => $instance['label'])),
'#title_display' => 'invisible',
'#default_value' => $display['weight'],
'#size' => 3,
'#attributes' => array('class' => array('field-weight')),
),
'parent_wrapper' => array(
'parent' => array(
'#type' => 'select',
'#title' => t('Label display for @title', array('@title' => $instance['label'])),
'#title_display' => 'invisible',
'#options' => $table['#parent_options'],
'#empty_value' => '',
'#attributes' => array('class' => array('field-parent')),
'#parents' => array('fields', $name, 'parent'),
),
'hidden_name' => array(
'#type' => 'hidden',
'#default_value' => $name,
'#attributes' => array('class' => array('field-name')),
),
),
'label' => array(
'#type' => 'select',
'#title' => t('Label display for @title', array('@title' => $instance['label'])),
'#title_display' => 'invisible',
'#options' => $field_label_options,
'#default_value' => $display['label'],
),
);
$formatter_options = field_ui_formatter_options($field['type']);
$formatter_options['hidden'] = t('<Hidden>');
$table[$name]['format'] = array(
'type' => array(
'#type' => 'select',
'#title' => t('Formatter for @title', array('@title' => $instance['label'])),
'#title_display' => 'invisible',
'#options' => $formatter_options,
'#default_value' => $display['type'],
'#parents' => array('fields', $name, 'type'),
'#attributes' => array('class' => array('field-formatter-type')),
),
'settings_edit_form' => array(),
);
// Check the currently selected formatter, and merge persisted values for
// formatter settings.
if (isset($form_state['values']['fields'][$name]['type'])) {
$display['type'] = $form_state['values']['fields'][$name]['type'];
}
if (isset($form_state['formatter_settings'][$name])) {
$display['settings'] = $form_state['formatter_settings'][$name];
$formatter = $instance->getFormatter($display);
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
// Base button element for the various formatter settings actions.
$base_button = array(
'#submit' => array(array($this, 'multistepSubmit')),
'#ajax' => array(
'callback' => array($this, 'multistepAjax'),
'wrapper' => 'field-display-overview-wrapper',
'effect' => 'fade',
),
'#field_name' => $name,
);
if ($form_state['formatter_settings_edit'] == $name) {
// We are currently editing this field's formatter settings. Display the
// settings form and submit buttons.
$table[$name]['format']['settings_edit_form'] = array();
if ($formatter) {
$formatter_type_info = $formatter->getDefinition();
// Generate the settings form and allow other modules to alter it.
$settings_form = $formatter->settingsForm($form, $form_state);
$context = array(
'formatter' => $formatter,
'field' => $field,
'instance' => $instance,
'view_mode' => $this->view_mode,
'form' => $form,
);
drupal_alter('field_formatter_settings_form', $settings_form, $form_state, $context);
if ($settings_form) {
$table[$name]['format']['#cell_attributes'] = array('colspan' => 3);
$table[$name]['format']['settings_edit_form'] = array(
'#type' => 'container',
'#attributes' => array('class' => array('field-formatter-settings-edit-form')),
'#parents' => array('fields', $name, 'settings_edit_form'),
'label' => array(
'#markup' => t('Format settings:') . ' <span class="formatter-name">' . $formatter_type_info['label'] . '</span>',
),
'settings' => $settings_form,
'actions' => array(
'#type' => 'actions',
'save_settings' => $base_button + array(
'#type' => 'submit',
'#name' => $name . '_formatter_settings_update',
'#value' => t('Update'),
'#op' => 'update',
),
'cancel_settings' => $base_button + array(
'#type' => 'submit',
'#name' => $name . '_formatter_settings_cancel',
'#value' => t('Cancel'),
'#op' => 'cancel',
// Do not check errors for the 'Cancel' button, but make sure we
// get the value of the 'formatter type' select.
'#limit_validation_errors' => array(array('fields', $name, 'type')),
),
),
);
$table[$name]['#attributes']['class'][] = 'field-formatter-settings-editing';
}
}
}
else {
$table[$name]['settings_summary'] = array();
$table[$name]['settings_edit'] = array();
if ($formatter) {
// Display a summary of the current formatter settings, and (if the
// summary is not empty) a button to edit them.
$summary = $formatter->settingsSummary();
// Allow other modules to alter the summary.
$context = array(
'formatter' => $formatter,
'field' => $field,
'instance' => $instance,
'view_mode' => $this->view_mode,
);
drupal_alter('field_formatter_settings_summary', $summary, $context);
if ($summary) {
$table[$name]['settings_summary'] = array(
'#markup' => '<div class="field-formatter-summary">' . $summary . '</div>',
'#cell_attributes' => array('class' => array('field-formatter-summary-cell')),
);
$table[$name]['settings_edit'] = $base_button + array(
'#type' => 'image_button',
'#name' => $name . '_formatter_settings_edit',
'#src' => 'core/misc/configure-dark.png',
'#attributes' => array('class' => array('field-formatter-settings-edit'), 'alt' => t('Edit')),
'#op' => 'edit',
// Do not check errors for the 'Edit' button, but make sure we get
// the value of the 'formatter type' select.
'#limit_validation_errors' => array(array('fields', $name, 'type')),
'#prefix' => '<div class="field-formatter-settings-edit-wrapper">',
'#suffix' => '</div>',
);
}
}
}
}
// Non-field elements.
foreach ($extra_fields as $name => $extra_field) {
$display = $extra_field['display'][$this->view_mode];
$table[$name] = array(
'#attributes' => array('class' => array('draggable', 'tabledrag-leaf')),
'#row_type' => 'extra_field',
'#region_callback' => 'field_ui_display_overview_row_region',
'#js_settings' => array('rowHandler' => 'field'),
'human_name' => array(
'#markup' => check_plain($extra_field['label']),
),
'weight' => array(
'#type' => 'textfield',
'#title' => t('Weight for @title', array('@title' => $extra_field['label'])),
'#title_display' => 'invisible',
'#default_value' => $display['weight'],
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
'#size' => 3,
'#attributes' => array('class' => array('field-weight')),
),
'parent_wrapper' => array(
'parent' => array(
'#type' => 'select',
'#title' => t('Parents for @title', array('@title' => $extra_field['label'])),
'#title_display' => 'invisible',
'#options' => $table['#parent_options'],
'#empty_value' => '',
'#attributes' => array('class' => array('field-parent')),
'#parents' => array('fields', $name, 'parent'),
),
'hidden_name' => array(
'#type' => 'hidden',
'#default_value' => $name,
'#attributes' => array('class' => array('field-name')),
),
),
'empty_cell' => array(
'#markup' => ' ',
),
'format' => array(
'type' => array(
'#type' => 'select',
'#title' => t('Visibility for @title', array('@title' => $extra_field['label'])),
'#title_display' => 'invisible',
'#options' => $extra_visibility_options,
'#default_value' => $display['visible'] ? 'content' : 'hidden',
'#parents' => array('fields', $name, 'type'),
'#attributes' => array('class' => array('field-formatter-type')),
),
),
'settings_summary' => array(),
'settings_edit' => array(),
);
}
$form['fields'] = $table;
// Custom display settings.
if ($this->view_mode == 'default') {
$entity_info = entity_get_info($this->entity_type);
Angie Byron
committed
$view_modes = $entity_info['view_modes'];
// Only show the settings if there is more than one view mode.
if (count($view_modes) > 1) {
$form['modes'] = array(
'#type' => 'details',
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
'#title' => t('Custom display settings'),
'#collapsible' => TRUE,
'#collapsed' => TRUE,
);
// Collect options and default values for the 'Custom display settings'
// checkboxes.
$options = array();
$default = array();
$view_mode_settings = field_view_mode_settings($this->entity_type, $this->bundle);
foreach ($view_modes as $view_mode_name => $view_mode_info) {
$options[$view_mode_name] = $view_mode_info['label'];
if (!empty($view_mode_settings[$view_mode_name]['custom_settings'])) {
$default[] = $view_mode_name;
}
}
$form['modes']['view_modes_custom'] = array(
'#type' => 'checkboxes',
'#title' => t('Use custom display settings for the following view modes'),
'#options' => $options,
'#default_value' => $default,
);
}
}
// In overviews involving nested rows from contributed modules (i.e
// field_group), the 'format 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'] = array('#type' => 'hidden');
$form['refresh'] = array(
'#type' => 'submit',
'#value' => t('Refresh'),
'#op' => 'refresh_table',
'#submit' => array(array($this, 'multistepSubmit')),
'#ajax' => array(
'callback' => array($this, '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' => array('class' => array('element-invisible'))
);
$form['actions'] = array('#type' => 'actions');
$form['actions']['submit'] = array('#type' => 'submit', '#value' => t('Save'));
$form['#attached']['library'][] = array('field_ui', 'drupal.field_ui');
// Add tabledrag behavior.
$form['#attached']['drupal_add_tabledrag'][] = array('field-display-overview', 'order', 'sibling', 'field-weight');
$form['#attached']['drupal_add_tabledrag'][] = array('field-display-overview', 'match', 'parent', 'field-parent', 'field-parent', 'field-name');
return $form;
}
/**
* Overrides Drupal\field_ui\OverviewBase::submit().
*
* @param array $form
* An associative array containing the structure of the form.
* @param array $form_state
* A reference to a keyed array containing the current state of the form.
*/
public function submit(array $form, array &$form_state) {
$form_values = $form_state['values'];
// Save data for 'regular' fields.
foreach ($form['#fields'] as $field_name) {
// Retrieve the stored instance settings to merge with the incoming
// values.
$instance = field_read_instance($this->entity_type, $field_name, $this->bundle);
$values = $form_values['fields'][$field_name];
// Get formatter settings. They lie either directly in submitted form
// values (if the whole form was submitted while some formatter
// settings were being edited), or have been persisted in
// $form_state.
$settings = array();
if (isset($values['settings_edit_form']['settings'])) {
$settings = $values['settings_edit_form']['settings'];
}
elseif (isset($form_state['formatter_settings'][$field_name])) {
$settings = $form_state['formatter_settings'][$field_name];
}
elseif (isset($instance['display'][$this->view_mode]['settings'])) {
$settings = $instance['display'][$this->view_mode]['settings'];
}
// Only save settings actually used by the selected formatter.
$default_settings = field_info_formatter_settings($values['type']);
$settings = array_intersect_key($settings, $default_settings);
$instance['display'][$this->view_mode] = array(
'label' => $values['label'],
'type' => $values['type'],
'weight' => $values['weight'],
'settings' => $settings,
);
field_update_instance($instance);
}
// Get current bundle settings.
$bundle_settings = field_bundle_settings($this->entity_type, $this->bundle);
// Save data for 'extra' fields.
foreach ($form['#extra'] as $name) {
$bundle_settings['extra_fields']['display'][$name][$this->view_mode] = array(
'weight' => $form_values['fields'][$name]['weight'],
'visible' => $form_values['fields'][$name]['type'] == 'content',
);
}
// Save view modes data.
if ($this->view_mode == 'default' && !empty($form_values['view_modes_custom'])) {
$entity_info = entity_get_info($this->entity_type);
foreach ($form_values['view_modes_custom'] as $view_mode_name => $value) {
// Display a message for each view mode newly configured to use custom
// settings.
$view_mode_settings = field_view_mode_settings($this->entity_type, $this->bundle);
if (!empty($value) && empty($view_mode_settings[$view_mode_name]['custom_settings'])) {
$view_mode_label = $entity_info['view_modes'][$view_mode_name]['label'];
$path = field_ui_bundle_admin_path($this->entity_type, $this->bundle) . "/display/$view_mode_name";
drupal_set_message(t('The %view_mode mode now uses custom display settings. You might want to <a href="@url">configure them</a>.', array('%view_mode' => $view_mode_label, '@url' => url($path))));
// Initialize the newly customized view mode with the display settings
// from the default view mode.
_field_ui_add_default_view_mode_settings($this->entity_type, $this->bundle, $view_mode_name, $bundle_settings);
$bundle_settings['view_modes'][$view_mode_name]['custom_settings'] = !empty($value);
// Save updated bundle settings.
field_bundle_settings($this->entity_type, $this->bundle, $bundle_settings);
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
drupal_set_message(t('Your settings have been saved.'));
}
/**
* Form submission handler for multistep buttons.
*/
public function multistepSubmit($form, &$form_state) {
$trigger = $form_state['triggering_element'];
$op = $trigger['#op'];
switch ($op) {
case 'edit':
// Store the field whose settings are currently being edited.
$field_name = $trigger['#field_name'];
$form_state['formatter_settings_edit'] = $field_name;
break;
case 'update':
// Store the saved settings, and set the field back to 'non edit' mode.
$field_name = $trigger['#field_name'];
$values = $form_state['values']['fields'][$field_name]['settings_edit_form']['settings'];
$form_state['formatter_settings'][$field_name] = $values;
unset($form_state['formatter_settings_edit']);
break;
case 'cancel':
// Set the field back to 'non edit' mode.
unset($form_state['formatter_settings_edit']);
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['values']['refresh_rows']);
if (isset($form_state['formatter_settings_edit']) && in_array($form_state['formatter_settings_edit'], $updated_rows)) {
unset($form_state['formatter_settings_edit']);
}
break;
}
$form_state['rebuild'] = TRUE;
}
/**
* Ajax handler for multistep buttons.
*/
public function multistepAjax($form, &$form_state) {
$trigger = $form_state['triggering_element'];
$op = $trigger['#op'];
// Pick the elements that need to receive the ajax-new-content effect.
switch ($op) {
case 'edit':
$updated_rows = array($trigger['#field_name']);
$updated_columns = array('format');
break;
case 'update':
case 'cancel':
$updated_rows = array($trigger['#field_name']);
$updated_columns = array('format', 'settings_summary', 'settings_edit');
break;
case 'refresh_table':
$updated_rows = array_values(explode(' ', $form_state['values']['refresh_rows']));
$updated_columns = array('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'];
}
}