How to make EntityListBuilder sortable?

Question

When defining custom content entities one can use EntityListBuilder to build a list of those entities for administrative purpose.

By default such entities are ordered by ID, however it is possible to change ordering by overriding EntityListBuilder::getEntityIds(). Nevertheless this is only ordering of the items. But how to make that table sortable (by clicking on column header to sort ascending and descending)?

Answer 1

This is how i sort my entityListBuilder :

i use the method load() :

  public function load() {

    $entity_query = \Drupal::service('entity.query')->get('produits_entity');
    $header = $this->buildHeader();

    $entity_query->pager(50);
    $entity_query->tableSort($header);

    $uids = $entity_query->execute();

    return $this->storage->loadMultiple($uids);
  }

Then i build my header like this :

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {

    $header = array(
        'id' => array(
            'data' => $this->t('N° produit'),
            'field' => 'id',
            'specifier' => 'id',
            'class' => array(RESPONSIVE_PRIORITY_LOW),
        ),
        'nom' => array(
            'data' => $this->t('Nom'),
            'field' => 'name',
            'specifier' => 'name',
        ),

        'prixHT' => array(
            'data' => $this->t('Prix HT'),
            'field' => 'prixHT',
            'specifier' => 'prixHT',
        ),

        'statut' => array(
            'data' => $this->t('Actif'),
            'field' => 'actif',
            'specifier' => 'actif',
        ),

    );

    return $header + parent::buildHeader();
  }

you need to add in your buildHeader() 2 param for each field you want sort :

name of field and specifier

Answer 2

Entity query doesn't have tablesort integration. You'd have to implement the query logic yourself.

For content entities, I would strongly recommend to rely on the views integration instead. List builders are limited in functionality and mostly useful for config entities only.

Answer 3

For now, DraggableListBuilder is only available for config entities, not content entities. Take a look at the documentation for DraggableListBuilder 9.0 here. I spent about day trying to make that work until I noticed "config" in the route.

The best workaround I've come up with is to ignore EntityListBuilder and use the ContentEntityForm API instead. ContentEntityForm allows you to use the native TableDrag widget, which adds sortable handles to the form list. There's a well-documented example here.

These are the key lines of code to add to the usual buildform() function:

$form['table-row'][$id]['#attributes']['class'][] = 'draggable';
$form['table-row'][$id]['#weight'] = $row->weight->value;
$form['table-row'][$id]['weight'] = [
  '#type' => 'weight',
  '#title_display' => 'invisible',
  '#default_value' => $row->weight->value,
  '#attributes' => ['class' => ['table-sort-weight']],
];

If this solution is of interest, I can add a working example.

Answer 4

There is a sortable DraggableListBuilder available now.

use Drupal\Core\Config\Entity\DraggableListBuilder;


/**
 * Provides a listing of user roles.
 */
class RoleListBuilder extends DraggableListBuilder {

  public function getFormID() {
    return 'user_admin_roles_form';
  }

  public function buildHeader() {
    $header['label'] = t('Name');
    return $header + parent::buildHeader();
  }

  public function buildRow(EntityInterface $entity) {
    $row['label'] = $this->getLabel($entity);
    return $row + parent::buildRow($entity);
  }

}

You need to make sure your config entities have a weight and label.