og-8.x-1.x-dev/og.views.inc
og.views.inc
<?php
/**
* @file
* Integration with the Views module.
*/
declare(strict_types=1);
use Drupal\Component\Utility\DeprecationHelper;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\field\FieldStorageConfigInterface;
/**
* Implements hook_views_data_alter().
*/
function og_views_data_alter(array &$data) {
// Add relationship to og_membership from users.
$data['users']['og_membership']['relationship'] = [
'real field' => 'uid',
'base' => 'og_membership',
'base field' => 'uid',
'label' => new TranslatableMarkup('OG Membership'),
'title' => new TranslatableMarkup('OG Membership'),
'id' => 'standard',
];
// Add relationship to og_membership from all group-enabled entities.
/** @var \Drupal\og\GroupTypeManagerInterface $group_type_manager */
$groupTypeManager = \Drupal::service('og.group_type_manager');
$entity_type_manager = \Drupal::entityTypeManager();
foreach (array_keys($groupTypeManager->getGroupMap()) as $entity_type_id) {
$entity_label = $entity_type_manager->getDefinition($entity_type_id)->getLabel();
$data[$entity_type_id]['og_membership_group']['relationship'] = [
'real field' => $entity_type_manager->getDefinition($entity_type_id)->getKey('id'),
'base' => 'og_membership',
'base field' => 'entity_id',
'group' => new TranslatableMarkup('OG membership'),
'title' => new TranslatableMarkup('OG membership for @entity', ['@entity' => $entity_label]),
'id' => 'standard',
'help' => new TranslatableMarkup('Reference OG membership entities tied to this @entity_type group.', ['@entity_type' => $entity_type_id]),
'extra' => [
[
// Join on the entity type.
'field' => 'entity_type',
'value' => $entity_type_id,
],
],
];
}
}
/**
* Implements hook_field_views_data().
*
* This is an almost verbatim copy of core_field_views_data() except for the
* field type check.
*/
function og_field_views_data(FieldStorageConfigInterface $field_storage) {
$data = DeprecationHelper::backwardsCompatibleCall(
currentVersion: \Drupal::VERSION,
deprecatedVersion: '11.2.0',
currentCallable: fn() => \Drupal::service('views.field_data_provider')->defaultFieldImplementation($field_storage),
deprecatedCallable: fn() => views_field_default_views_data($field_storage),
);
// This is the same as entity reference integration as the OG standard
// reference item is no different really.
switch ($field_storage->getType()) {
case 'og_standard_reference':
$entity_type_manager = \Drupal::entityTypeManager();
$entity_type_id = $field_storage->getTargetEntityTypeId();
/** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
$table_mapping = $entity_type_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_type_manager->getDefinition($target_entity_type_id);
$entity_type_id = $field_storage->getTargetEntityTypeId();
$entity_type = $entity_type_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 = [
'@label' => $target_entity_type->getLabel(),
'@field_name' => $field_name,
];
$data[$table_name][$field_name]['relationship'] = [
'title' => new TranslatableMarkup('@label referenced from @field_name', $args),
'label' => new TranslatableMarkup('@field_name: @label', $args),
'group' => $entity_type->getLabel(),
'help' => new TranslatableMarkup('Appears in: @bundles.', [
'@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->getSingularLabel();
$pseudo_field_name = 'reverse__' . $entity_type_id . '__' . $field_name;
$data[$target_base_table][$pseudo_field_name]['relationship'] = [
'title' => new TranslatableMarkup('@entity using @field_name', $args),
'label' => new TranslatableMarkup('@field_name', ['@field_name' => $field_name]),
'group' => $target_entity_type->getLabel(),
'help' => new TranslatableMarkup('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' => [
[
'field' => 'deleted',
'value' => 0,
'numeric' => TRUE,
],
],
];
}
// OG audience UNION relationships (per entity type pair).
// Owner (content) entity type.
$group_content_entity_id = $field_storage->getTargetEntityTypeId();
$group_content_definition = $entity_type_manager->getDefinition($group_content_entity_id);
$group_content_base_table = $group_content_definition->getDataTable() ?: $group_content_definition->getBaseTable();
$group_content_id_key = $group_content_definition->getKey('id');
// Target (group) entity type of this audience field.
$group_entity_id = $field_storage->getSetting('target_type');
$group_definition = $entity_type_manager->getDefinition($group_entity_id);
$group_base_table = $group_definition->getDataTable() ?: $group_definition->getBaseTable();
$group_id_key = $group_definition->getKey('id');
// Only register if both sides have base tables.
// Plugin that builds a UNION of audience field references.
if ($group_content_base_table && $group_base_table) {
// Group content to group (UNION across all OG audience fields targeting
// $group_entity_id).
$data[$group_content_base_table]['og_group_content_to_group__' . $group_entity_id] = [
'title' => new TranslatableMarkup('Group content (@content) belonging to group (@group)', [
'@group' => $group_definition->getLabel(),
'@content' => $group_content_definition->getLabel(),
]),
'help' => new TranslatableMarkup('Relate group content (@content) to the group (@group) it belongs to across all OG audience fields.', [
'@content' => $group_content_definition->getLabel(),
'@group' => $group_definition->getLabel(),
]),
'group' => $group_content_definition->getLabel(),
'relationship' => [
'id' => 'og_group_content_to_group',
'label' => new TranslatableMarkup('OG: Group (@group)', [
'@group' => $group_definition->getLabel(),
]),
'base' => $group_base_table,
'base field' => $group_id_key,
],
];
// Group to group content (UNION across all OG audience fields on
// $group_content_entity_id).
// Inverse plugin that builds a UNION from groups to group content.
$data[$group_base_table]['og_group_to_group_content__' . $group_content_entity_id] = [
'title' => new TranslatableMarkup('Group (@group) to belonging group content (@content)', [
'@group' => $group_definition->getLabel(),
'@content' => $group_content_definition->getLabel(),
]),
'help' => new TranslatableMarkup('Relate a group (@group) to group content (@content) that belongs to it across all OG audience fields.', [
'@group' => $group_definition->getLabel(),
'@content' => $group_content_definition->getLabel(),
]),
'group' => $group_definition->getLabel(),
'relationship' => [
'id' => 'og_group_to_group_content',
'label' => new TranslatableMarkup('OG: Group content (@content)', [
'@content' => $group_content_definition->getLabel(),
]),
'base' => $group_content_base_table,
'base field' => $group_content_id_key,
],
];
}
break;
}
return $data;
}
