composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-03-01 07:04:16 +01:00
Code Issues Packages Projects Releases Wiki Activity

💡 PHPDoc for object list panels

Browse Source
This commit is contained in:
Pierre Goiffon
2023-07-24 15:38:57 +02:00
parent a57b6471c9
commit 772368ef8a
2 changed files with 13 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
sources/application/UI/Base/Component/DataTable/DataTableUIBlockFactory.php
View File

@@ -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