💡 N°5248 \cmdbAbstractObject::DisplayBareHeader phpdoc v2

This commit is contained in:
Pierre Goiffon
2022-06-21 10:21:10 +02:00
parent 84d1be07cd
commit 073388436b

View File

@@ -341,11 +341,10 @@ JS
}
/**
* Important: For compatibility reasons, this function still allows to manipulate the $oPage. In that case, markup will be put above the real header of the panel.
* To insert something IN the panel, we now need to add UIBlocks in either the "subtitle" or "toolbar" sections of the array that will be returned.
*
* @param \WebPage $oPage
* @param bool $bEditMode Note that this parameter is no longer used in this method. Use {@see static::$sDisplayMode} instead
* @param \WebPage $oPage warning, since 3.0.0 this parameter was kept for compatibility reason. You shouldn't write directly on the page !
* When writing to the page, markup will be put above the real header of the panel.
* To insert something IN the panel, we now need to add UIBlocks in either the "subtitle" or "toolbar" sections of the array that will be returned.
* @param bool $bEditMode Deprecated parameter in iTop 3.0.0, use {@see static::$sDisplayMode} and ENUM_DISPLAY_MODE_* constants instead
*
* @return array{
* subtitle: \Combodo\iTop\Application\UI\Base\UIBlock[],
@@ -361,8 +360,8 @@ JS
* @throws \MySQLException
* @throws \OQLException
*
* @since 3.0.0 $bEditMode is deprecated and no longer used
* @since 3.0.0 changed signature : add return value (no more writing directly to the $oPage)
* @since 3.0.0 $bEditMode is deprecated, see param documentation above
* @since 3.0.0 changed signature : method must return header content in an array (no more writing directly to the $oPage)
*
* @noinspection PhpUnusedParameterInspection
*/