Projet

Général

Profil

Paste
Télécharger (18,6 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / views / modules / field.views.inc @ 13c3c9b4

1
<?php
2

    
3
/**
4
 * @file
5
 * Provide Views data and handlers for field.module.
6
 *
7
 * @ingroup views_module_handlers
8
 */
9

    
10
/**
11
 * Implements hook_views_data().
12
 *
13
 * Field modules can implement hook_field_views_data() to override
14
 * the default behavior for adding fields.
15
 */
16
function field_views_data() {
17
  $data = array();
18
  foreach (field_info_fields() as $field) {
19
    if ($field['storage']['type'] != 'field_sql_storage') {
20
      continue;
21
    }
22

    
23
    $module = $field['module'];
24
    $result = (array) module_invoke($module, 'field_views_data', $field);
25

    
26
    if (empty($result)) {
27
      $result = field_views_field_default_views_data($field);
28
    }
29
    drupal_alter('field_views_data', $result, $field, $module);
30

    
31
    if (is_array($result)) {
32
      $data = drupal_array_merge_deep($result, $data);
33
    }
34
  }
35

    
36
  return $data;
37
}
38

    
39
/**
40
 * Implements hook_views_data_alter().
41
 *
42
 * Field modules can implement hook_field_views_data_views_data_alter() to
43
 * alter the views data on a per field basis. This is weirdly named so as
44
 * not to conflict with the drupal_alter('field_views_data') in
45
 * field_views_data.
46
 */
47
function field_views_data_alter(&$data) {
48
  foreach (field_info_fields() as $field) {
49
    if ($field['storage']['type'] != 'field_sql_storage') {
50
      continue;
51
    }
52

    
53
    $function = $field['module'] . '_field_views_data_views_data_alter';
54
    if (function_exists($function)) {
55
      $function($data, $field);
56
    }
57
  }
58
}
59

    
60
/**
61
 * Returns the label of a certain field.
62
 *
63
 * Therefore it looks up in all bundles to find the most used instance.
64
 */
65
function field_views_field_label($field_name) {
66
  $label_counter = array();
67
  $all_labels = array();
68
  // Count the amount of instances per label per field.
69
  $instances = field_info_instances();
70
  foreach ($instances as $entity_name => $entity_type) {
71
    foreach ($entity_type as $bundle) {
72
      if (isset($bundle[$field_name])) {
73
        $label_counter[$bundle[$field_name]['label']] = isset($label_counter[$bundle[$field_name]['label']]) ? ++$label_counter[$bundle[$field_name]['label']] : 1;
74
        $all_labels[$entity_name][$bundle[$field_name]['label']] = TRUE;
75
      }
76
    }
77
  }
78
  if (empty($label_counter)) {
79
    return array($field_name, $all_labels);
80
  }
81
  // Sort the field lables by it most used label and return the most used one.
82
  arsort($label_counter);
83
  $label_counter = array_keys($label_counter);
84
  return array($label_counter[0], $all_labels);
85
}
86

    
87
/**
88
 * Default views data implementation for a field.
89
 */
90
function field_views_field_default_views_data($field) {
91
  $field_types = field_info_field_types();
92

    
93
  // Check the field module is available.
94
  if (!isset($field_types[$field['type']])) {
95
    return;
96
  }
97

    
98
  $data = array();
99

    
100
  $current_table = _field_sql_storage_tablename($field);
101
  $revision_table = _field_sql_storage_revision_tablename($field);
102

    
103
  // The list of entity:bundle that this field is used in.
104
  $bundles_names = array();
105
  $supports_revisions = FALSE;
106
  $entity_tables = array();
107
  $current_tables = array();
108
  $revision_tables = array();
109
  $groups = array();
110

    
111
  $group_name = count($field['bundles']) > 1 ? t('Field') : NULL;
112

    
113
  // Build the relationships between the field table and the entity tables.
114
  foreach ($field['bundles'] as $entity => $bundles) {
115
    $entity_info = entity_get_info($entity);
116
    $groups[$entity] = $entity_info['label'];
117

    
118
    // Override Node to Content.
119
    if ($groups[$entity] == t('Node')) {
120
      $groups[$entity] = t('Content');
121
    }
122

    
123
    // If only one bundle use this as the default name.
124
    if (empty($group_name)) {
125
      $group_name = $groups[$entity];
126
    }
127

    
128
    $entity_tables[$entity_info['base table']] = $entity;
129
    $current_tables[$entity] = $entity_info['base table'];
130
    if (isset($entity_info['revision table'])) {
131
      $entity_tables[$entity_info['revision table']] = $entity;
132
      $revision_tables[$entity] = $entity_info['revision table'];
133
    }
134

    
135
    $data[$current_table]['table']['join'][$entity_info['base table']] = array(
136
      'left_field' => $entity_info['entity keys']['id'],
137
      'field' => 'entity_id',
138
      'extra' => array(
139
        array('field' => 'entity_type', 'value' => $entity),
140
        array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
141
      ),
142
    );
143

    
144
    if (!empty($entity_info['entity keys']['revision']) && !empty($entity_info['revision table'])) {
145
      $data[$revision_table]['table']['join'][$entity_info['revision table']] = array(
146
        'left_field' => $entity_info['entity keys']['revision'],
147
        'field' => 'revision_id',
148
        'extra' => array(
149
          array('field' => 'entity_type', 'value' => $entity),
150
          array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
151
        ),
152
      );
153

    
154
      $supports_revisions = TRUE;
155
    }
156

    
157
    foreach ($bundles as $bundle) {
158
      $bundles_names[] = t('@entity:@bundle', array('@entity' => $entity, '@bundle' => $bundle));
159
    }
160
  }
161

    
162
  $tables = array();
163
  $tables[FIELD_LOAD_CURRENT] = $current_table;
164
  if ($supports_revisions) {
165
    $tables[FIELD_LOAD_REVISION] = $revision_table;
166
  }
167

    
168
  $add_fields = array('delta', 'language', 'bundle');
169
  foreach ($field['columns'] as $column_name => $attributes) {
170
    $add_fields[] = _field_sql_storage_columnname($field['field_name'], $column_name);
171
  }
172

    
173
  // Note: we don't have a label available here, because we are at the field
174
  // level, not at the instance level. So we just go through all instances
175
  // and take the one which is used the most frequently.
176
  $field_name = $field['field_name'];
177
  list($label, $all_labels) = field_views_field_label($field_name);
178
  foreach ($tables as $type => $table) {
179
    if ($type == FIELD_LOAD_CURRENT) {
180
      $group = $group_name;
181
      $old_column = 'entity_id';
182
      $column = $field['field_name'];
183
    }
184
    else {
185
      $group = t('@group (historical data)', array('@group' => $group_name));
186
      $old_column = 'revision_id';
187
      $column = $field['field_name'] . '-' . $old_column;
188
    }
189

    
190
    $data[$table][$old_column]['field']['moved to'] = array($table, $column);
191
    $data[$table][$column] = array(
192
      'group' => $group,
193
      'title' => $label,
194
      'title short' => $label,
195
      'help' =>  t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
196
    );
197

    
198
    // Go through and create a list of aliases for all possible combinations of
199
    // entity type + name.
200
    $aliases = array();
201
    $also_known = array();
202
    foreach ($all_labels as $entity_name => $labels) {
203
      foreach ($labels as $label_name => $true) {
204
        if ($type == FIELD_LOAD_CURRENT) {
205
          if ($group_name != $groups[$entity_name] || $label != $label_name) {
206
            $aliases[] = array(
207
              'base' => $current_tables[$entity_name],
208
              'group' => $groups[$entity_name],
209
              'title' => $label_name,
210
              'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)),
211
            );
212
          }
213
          $also_known[] = t('@group: @field', array('@group' => $groups[$entity_name], '@field' => $label_name));
214
        }
215
        else {
216
          if ($group_name != $groups[$entity_name] && $label != $label_name && isset($revision_tables[$entity_name])) {
217
            $aliases[] = array(
218
              'base' => $revision_tables[$entity_name],
219
              'group' => t('@group (historical data)', array('@group' => $groups[$entity_name])),
220
              'title' => $label_name,
221
              'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)),
222
            );
223
          }
224
          $also_known[] = t('@group (historical data): @field', array('@group' => $groups[$entity_name], '@field' => $label_name));
225
        }
226
      }
227
    }
228
    if ($aliases) {
229
      $data[$table][$column]['aliases'] = $aliases;
230
      $data[$table][$column]['help'] .= ' ' . t('Also known as: !also.', array('!also' => implode(', ', $also_known)));
231
    }
232

    
233
    $keys = array_keys($field['columns']);
234
    $real_field = reset($keys);
235
    $data[$table][$column]['field'] = array(
236
      'table' => $table,
237
      'handler' => 'views_handler_field_field',
238
      'click sortable' => TRUE,
239
      'field_name' => $field['field_name'],
240
      // Provide a real field for group by.
241
      'real field' => $column . '_' . $real_field,
242
      'additional fields' => $add_fields,
243
      'entity_tables' => $entity_tables,
244
      // Default the element type to div, let the UI change it if necessary.
245
      'element type' => 'div',
246
      'is revision' => $type == FIELD_LOAD_REVISION,
247
    );
248
  }
249

    
250
  foreach ($field['columns'] as $column => $attributes) {
251
    $allow_sort = TRUE;
252

    
253
    // Identify likely filters and arguments for each column based on field type.
254
    switch ($attributes['type']) {
255
      case 'int':
256
      case 'mediumint':
257
      case 'tinyint':
258
      case 'bigint':
259
      case 'serial':
260
      case 'numeric':
261
      case 'float':
262
        $filter = 'views_handler_filter_numeric';
263
        $argument = 'views_handler_argument_numeric';
264
        $sort = 'views_handler_sort';
265
        break;
266
      case 'text':
267
      case 'blob':
268
        // It does not make sense to sort by blob or text.
269
        $allow_sort = FALSE;
270
      default:
271
        $filter = 'views_handler_filter_string';
272
        $argument = 'views_handler_argument_string';
273
        $sort = 'views_handler_sort';
274
        break;
275
    }
276

    
277

    
278
    if (count($field['columns']) == 1 || $column == 'value') {
279
      $title = t('@label (!name)', array('@label' => $label, '!name' => $field['field_name']));
280
      // CCK used the first 10 characters of $label. Probably doesn't matter.
281
      $title_short = $label;
282
    }
283
    else {
284
      $title = t('@label (!name:!column)', array('@label' => $label, '!name' => $field['field_name'], '!column' => $column));
285
      $title_short = t('@label:!column', array('@label' => $label, '!column' => $column));
286
    }
287

    
288
    foreach ($tables as $type => $table) {
289
      if ($type == FIELD_LOAD_CURRENT) {
290
        $group = $group_name;
291
      }
292
      else {
293
        $group = t('@group (historical data)', array('@group' => $group_name));
294
      }
295
      $column_real_name = $field['storage']['details']['sql'][$type][$table][$column];
296

    
297
      // Load all the fields from the table by default.
298
      $additional_fields = array_values($field['storage']['details']['sql'][$type][$table]);
299

    
300
      $data[$table][$column_real_name] = array(
301
        'group' => $group,
302
        'title' => $title,
303
        'title short' => $title_short,
304
        'help' =>  t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
305
      );
306

    
307
      // Go through and create a list of aliases for all possible combinations of
308
      // entity type + name.
309
      $aliases = array();
310
      $also_known = array();
311
      foreach ($all_labels as $entity_name => $labels) {
312
        foreach ($labels as $label_name => $true) {
313
          if ($group_name != $groups[$entity_name] || $label != $label_name) {
314
            if (count($field['columns']) == 1 || $column == 'value') {
315
              $alias_title = t('@label (!name)', array('@label' => $label_name, '!name' => $field['field_name']));
316
              // CCK used the first 10 characters of $label. Probably doesn't matter.
317
            }
318
            else {
319
              $alias_title = t('@label (!name:!column)', array('@label' => $label_name, '!name' => $field['field_name'], '!column' => $column));
320
            }
321
            $aliases[] = array(
322
              'group' => $groups[$entity_name],
323
              'title' => $alias_title,
324
              'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $title)),
325
            );
326
          }
327
          $also_known[] = t('@group: @field', array('@group' => $groups[$entity_name], '@field' => $title));
328
        }
329
      }
330
      if ($aliases) {
331
        $data[$table][$column_real_name]['aliases'] = $aliases;
332
        $data[$table][$column_real_name]['help'] .= ' ' . t('Also known as: !also.', array('!also' => implode(', ', $also_known)));
333
      }
334

    
335
      $data[$table][$column_real_name]['argument'] = array(
336
        'field' => $column_real_name,
337
        'table' => $table,
338
        'handler' => $argument,
339
        'additional fields' => $additional_fields,
340
        'field_name' => $field['field_name'],
341
        'empty field name' => t('- No value -'),
342
      );
343
      $data[$table][$column_real_name]['filter'] = array(
344
        'field' => $column_real_name,
345
        'table' => $table,
346
        'handler' => $filter,
347
        'additional fields' => $additional_fields,
348
        'field_name' => $field['field_name'],
349
        'allow empty' => TRUE,
350
      );
351
      if (!empty($allow_sort)) {
352
        $data[$table][$column_real_name]['sort'] = array(
353
          'field' => $column_real_name,
354
          'table' => $table,
355
          'handler' => $sort,
356
          'additional fields' => $additional_fields,
357
          'field_name' => $field['field_name'],
358
        );
359
      }
360

    
361
      // Expose additional delta column for multiple value fields.
362
      if ($field['cardinality'] > 1 || $field['cardinality'] == FIELD_CARDINALITY_UNLIMITED) {
363
        $title_delta = t('@label (!name:delta)', array('@label' => $label, '!name' => $field['field_name']));
364
        $title_short_delta = t('@label:delta', array('@label' => $label));
365

    
366
        $data[$table]['delta'] = array(
367
          'group' => $group,
368
          'title' => $title_delta,
369
          'title short' => $title_short_delta,
370
          'help' => t('Delta - Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
371
        );
372
        $data[$table]['delta']['field'] = array(
373
          'handler' => 'views_handler_field_numeric',
374
        );
375
        $data[$table]['delta']['argument'] = array(
376
          'field' => 'delta',
377
          'table' => $table,
378
          'handler' => 'views_handler_argument_numeric',
379
          'additional fields' => $additional_fields,
380
          'empty field name' => t('- No value -'),
381
          'field_name' => $field['field_name'],
382
        );
383
        $data[$table]['delta']['filter'] = array(
384
          'field' => 'delta',
385
          'table' => $table,
386
          'handler' => 'views_handler_filter_numeric',
387
          'additional fields' => $additional_fields,
388
          'field_name' => $field['field_name'],
389
          'allow empty' => TRUE,
390
        );
391
        $data[$table]['delta']['sort'] = array(
392
          'field' => 'delta',
393
          'table' => $table,
394
          'handler' => 'views_handler_sort',
395
          'additional fields' => $additional_fields,
396
          'field_name' => $field['field_name'],
397
        );
398
      }
399

    
400
      // Expose additional language column for translatable fields.
401
      if (!empty($field['translatable'])) {
402
        $title_language = t('@label (!name:language)', array('@label' => $label, '!name' => $field['field_name']));
403
        $title_short_language = t('@label:language', array('@label' => $label));
404

    
405
        $data[$table]['language'] = array(
406
          'group' => $group,
407
          'title' => $title_language,
408
          'title short' => $title_short_language,
409
          'help' => t('Language - Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
410
        );
411
        $data[$table]['language']['field'] = array(
412
          'handler' => 'views_handler_field_locale_language',
413
        );
414
        $data[$table]['language']['argument'] = array(
415
          'field' => 'language',
416
          'table' => $table,
417
          'handler' => 'views_handler_argument_locale_language',
418
          'additional fields' => $additional_fields,
419
          'empty field name' => t('<No value>'),
420
          'field_name' => $field['field_name'],
421
        );
422
        $data[$table]['language']['filter'] = array(
423
          'field' => 'language',
424
          'table' => $table,
425
          'handler' => 'views_handler_filter_locale_language',
426
          'additional fields' => $additional_fields,
427
          'field_name' => $field['field_name'],
428
          'allow empty' => TRUE,
429
        );
430
        $data[$table]['language']['sort'] = array(
431
          'field' => 'language',
432
          'table' => $table,
433
          'handler' => 'views_handler_sort',
434
          'additional fields' => $additional_fields,
435
          'field_name' => $field['field_name'],
436
        );
437
      }
438

    
439
      // Expose additional language column for translatable fields.
440
      if (!empty($field['translatable'])) {
441
        $title_language = t('@label (!name:language)', array('@label' => $label, '!name' => $field['field_name']));
442
        $title_short_language = t('@label:language', array('@label' => $label));
443

    
444
        $data[$table]['language'] = array(
445
          'group' => $group,
446
          'title' => $title_language,
447
          'title short' => $title_short_language,
448
          'help' => t('Language - Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
449
        );
450
        $data[$table]['language']['field'] = array(
451
          'handler' => 'views_handler_field_locale_language',
452
        );
453
        $data[$table]['language']['argument'] = array(
454
          'field' => 'language',
455
          'table' => $table,
456
          'handler' => 'views_handler_argument_locale_language',
457
          'additional fields' => $additional_fields,
458
          'empty field name' => t('<No value>'),
459
          'field_name' => $field['field_name'],
460
        );
461
        $data[$table]['language']['filter'] = array(
462
          'field' => 'language',
463
          'table' => $table,
464
          'handler' => 'views_handler_filter_locale_language',
465
          'additional fields' => $additional_fields,
466
          'field_name' => $field['field_name'],
467
          'allow empty' => TRUE,
468
        );
469
        $data[$table]['language']['sort'] = array(
470
          'field' => 'language',
471
          'table' => $table,
472
          'handler' => 'views_handler_sort',
473
          'additional fields' => $additional_fields,
474
          'field_name' => $field['field_name'],
475
        );
476
      }
477
    }
478
  }
479

    
480
  return $data;
481
}
482

    
483
/**
484
 * Have a different filter handler for lists. This should allow to select values of the list.
485
 */
486
function list_field_views_data($field) {
487
  $data = field_views_field_default_views_data($field);
488
  foreach ($data as $table_name => $table_data) {
489
    foreach ($table_data as $field_name => $field_data) {
490
      if (isset($field_data['filter']) && $field_name != 'delta') {
491
        if ($field['type'] == 'list_boolean') {
492
          // Special handler for boolean fields.
493
          $data[$table_name][$field_name]['filter']['handler'] = 'views_handler_filter_field_list_boolean';
494
        }
495
        else {
496
          $data[$table_name][$field_name]['filter']['handler'] = 'views_handler_filter_field_list';
497
        }
498
      }
499
      if (isset($field_data['argument']) && $field_name != 'delta') {
500
        if ($field['type'] == 'list_text') {
501
          $data[$table_name][$field_name]['argument']['handler'] = 'views_handler_argument_field_list_string';
502
        }
503
        else {
504
          $data[$table_name][$field_name]['argument']['handler'] = 'views_handler_argument_field_list';
505
        }
506
      }
507
    }
508
  }
509
  return $data;
510
}