EntityViewsDataInterface.php

Same filename in other branches
  1. 9 core/modules/views/src/EntityViewsDataInterface.php
  2. 10 core/modules/views/src/EntityViewsDataInterface.php
  3. 11.x core/modules/views/src/EntityViewsDataInterface.php

Namespace

Drupal\views

File

core/modules/views/src/EntityViewsDataInterface.php

View source
<?php

namespace Drupal\views;

use Drupal\Core\Entity\EntityTypeInterface;

/**
 * Provides an interface to integrate an entity type with views.
 */
interface EntityViewsDataInterface {
    
    /**
     * Returns views data for the entity type.
     *
     * @return array
     *   Views data in the format of hook_views_data().
     */
    public function getViewsData();
    
    /**
     * Gets the table of an entity type to be used as base table in views.
     *
     * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
     *   The entity type.
     *
     * @return string
     *   The name of the base table in views.
     */
    public function getViewsTableForEntityType(EntityTypeInterface $entity_type);

}

Interfaces

Title Deprecated Summary
EntityViewsDataInterface Provides an interface to integrate an entity type with views.

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