entity_hierarchy 5.x-dev

⚠️ This is a significant rewrite of the module to make use of newer database engine features

High level changes

• The nested_set table created for each field has been removed
• No longer relies on DBAL or previousnext/nested-set
• Makes use of Common Table Expressions (CTE)s instead of a Nested set model

Breaking changes

There are several breakages between the 3.x/4.x and the 5.x branch.

If you're not using the views integration and not using the PHP APIs to traverse the tree in custom code, there should be no changes required.

If you are using the PHP APIs or views integration - the following breaking changes exist:

PHP APIs removed

The following services/PHP APIs are removed

• \Drupal\entity_hierarchy\Storage\EntityTreeNodeMapperInterface - instead use the query builder factory.
  

  $queryBuilder = \Drupal::service('entity_hierarchy.query_builder_factory')->get($fieldName, $entity->getEntityTypeId());
      $childEntities = $queryBuilder->findChildren($entity)
        ->filter(RecordCollectionCallable::viewLabelAccessFilter(...));
  

• \Drupal\entity_hierarchy\Storage\NestedSetNodeKeyFactory - there is no replacement, work directly with a Drupal entity and the query factory
• \Drupal\entity_hierarchy\Storage\NestedSetStorage and \Drupal\entity_hierarchy\Storage\NestedSetStorageFactory - work with the query builder factory (\Drupal\entity_hierarchy\Storage\QueryBuilderFactory instead
• We no longer use the previousnext/nestedset library, so e.g. value objects like \PNX\NestedSet\Node and \PNX\NestedSet\NodeKey no longer exist

Views changes

The following views changes have been made:

• The 'Root of hierarchy' relationship has been removed - it may be re-added before a stable release
• The child of/parent of/sibling of arguments that use the revision ID have been removed, versions that support entity ID still exist
• Any views fields/sorts/arguments that referenced the old nested_set tables have been replaced with pseudo fields that use the field-data or entity base table. You should check each of your views and find any that have 'broken/missing handler'. Each of these views will require manually editing to use the new field from the base/field tables.