views.views.inc
27.1 KB
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
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
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
290
291
292
293
294
295
296
297
298
299
300
301
302
303
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
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
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
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
<?php
/**
* @file
* Provide views data that isn't tied to any other module.
*/
use Drupal\Component\Utility\NestedArray;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Entity\Sql\SqlContentEntityStorage;
use Drupal\Core\Render\Markup;
use Drupal\field\FieldConfigInterface;
use Drupal\field\FieldStorageConfigInterface;
use Drupal\system\ActionConfigEntityInterface;
/**
* Implements hook_views_data().
*/
function views_views_data() {
$data['views']['table']['group'] = t('Global');
$data['views']['table']['join'] = array(
// #global is a special flag which allows a table to appear all the time.
'#global' => array(),
);
$data['views']['random'] = array(
'title' => t('Random'),
'help' => t('Randomize the display order.'),
'sort' => array(
'id' => 'random',
),
);
$data['views']['null'] = array(
'title' => t('Null'),
'help' => t('Allow a contextual filter value to be ignored. The query will not be altered by this contextual filter value. Can be used when contextual filter values come from the URL, and a part of the URL needs to be ignored.'),
'argument' => array(
'id' => 'null',
),
);
$data['views']['nothing'] = array(
'title' => t('Custom text'),
'help' => t('Provide custom text or link.'),
'field' => array(
'id' => 'custom',
),
);
$data['views']['counter'] = array(
'title' => t('View result counter'),
'help' => t('Displays the actual position of the view result'),
'field' => array(
'id' => 'counter',
),
);
$data['views']['area'] = array(
'title' => t('Text area'),
'help' => t('Provide markup text for the area.'),
'area' => array(
'id' => 'text',
),
);
$data['views']['area_text_custom'] = array(
'title' => t('Unfiltered text'),
'help' => t('Add unrestricted, custom text or markup. This is similar to the custom text field.'),
'area' => array(
'id' => 'text_custom',
),
);
$data['views']['title'] = array(
'title' => t('Title override'),
'help' => t('Override the default view title for this view. This is useful to display an alternative title when a view is empty.'),
'area' => array(
'id' => 'title',
'sub_type' => 'empty',
),
);
$data['views']['view'] = array(
'title' => t('View area'),
'help' => t('Insert a view inside an area.'),
'area' => array(
'id' => 'view',
),
);
$data['views']['result'] = array(
'title' => t('Result summary'),
'help' => t('Shows result summary, for example the items per page.'),
'area' => array(
'id' => 'result',
),
);
$data['views']['messages'] = array(
'title' => t('Messages'),
'help' => t('Displays messages in an area.'),
'area' => array(
'id' => 'messages',
),
);
$data['views']['http_status_code'] = array(
'title' => t('Response status code'),
'help' => t('Alter the HTTP response status code used by this view, mostly helpful for empty results.'),
'area' => array(
'id' => 'http_status_code',
),
);
$data['views']['combine'] = array(
'title' => t('Combine fields filter'),
'help' => t('Combine two fields together and search by them.'),
'filter' => array(
'id' => 'combine',
),
);
$data['views']['dropbutton'] = array(
'title' => t('Dropbutton'),
'help' => t('Display fields in a dropbutton.'),
'field' => array(
'id' => 'dropbutton',
),
);
// Registers an entity area handler per entity type.
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
// Excludes entity types, which cannot be rendered.
if ($entity_type->hasViewBuilderClass()) {
$label = $entity_type->getLabel();
$data['views']['entity_' . $entity_type_id] = array(
'title' => t('Rendered entity - @label', array('@label' => $label)),
'help' => t('Displays a rendered @label entity in an area.', array('@label' => $label)),
'area' => array(
'entity_type' => $entity_type_id,
'id' => 'entity',
),
);
}
}
// Registers an action bulk form per entity.
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type => $entity_info) {
$actions = array_filter(\Drupal::entityManager()->getStorage('action')->loadMultiple(), function (ActionConfigEntityInterface $action) use ($entity_type) {
return $action->getType() == $entity_type;
});
if (empty($actions)) {
continue;
}
$data[$entity_info->getBaseTable()][$entity_type . '_bulk_form'] = array(
'title' => t('Bulk update'),
'help' => t('Allows users to apply an action to one or more items.'),
'field' => array(
'id' => 'bulk_form',
),
);
}
// Registers views data for the entity itself.
foreach (\Drupal::entityManager()->getDefinitions() as $entity_type_id => $entity_type) {
if ($entity_type->hasHandlerClass('views_data')) {
/** @var \Drupal\views\EntityViewsDataInterface $views_data */
$views_data = \Drupal::entityManager()->getHandler($entity_type_id, 'views_data');
$data = NestedArray::mergeDeep($data, $views_data->getViewsData());
}
}
// Field modules can implement hook_field_views_data() to override the default
// behavior for adding fields.
$module_handler = \Drupal::moduleHandler();
$entity_manager = \Drupal::entityManager();
if ($entity_manager->hasDefinition('field_storage_config')) {
/** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
foreach ($entity_manager->getStorage('field_storage_config')->loadMultiple() as $field_storage) {
if (_views_field_get_entity_type_storage($field_storage)) {
$result = (array) $module_handler->invoke($field_storage->getTypeProvider(), 'field_views_data', array($field_storage));
if (empty($result)) {
$result = views_field_default_views_data($field_storage);
}
$module_handler->alter('field_views_data', $result, $field_storage);
if (is_array($result)) {
$data = NestedArray::mergeDeep($result, $data);
}
}
}
}
return $data;
}
/**
* Implements hook_views_data_alter().
*
* Field modules can implement hook_field_views_data_views_data_alter() to
* alter the views data on a per field basis. This is weirdly named so as
* not to conflict with the \Drupal::moduleHandler()->alter('field_views_data')
* in views_views_data().
*/
function views_views_data_alter(&$data) {
$entity_manager = \Drupal::entityManager();
if (!$entity_manager->hasDefinition('field_storage_config')) {
return;
}
/** @var \Drupal\field\FieldStorageConfigInterface $field_storage */
foreach ($entity_manager->getStorage('field_storage_config')->loadMultiple() as $field_storage) {
if (_views_field_get_entity_type_storage($field_storage)) {
$function = $field_storage->getTypeProvider() . '_field_views_data_views_data_alter';
if (function_exists($function)) {
$function($data, $field_storage);
}
}
}
}
/**
* Determines whether the entity type the field appears in is SQL based.
*
* @param \Drupal\field\FieldStorageConfigInterface $field_storage
* The field storage definition.
*
* @return \Drupal\Core\Entity\Sql\SqlContentEntityStorage
* Returns the entity type storage if supported.
*/
function _views_field_get_entity_type_storage(FieldStorageConfigInterface $field_storage) {
$result = FALSE;
$entity_manager = \Drupal::entityManager();
if ($entity_manager->hasDefinition($field_storage->getTargetEntityTypeId())) {
$storage = $entity_manager->getStorage($field_storage->getTargetEntityTypeId());
$result = $storage instanceof SqlContentEntityStorage ? $storage : FALSE;
}
return $result;
}
/**
* Returns the label of a certain field.
*
* Therefore it looks up in all bundles to find the most used field.
*/
function views_entity_field_label($entity_type, $field_name) {
$label_counter = array();
$all_labels = array();
// Count the amount of fields per label per field storage.
foreach (array_keys(\Drupal::entityManager()->getBundleInfo($entity_type)) as $bundle) {
$bundle_fields = array_filter(\Drupal::entityManager()->getFieldDefinitions($entity_type, $bundle), function ($field_definition) {
return $field_definition instanceof FieldConfigInterface;
});
if (isset($bundle_fields[$field_name])) {
$field = $bundle_fields[$field_name];
$label = $field->getLabel();
$label_counter[$label] = isset($label_counter[$label]) ? ++$label_counter[$label] : 1;
$all_labels[$label] = TRUE;
}
}
if (empty($label_counter)) {
return array($field_name, $all_labels);
}
// Sort the field labels by it most used label and return the most used one.
// If the counts are equal, sort by the label to ensure the result is
// deterministic.
uksort($label_counter, function($a, $b) use ($label_counter) {
if ($label_counter[$a] === $label_counter[$b]) {
return strcmp($a, $b);
}
return $label_counter[$a] > $label_counter[$b] ? -1 : 1;
});
$label_counter = array_keys($label_counter);
return array($label_counter[0], $all_labels);
}
/**
* Default views data implementation for a field.
*
* @param \Drupal\field\FieldStorageConfigInterface $field_storage
* The field definition.
*
* @return array
* The default views data for the field.
*/
function views_field_default_views_data(FieldStorageConfigInterface $field_storage) {
$data = array();
// Check the field type is available.
if (!\Drupal::service('plugin.manager.field.field_type')->hasDefinition($field_storage->getType())) {
return $data;
}
// Check the field storage has fields.
if (!$field_storage->getBundles()) {
return $data;
}
// Check whether the entity type storage is supported.
$storage = _views_field_get_entity_type_storage($field_storage);
if (!$storage) {
return $data;
}
$field_name = $field_storage->getName();
$field_columns = $field_storage->getColumns();
// Grab information about the entity type tables.
// We need to join to both the base table and the data table, if available.
$entity_manager = \Drupal::entityManager();
$entity_type_id = $field_storage->getTargetEntityTypeId();
$entity_type = $entity_manager->getDefinition($entity_type_id);
if (!$base_table = $entity_type->getBaseTable()) {
// We cannot do anything if for some reason there is no base table.
return $data;
}
$entity_tables = array($base_table => $entity_type_id);
// Some entities may not have a data table.
$data_table = $entity_type->getDataTable();
if ($data_table) {
$entity_tables[$data_table] = $entity_type_id;
}
$entity_revision_table = $entity_type->getRevisionTable();
$supports_revisions = $entity_type->hasKey('revision') && $entity_revision_table;
if ($supports_revisions) {
$entity_tables[$entity_revision_table] = $entity_type_id;
$entity_revision_data_table = $entity_type->getRevisionDataTable();
if ($entity_revision_data_table) {
$entity_tables[$entity_revision_data_table] = $entity_type_id;
}
}
// Description of the field tables.
// @todo Generalize this code to make it work with any table layout. See
// https://www.drupal.org/node/2079019.
$table_mapping = $storage->getTableMapping();
$field_tables = array(
EntityStorageInterface::FIELD_LOAD_CURRENT => array(
'table' => $table_mapping->getDedicatedDataTableName($field_storage),
'alias' => "{$entity_type_id}__{$field_name}",
),
);
if ($supports_revisions) {
$field_tables[EntityStorageInterface::FIELD_LOAD_REVISION] = array(
'table' => $table_mapping->getDedicatedRevisionTableName($field_storage),
'alias' => "{$entity_type_id}_revision__{$field_name}",
);
}
// Build the relationships between the field table and the entity tables.
$table_alias = $field_tables[EntityStorageInterface::FIELD_LOAD_CURRENT]['alias'];
if ($data_table) {
// Tell Views how to join to the base table, via the data table.
$data[$table_alias]['table']['join'][$data_table] = array(
'left_field' => $entity_type->getKey('id'),
'field' => 'entity_id',
'extra' => array(
array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
array('left_field' => 'langcode', 'field' => 'langcode'),
),
);
}
else {
// If there is no data table, just join directly.
$data[$table_alias]['table']['join'][$base_table] = array(
'left_field' => $entity_type->getKey('id'),
'field' => 'entity_id',
'extra' => array(
array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
),
);
}
if ($supports_revisions) {
$table_alias = $field_tables[EntityStorageInterface::FIELD_LOAD_REVISION]['alias'];
if ($entity_revision_data_table) {
// Tell Views how to join to the revision table, via the data table.
$data[$table_alias]['table']['join'][$entity_revision_data_table] = array(
'left_field' => $entity_type->getKey('revision'),
'field' => 'revision_id',
'extra' => array(
array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
array('left_field' => 'langcode', 'field' => 'langcode'),
),
);
}
else {
// If there is no data table, just join directly.
$data[$table_alias]['table']['join'][$entity_revision_table] = array(
'left_field' => $entity_type->getKey('revision'),
'field' => 'revision_id',
'extra' => array(
array('field' => 'deleted', 'value' => 0, 'numeric' => TRUE),
),
);
}
}
$group_name = $entity_type->getLabel();
// Get the list of bundles the field appears in.
$bundles_names = $field_storage->getBundles();
// Build the list of additional fields to add to queries.
$add_fields = array('delta', 'langcode', 'bundle');
foreach (array_keys($field_columns) as $column) {
$add_fields[] = $table_mapping->getFieldColumnName($field_storage, $column);
}
// Determine the label to use for the field. We don't have a label available
// at the field level, so we just go through all fields and take the one
// which is used the most frequently.
list($label, $all_labels) = views_entity_field_label($entity_type_id, $field_name);
// Expose data for the field as a whole.
foreach ($field_tables as $type => $table_info) {
$table = $table_info['table'];
$table_alias = $table_info['alias'];
if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) {
$group = $group_name;
$field_alias = $field_name;
}
else {
$group = t('@group (historical data)', array('@group' => $group_name));
$field_alias = $field_name . '-revision_id';
}
$data[$table_alias][$field_alias] = array(
'group' => $group,
'title' => $label,
'title short' => $label,
'help' => t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
);
// Go through and create a list of aliases for all possible combinations of
// entity type + name.
$aliases = array();
$also_known = array();
foreach ($all_labels as $label_name => $true) {
if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) {
if ($label != $label_name) {
$aliases[] = array(
'base' => $base_table,
'group' => $group_name,
'title' => $label_name,
'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)),
);
$also_known[] = t('@group: @field', array('@group' => $group_name, '@field' => $label_name));
}
}
elseif ($supports_revisions && $label != $label_name) {
$aliases[] = array(
'base' => $table,
'group' => t('@group (historical data)', array('@group' => $group_name)),
'title' => $label_name,
'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $label)),
);
$also_known[] = t('@group (historical data): @field', array('@group' => $group_name, '@field' => $label_name));
}
}
if ($aliases) {
$data[$table_alias][$field_alias]['aliases'] = $aliases;
// The $also_known variable contains markup that is HTML escaped and that
// loses safeness when imploded. The help text is used in #description
// and therefore XSS admin filtered by default. Escaped HTML is not
// altered by XSS filtering, therefore it is safe to just concatenate the
// strings. Afterwards we mark the entire string as safe, so it won't be
// escaped, no matter where it is used.
// Considering the dual use of this help data (both as metadata and as
// help text), other patterns such as use of #markup would not be correct
// here.
$data[$table_alias][$field_alias]['help'] = Markup::create($data[$table_alias][$field_alias]['help'] . ' ' . t('Also known as:') . ' ' . implode(', ', $also_known));
}
$keys = array_keys($field_columns);
$real_field = reset($keys);
$data[$table_alias][$field_alias]['field'] = array(
'table' => $table,
'id' => 'field',
'field_name' => $field_name,
'entity_type' => $entity_type_id,
// Provide a real field for group by.
'real field' => $field_alias . '_' . $real_field,
'additional fields' => $add_fields,
// Default the element type to div, let the UI change it if necessary.
'element type' => 'div',
'is revision' => $type == EntityStorageInterface::FIELD_LOAD_REVISION,
);
}
// Expose data for each field property individually.
foreach ($field_columns as $column => $attributes) {
$allow_sort = TRUE;
// Identify likely filters and arguments for each column based on field type.
switch ($attributes['type']) {
case 'int':
case 'mediumint':
case 'tinyint':
case 'bigint':
case 'serial':
case 'numeric':
case 'float':
$filter = 'numeric';
$argument = 'numeric';
$sort = 'standard';
break;
case 'text':
case 'blob':
// It does not make sense to sort by blob or text.
$allow_sort = FALSE;
default:
$filter = 'string';
$argument = 'string';
$sort = 'standard';
break;
}
if (count($field_columns) == 1 || $column == 'value') {
$title = t('@label (@name)', array('@label' => $label, '@name' => $field_name));
$title_short = $label;
}
else {
$title = t('@label (@name:@column)', array('@label' => $label, '@name' => $field_name, '@column' => $column));
$title_short = t('@label:@column', array('@label' => $label, '@column' => $column));
}
// Expose data for the property.
foreach ($field_tables as $type => $table_info) {
$table = $table_info['table'];
$table_alias = $table_info['alias'];
if ($type == EntityStorageInterface::FIELD_LOAD_CURRENT) {
$group = $group_name;
}
else {
$group = t('@group (historical data)', array('@group' => $group_name));
}
$column_real_name = $table_mapping->getFieldColumnName($field_storage, $column);
// Load all the fields from the table by default.
$additional_fields = $table_mapping->getAllColumns($table);
$data[$table_alias][$column_real_name] = array(
'group' => $group,
'title' => $title,
'title short' => $title_short,
'help' => t('Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
);
// Go through and create a list of aliases for all possible combinations of
// entity type + name.
$aliases = array();
$also_known = array();
foreach ($all_labels as $label_name => $true) {
if ($label != $label_name) {
if (count($field_columns) == 1 || $column == 'value') {
$alias_title = t('@label (@name)', array('@label' => $label_name, '@name' => $field_name));
}
else {
$alias_title = t('@label (@name:@column)', array('@label' => $label_name, '@name' => $field_name, '@column' => $column));
}
$aliases[] = array(
'group' => $group_name,
'title' => $alias_title,
'help' => t('This is an alias of @group: @field.', array('@group' => $group_name, '@field' => $title)),
);
$also_known[] = t('@group: @field', array('@group' => $group_name, '@field' => $title));
}
}
if ($aliases) {
$data[$table_alias][$column_real_name]['aliases'] = $aliases;
// The $also_known variable contains markup that is HTML escaped and
// that loses safeness when imploded. The help text is used in
// #description and therefore XSS admin filtered by default. Escaped
// HTML is not altered by XSS filtering, therefore it is safe to just
// concatenate the strings. Afterwards we mark the entire string as
// safe, so it won't be escaped, no matter where it is used.
// Considering the dual use of this help data (both as metadata and as
// help text), other patterns such as use of #markup would not be
// correct here.
$data[$table_alias][$column_real_name]['help'] = Markup::create($data[$table_alias][$column_real_name]['help'] . ' ' . t('Also known as:') . ' ' . implode(', ', $also_known));
}
$data[$table_alias][$column_real_name]['argument'] = array(
'field' => $column_real_name,
'table' => $table,
'id' => $argument,
'additional fields' => $additional_fields,
'field_name' => $field_name,
'entity_type' => $entity_type_id,
'empty field name' => t('- No value -'),
);
$data[$table_alias][$column_real_name]['filter'] = array(
'field' => $column_real_name,
'table' => $table,
'id' => $filter,
'additional fields' => $additional_fields,
'field_name' => $field_name,
'entity_type' => $entity_type_id,
'allow empty' => TRUE,
);
if (!empty($allow_sort)) {
$data[$table_alias][$column_real_name]['sort'] = array(
'field' => $column_real_name,
'table' => $table,
'id' => $sort,
'additional fields' => $additional_fields,
'field_name' => $field_name,
'entity_type' => $entity_type_id,
);
}
// Set click sortable if there is a field definition.
if (isset($data[$table_alias][$field_name]['field'])) {
$data[$table_alias][$field_name]['field']['click sortable'] = $allow_sort;
}
// Expose additional delta column for multiple value fields.
if ($field_storage->isMultiple()) {
$title_delta = t('@label (@name:delta)', array('@label' => $label, '@name' => $field_name));
$title_short_delta = t('@label:delta', array('@label' => $label));
$data[$table_alias]['delta'] = array(
'group' => $group,
'title' => $title_delta,
'title short' => $title_short_delta,
'help' => t('Delta - Appears in: @bundles.', array('@bundles' => implode(', ', $bundles_names))),
);
$data[$table_alias]['delta']['field'] = array(
'id' => 'numeric',
);
$data[$table_alias]['delta']['argument'] = array(
'field' => 'delta',
'table' => $table,
'id' => 'numeric',
'additional fields' => $additional_fields,
'empty field name' => t('- No value -'),
'field_name' => $field_name,
'entity_type' => $entity_type_id,
);
$data[$table_alias]['delta']['filter'] = array(
'field' => 'delta',
'table' => $table,
'id' => 'numeric',
'additional fields' => $additional_fields,
'field_name' => $field_name,
'entity_type' => $entity_type_id,
'allow empty' => TRUE,
);
$data[$table_alias]['delta']['sort'] = array(
'field' => 'delta',
'table' => $table,
'id' => 'standard',
'additional fields' => $additional_fields,
'field_name' => $field_name,
'entity_type' => $entity_type_id,
);
}
}
}
return $data;
}
/**
* Implements hook_field_views_data().
*
* The function implements the hook in behalf of 'core' because it adds a
* relationship and a reverse relationship to entity_reference field type, which
* is provided by core.
*/
function core_field_views_data(FieldStorageConfigInterface $field_storage) {
$data = views_field_default_views_data($field_storage);
// The code below only deals with the Entity reference field type.
if ($field_storage->getType() != 'entity_reference') {
return $data;
}
$entity_manager = \Drupal::entityManager();
$entity_type_id = $field_storage->getTargetEntityTypeId();
/** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
$table_mapping = $entity_manager->getStorage($entity_type_id)->getTableMapping();
foreach ($data as $table_name => $table_data) {
// Add a relationship to the target entity type.
$target_entity_type_id = $field_storage->getSetting('target_type');
$target_entity_type = $entity_manager->getDefinition($target_entity_type_id);
$entity_type_id = $field_storage->getTargetEntityTypeId();
$entity_type = $entity_manager->getDefinition($entity_type_id);
$target_base_table = $target_entity_type->getDataTable() ?: $target_entity_type->getBaseTable();
$field_name = $field_storage->getName();
// Provide a relationship for the entity type with the entity reference
// field.
$args = array(
'@label' => $target_entity_type->getLabel(),
'@field_name' => $field_name,
);
$data[$table_name][$field_name]['relationship'] = array(
'title' => t('@label referenced from @field_name', $args),
'label' => t('@field_name: @label', $args),
'group' => $entity_type->getLabel(),
'help' => t('Appears in: @bundles.', array('@bundles' => implode(', ', $field_storage->getBundles()))),
'id' => 'standard',
'base' => $target_base_table,
'entity type' => $target_entity_type_id,
'base field' => $target_entity_type->getKey('id'),
'relationship field' => $field_name . '_target_id',
);
// Provide a reverse relationship for the entity type that is referenced by
// the field.
$args['@entity'] = $entity_type->getLabel();
$args['@label'] = $target_entity_type->getLowercaseLabel();
$pseudo_field_name = 'reverse__' . $entity_type_id . '__' . $field_name;
$data[$target_base_table][$pseudo_field_name]['relationship'] = array(
'title' => t('@entity using @field_name', $args),
'label' => t('@field_name', array('@field_name' => $field_name)),
'group' => $target_entity_type->getLabel(),
'help' => t('Relate each @entity with a @field_name set to the @label.', $args),
'id' => 'entity_reverse',
'base' => $entity_type->getDataTable() ?: $entity_type->getBaseTable(),
'entity_type' => $entity_type_id,
'base field' => $entity_type->getKey('id'),
'field_name' => $field_name,
'field table' => $table_mapping->getDedicatedDataTableName($field_storage),
'field field' => $field_name . '_target_id',
'join_extra' => array(
array(
'field' => 'deleted',
'value' => 0,
'numeric' => TRUE,
),
),
);
}
return $data;
}