From 7f9f9a528ef6c6e89a5d3d3bc1bddc84a26ce1ec Mon Sep 17 00:00:00 2001
From: Molkobain <lajarige.guillaume@free.fr>
Date: Sun, 26 Apr 2026 15:12:55 +0200
Subject: [PATCH] Objects list: Add tree group by option to
 DataTableUIBlockFactory WIP

---
 .../DataTable/DataTableUIBlockFactory.php     | 20 ++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

diff --git a/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php b/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
index 1b1d12ad1..e5d0eeab7 100644
--- a/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
+++ b/sources/Application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
@@ -300,6 +300,9 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 
 		// Initialize and check the parameters
 		$bViewLink = isset($aExtraParams['view_link']) ? $aExtraParams['view_link'] : true;
+		// Check if this is a tree grouping view
+		$sTreeGroupingAttr = $aExtraParams['tree_grouping_attr'] ?? '';
+		$bIsTreeGroupingView = utils::IsNotNullOrEmptyString($sTreeGroupingAttr);
 		// Check if there is a list of aliases to limit the display to...
 		$aDisplayAliases = isset($aExtraParams['display_aliases']) ? explode(',', $aExtraParams['display_aliases']) : [];
 		$sZListName = isset($aExtraParams['zlist']) ? ($aExtraParams['zlist']) : 'list';
@@ -452,6 +455,11 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 			$oCustomSettings = $oDefaultSettings;
 		}
 
+		// Tree grouping mode: Disable pagination so the full dataset is embedded in the page, otherwise there will be glitches in grouping / sorting
+		if ($bIsTreeGroupingView) {
+			$oCustomSettings->iDefaultPageSize = 0;
+		}
+
 		if ($oCustomSettings->iDefaultPageSize > 0) {
 			$oSet->SetLimit($oCustomSettings->iDefaultPageSize);
 		}
@@ -467,17 +475,18 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 		// Load only the requested columns
 		$aColumnsToLoad = [];
 		foreach ($oCustomSettings->aColumns as $sAlias => $aColumnsInfo) {
+			$sClass = $aClassAliases[$sAlias];
 			foreach ($aColumnsInfo as $sAttCode => $aData) {
 				$bForceLoad = false;
 				if ($aData['sort'] != 'none' || isset($oCustomSettings->aSortOrder[$sAttCode])) {
 					$bForceLoad = true;
 				}
+
 				if ($sAttCode != '_key_') {
 					if ($aData['checked'] || $bForceLoad) {
 						$aColumnsToLoad[$sAlias][] = $sAttCode;
 					} else {
 						// See if this column is a must to load
-						$sClass = $aClassAliases[$sAlias];
 						$oAttDef = MetaModel::GetAttributeDef($sClass, $sAttCode);
 						if ($oAttDef->AlwaysLoadInTables()) {
 							$aColumnsToLoad[$sAlias][] = $sAttCode;
@@ -489,6 +498,13 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 					}
 				}
 			}
+
+			// Tree grouping mode: ensure the grouping attribute is loaded even if not displayed
+			if ($bIsTreeGroupingView
+				&& MetaModel::IsValidAttCode($sClass, $sTreeGroupingAttr)
+				&& !in_array($sTreeGroupingAttr, $aColumnsToLoad[$sAlias] ?? [])) {
+				$aColumnsToLoad[$sAlias][] = $sTreeGroupingAttr;
+			}
 		}
 		$oSet->OptimizeColumnLoad($aColumnsToLoad);
 
@@ -984,6 +1000,8 @@ JS;
 			/** Don't provide the standard object creation feature */
 			'display_unauthorized_objects',
 			/** bool Display objects for which the user has no read rights */
+			'tree_grouping_attr',
+			/** string Attribute code to group objects on as a collapsible tree */
 		];
 	}
 }