PHPackages                             wieni/wmentity\_overview - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. wieni/wmentity\_overview

ActiveDrupal-module

wieni/wmentity\_overview
========================

Improved EntityListBuilders with support for paging, table sorting, table dragging, filtering, bulk actions, database queries and more.

1.12.0(9mo ago)119.7k↓41%2[4 issues](https://github.com/wieni/wmentity_overview/issues)MITPHPPHP >=8.1

Since Jan 30Pushed 9mo ago3 watchersCompare

[ Source](https://github.com/wieni/wmentity_overview)[ Packagist](https://packagist.org/packages/wieni/wmentity_overview)[ RSS](/packages/wieni-wmentity-overview/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (4)Dependencies (3)Versions (36)Used By (0)

Entity Overview
===============

[](#entity-overview)

[![Latest Stable Version](https://camo.githubusercontent.com/7d78de4b29b6393b5790318360b889debd359ff5794de07901d7310919df2ad6/68747470733a2f2f706f7365722e707567782e6f72672f7769656e692f776d656e746974795f6f766572766965772f762f737461626c65)](https://packagist.org/packages/wieni/wmentity_overview)[![Total Downloads](https://camo.githubusercontent.com/2382011b0a4b429f9d55fdc37a60cbd29e0a99e55cda4fd10fc8d0e56defd6cd/68747470733a2f2f706f7365722e707567782e6f72672f7769656e692f776d656e746974795f6f766572766965772f646f776e6c6f616473)](https://packagist.org/packages/wieni/wmentity_overview)[![License](https://camo.githubusercontent.com/8b5c40a4451021dfd4673af15c34034af8d20fd6516b6c16b0cd52ed3f3df3e3/68747470733a2f2f706f7365722e707567782e6f72672f7769656e692f776d656e746974795f6f766572766965772f6c6963656e7365)](https://packagist.org/packages/wieni/wmentity_overview)

> Improved EntityListBuilders with support for paging, table sorting, table dragging, filtering, bulk actions, database queries and more.

Why?
----

[](#why)

At Wieni, we're not a big fan of the [Views](https://www.drupal.org/docs/8/core/modules/views) module and for a couple of reasons:

- we're programmers, we don't like to create functionality by clicking through the Drupal interface and especially not the bloated Views interface
- we prefer to write our own database or entity queries, it gives us more flexibility when filtering and including non-entity field data and it makes it easier to optimize queries

That's why a couple of years ago we decided to disable the module altogether and we ended up with the [EntityListBuilder](https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Entity%21EntityListBuilder.php/class/EntityListBuilder/8.2.x) based listings.

Those proved to be lacking in functionality and user friendliness soon enough, which is how we ended up creating this module: the perfect middle ground between Views and EntityListBuilder. It offers all features of the latter, plus the following:

- **Exposed filtering** with a custom form
- **Behind-the-scenes filtering** using custom database queries
- **Table sorting**, configurable on a per-column basis
- **Bulk actions** using core [Action plugins](https://www.drupal.org/node/2020549)
- **Override built-in entity listings** with a custom one, on an entity type or bundle level
- **Override any route** with a custom entity listing

Installation
------------

[](#installation)

This package requires PHP 7.1 and Drupal 8 or higher. It can be installed using Composer:

```
 composer require wieni/wmentity_overview
```

How does it work?
-----------------

[](#how-does-it-work)

### Create an overview

[](#create-an-overview)

Overviews are Drupal plugins with the [`@OverviewBuilder`](src/Annotation/OverviewBuilder.php) annotation. Every annotation needs at least the `entity_type` and `id` parameters to function.

There are three base classes you can choose from:

- [`OverviewBuilderBase`](src/OverviewBuilder/OverviewBuilderBase.php): the most basic entity overview with support for database queries, paging and table sort
- [`FilterableOverviewBuilderBase`](src/OverviewBuilder/FilterableOverviewBuilderBase.php): an entity overview combining the base functionality with an exposed filter form
- [`DraggableOverviewBuilderBase`](src/OverviewBuilder/DraggableOverviewBuilderBase.php): an entity overview with a draggable, re-orderable table, but without support for paging or filtering

#### Example

[](#example)

```