Expose custom entity to views

Question

I've created an entity in a Drupal 8 custom module. Right now it's just an entity with base fields.

I want to expose these base fields to views.

I have the entity appearing on the views wizard page, but when I create the view, there are no base fields available for me to add, and the default field that views puts in there shows up as broken/missing.

I've tried referencing the comments module for examples, and have tried defining various views plugins, but I'm not having much luck.

I have baseFieldDefinitions($entity_type) defined in my entity controller. What else is required to expose this entity and its fields to views?

Answer 1

You need to implement hook_views_data() just like in Drupal 7. See comment.views.inc.

Answer 2

This is now possible via a class annotation; per the documentation for the hook mentioned in the other answer:

To provide views data for an entity, instead of implementing this hook, create a class implementing \Drupal\views\EntityViewsDataInterface and reference this in the "views" annotation in the entity class. The return value of the getViewsData() method on the interface is the same as this hook.

Answer 3

You should extend EntityViewsData and you'll have the integration of your entity.

Example:

use Drupal\views\EntityViewsData;

class CustomEntityViewsData extends EntityViewsData {
  public function getViewsData() {
    $data = parent::getViewsData();
    return $data;
  }
}

Answer 4

If you use Drupal Console's Content entity generator it will automatically include Views integration.

Answer 5

This is an example of a custom entity with views integration:

/**
 * Defines the logbook entity.
 *
 * @ingroup logbook
 *
 * @ContentEntityType(
 *   id = "logbook",
 *   label = @Translation("Logbook"),
 *   base_table = "logbook",
 *   data_table = "logbook_field_data",
 *   fieldable = TRUE,
 *   entity_keys = {
 *     "id" = "id",
 *     "uuid" = "uuid",
 *     "owner" = "uid",
 *     "uid" = "uid",
 *   },
 *   handlers = {
 *     "views_data" = "Drupal\views\EntityViewsData",
 *     "access" = "Drupal\logbook\LogbookAccessControlHandler",
 *   },
 *   field_ui_base_route="entity.logbook.settings"
 * )
 */

Answer 6

you need implement \Drupal\views\EntityViewsData and add it in entity aanotation