From 772368ef8a0233914f72d11d84fc56f6027292bc Mon Sep 17 00:00:00 2001
From: Pierre Goiffon <pierre.goiffon@combodo.com>
Date: Mon, 24 Jul 2023 15:38:57 +0200
Subject: [PATCH] :bulb: PHPDoc for object list panels

---
 application/cmdbabstract.class.inc.php            |  2 +-
 .../DataTable/DataTableUIBlockFactory.php         | 15 ++++++++++++---
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/application/cmdbabstract.class.inc.php b/application/cmdbabstract.class.inc.php
index 6ffb976ff..0a96af064 100644
--- a/application/cmdbabstract.class.inc.php
+++ b/application/cmdbabstract.class.inc.php
@@ -1234,7 +1234,7 @@ HTML
 	/**
 	 * @param \WebPage $oPage
 	 * @param \CMDBObjectSet $oSet
-	 * @param array $aExtraParams
+	 * @param array $aExtraParams See possible values in {@see DataTableUIBlockFactory::RenderDataTable()}
 	 *
 	 * @throws \ApplicationException
 	 * @throws \CoreException
diff --git a/sources/application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php b/sources/application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
index 8e815ac86..53bdfe4bd 100644
--- a/sources/application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
+++ b/sources/application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
@@ -47,11 +47,13 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 	public const UI_BLOCK_CLASS_NAME = DataTable::class;
 
 	/**
+	 * If inside an iTop object, you can use {@see cmdbAbstractObject::DisplaySet()}
+	 *
 	 * @api
 	 * @param \WebPage $oPage
 	 * @param string $sListId
 	 * @param \DBObjectSet $oSet
-	 * @param array $aExtraParams
+	 * @param array $aExtraParams See possible values in {@see self::RenderDataTable()}
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
 	 * @throws \ApplicationException
@@ -72,11 +74,13 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 	}
 
 	/**
+	 * If inside an iTop object, you can use {@see cmdbAbstractObject::DisplaySet()}
+	 *
 	 * @api
 	 * @param \WebPage $oPage
 	 * @param string $sListId
 	 * @param DBObjectSet $oSet
-	 * @param array $aExtraParams
+	 * @param array $aExtraParams See possible values in {@see self::RenderDataTable()}
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
 	 * @throws \ArchivedObjectException
@@ -105,7 +109,12 @@ class DataTableUIBlockFactory extends AbstractUIBlockFactory
 	 * @param \WebPage $oPage
 	 * @param string $sListId
 	 * @param \DBObjectSet $oSet
-	 * @param array $aExtraParams
+	 * @param array $aExtraParams example keys used in this method :
+	 *          - toolkit_menu = boolean
+	 *          - surround_with_panel = boolean : if true adds the standard class panel (icon, title, ...)
+	 *          - panel_title = string
+	 *          - panel_title_is_html = boolean
+	 *          - panel_icon = string : class icon (for example from {@see MetaModel::GetClassIcon()})
 	 *
 	 * @return \Combodo\iTop\Application\UI\Base\Layout\UIContentBlock
 	 * @throws \ArchivedObjectException