file.views.inc

Same filename in other branches
  1. 9 core/modules/file/file.views.inc
  2. 10 core/modules/file/file.views.inc
  3. 11.x core/modules/file/file.views.inc

Provide views data for file.module.

File

core/modules/file/file.views.inc

View source
<?php


/**
 * @file
 * Provide views data for file.module.
 */
use Drupal\field\FieldStorageConfigInterface;

/**
 * Implements hook_field_views_data().
 *
 * Views integration for file fields. Adds a file relationship to the default
 * field data.
 *
 * @see views_field_default_views_data()
 */
function file_field_views_data(FieldStorageConfigInterface $field_storage) {
    $data = views_field_default_views_data($field_storage);
    foreach ($data as $table_name => $table_data) {
        // Add the relationship only on the fid field.
        $data[$table_name][$field_storage->getName() . '_target_id']['relationship'] = [
            'id' => 'standard',
            'base' => 'file_managed',
            'entity type' => 'file',
            'base field' => 'fid',
            'label' => t('file from @field_name', [
                '@field_name' => $field_storage->getName(),
            ]),
        ];
    }
    return $data;
}

/**
 * Implements hook_field_views_data_views_data_alter().
 *
 * Views integration to provide reverse relationships on file fields.
 */
function file_field_views_data_views_data_alter(array &$data, FieldStorageConfigInterface $field_storage) {
    $entity_type_id = $field_storage->getTargetEntityTypeId();
    $entity_manager = \Drupal::entityTypeManager();
    $entity_type = $entity_manager->getDefinition($entity_type_id);
    $field_name = $field_storage->getName();
    $pseudo_field_name = 'reverse_' . $field_name . '_' . $entity_type_id;
    
    /** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
    $table_mapping = $entity_manager->getStorage($entity_type_id)
        ->getTableMapping();
    list($label) = views_entity_field_label($entity_type_id, $field_name);
    $data['file_managed'][$pseudo_field_name]['relationship'] = [
        'title' => t('@entity using @field', [
            '@entity' => $entity_type->getLabel(),
            '@field' => $label,
        ]),
        'label' => t('@field_name', [
            '@field_name' => $field_name,
        ]),
        'group' => $entity_type->getLabel(),
        'help' => t('Relate each @entity with a @field set to the file.', [
            '@entity' => $entity_type->getLabel(),
            '@field' => $label,
        ]),
        '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' => [
            0 => [
                'field' => 'deleted',
                'value' => 0,
                'numeric' => TRUE,
            ],
        ],
    ];
}

Functions

Title Deprecated Summary
file_field_views_data Implements hook_field_views_data().
file_field_views_data_views_data_alter Implements hook_field_views_data_views_data_alter().

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.