Varianten und Kindknoten derselben Sortierung folgen lassen

getChildrenOfModel() holte die Kinder eines Knotens mit fest verdrahtetem
"sorting ASC", waehrend die Wurzelebene ueber calculateRootConfig() die
konfigurierte Sortierung nutzt und das Panel die gewaehlte darauf legt. In
einem Baum, der nach einer Eigenschaft sortiert ist, standen die Elternknoten
damit in der eingestellten Reihenfolge und ihre Kinder nicht.

Sichtbar wird das bei den MetaModels-Varianten: die Basisdatensaetze
alphabetisch, die Varianten darunter in Datenbankreihenfolge - siehe
MetaModels/core#1395. Nachgemessen an einem Testmodell mit nach Namen
sortierter Liste: vorher C, A, Z unter der Basis, jetzt A, C, Z.

Uebernommen wird nur die Sortierung. Den Panel ueber den Kind-Config laufen zu
lassen waere falsch, weil dessen Limit-Element Offset und Amount setzt - die
Blaetterung der Liste landete damit auf den Kindern eines einzelnen Knotens.

Fuer manuell sortierte Baeume aendert sich nichts: manuelle Sortierung loest
auf die Eigenschaft "sorting" mit SORT_ASC auf und ergibt damit genau den
Wert, der bisher fest im Code stand. Ohne jede Sortierung greift derselbe
Rueckfall.

Author: zonky2

src/Controller/TreeCollector.php

@@ -81,6 +81,13 @@ class TreeCollector implements EnvironmentAwareInterface
      */
     private TreeNodeStates $states;
 
+    /**
+     * The sorting that is effectively in use, cached for the whole tree walk.
+     *
+     * @var array<string, string>|null
+     */
+    private ?array $effectiveSorting = null;
+
     /**
      * Create a new instance.
      *
@@ -204,7 +211,7 @@ private function getChildrenOfModel(
         $children = $dataProvider->fetchAll(
             $dataProvider
                 ->getEmptyConfig()
-                ->setSorting(['sorting' => 'ASC'])
+                ->setSorting($this->getEffectiveSorting())
                 ->setFilter(
                     FilterBuilder::fromArray()
                         ->getFilter()
@@ -335,6 +342,33 @@ private function addParentFilter(ConfigInterface $config, ModelInterface $parent
         }
     }
 
+    /**
+     * Retrieve the sorting that the children of a node have to follow.
+     *
+     * Up to now the children were fetched with a hard coded "sorting ASC" while the root
+     * level used the configured sorting. In a tree that is sorted by a property the parents
+     * were therefore ordered as configured and their children were not - see
+     * MetaModels/core#1395 for the variant lists this shows up in.
+     *
+     * Only the sorting is taken over from the root config. Handing the whole config or
+     * running the panel over the child config would also apply the limit element and thus
+     * put the pagination of the list onto the children of a single node.
+     *
+     * @return array<string, string>
+     */
+    private function getEffectiveSorting(): array
+    {
+        if (null === $this->effectiveSorting) {
+            $sorting = $this->calculateRootConfig()->getSorting();
+            // Without any sorting the previous behaviour is kept. For a manually sorted tree
+            // nothing changes either: manual sorting resolves to the property "sorting" with
+            // SORT_ASC and therefore yields exactly the value that was hard coded before.
+            $this->effectiveSorting = $sorting ?: ['sorting' => 'ASC'];
+        }
+
+        return $this->effectiveSorting;
+    }
+
     /**
      * Put the base filter and sorting into a config.
      *