N°2847 - Refactor some early choices

- TWIG: Change calls to object methods from simple notation (eg. oObject.Id) to complete notation (eg. oObject.GetId()) to avoid confusion with use of arrays and variables (eg. aObject.sId)
- UIBlock: $sId should not be first parameter as most of the time it can be ignored and generated by the system
- NewsroomMenu: Rename method for something more less ambiguous
- Html: Embed content in <div /> so we can easily find all such HTML fragments in the UI

sources/application/UI/Component/Alert/Alert.php

@@ -47,12 +47,12 @@ class Alert extends UIBlock
 	/**
 	 * Alert constructor.
 	 *
-	 * @param string $sId
 	 * @param string $sTitle
 	 * @param string $sMainText
 	 * @param string $sColor
+	 * @param string|null $sId
 	 */
-	public function __construct($sId, $sTitle = '', $sMainText = '', $sColor = 'secondary')
+	public function __construct($sTitle = '', $sMainText = '', $sColor = 'secondary', $sId = null)
 	{
 		$this->sTitle = $sTitle;
 		$this->sMainText = $sMainText;

sources/application/UI/Component/Breadcrumbs/Breadcrumbs.php

@@ -48,10 +48,10 @@ class Breadcrumbs extends UIBlock
 	/**
 	 * QuickCreate constructor.
 	 *
-	 * @param string $sId
 	 * @param array|null $aNewEntry
+	 * @param string|null $sId
 	 */
-	public function __construct($sId = null, $aNewEntry = null)
+	public function __construct($aNewEntry = null, $sId = null)
 	{
 		parent::__construct($sId);
 		$this->SetNewEntry($aNewEntry);

sources/application/UI/Component/GlobalSearch/GlobalSearch.php

@@ -51,12 +51,12 @@ class GlobalSearch extends UIBlock
 	/**
 	 * GlobalSearch constructor.
 	 *
-	 * @param string $sId
 	 * @param array $aLastQueries
+	 * @param string|null $sId
 	 *
 	 * @throws \Exception
 	 */
-	public function __construct($sId = null, $aLastQueries = [])
+	public function __construct($aLastQueries = [], $sId = null)
 	{
 		parent::__construct($sId);
 		$this->SetEndpoint(static::DEFAULT_ENDPOINT_REL_URL);

sources/application/UI/Component/GlobalSearch/GlobalSearchFactory.php

@@ -43,6 +43,6 @@ class GlobalSearchFactory
 	{
 		$aLastClasses = GlobalSearchHelper::GetLastQueries();
 
-		return new GlobalSearch(GlobalSearch::BLOCK_CODE, $aLastClasses);
+		return new GlobalSearch($aLastClasses, GlobalSearch::BLOCK_CODE);
 	}
 }

sources/application/UI/Component/Html/Html.php

@@ -35,7 +35,6 @@ class Html extends UIBlock
 	// Overloaded constants
 	const BLOCK_CODE = 'ibo-html';
 	const HTML_TEMPLATE_REL_PATH = 'components/html/layout';
-	const JS_TEMPLATE_REL_PATH = 'components/html/layout';
 
 	/** @var string $sHtml */
 	protected $sHtml;
@@ -44,11 +43,12 @@ class Html extends UIBlock
 	 * Html constructor.
 	 *
 	 * @param string $sHtml
+	 * @param string|null $sId
 	 */
-	public function __construct($sHtml = '')
+	public function __construct($sHtml = '', $sId = null)
 	{
 		$this->sHtml = $sHtml;
-		parent::__construct();
+		parent::__construct($sId);
 	}
 
 	/**

sources/application/UI/Component/Panel/Panel.php

@@ -47,12 +47,12 @@ class Panel extends UIBlock
 	/**
 	 * Panel constructor.
 	 *
-	 * @param string $sId
 	 * @param string $sTitle
 	 * @param array $aSubBlocks
 	 * @param string $sColor
+	 * @param string|null $sId
 	 */
-	public function __construct($sId, $sTitle = '', $aSubBlocks = [], $sColor = 'secondary')
+	public function __construct($sTitle = '', $aSubBlocks = [], $sColor = 'secondary', $sId = null)
 	{
 		$this->sTitle = $sTitle;
 		$this->aSubBlocks = $aSubBlocks;

sources/application/UI/Component/PopoverMenu/NewsroomMenu/NewsroomMenu.php

@@ -32,23 +32,35 @@ use Combodo\iTop\Application\UI\Component\PopoverMenu\PopoverMenu;
  */
 class NewsroomMenu extends PopoverMenu
 {
+	// Overloaded constants
 	const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/newsroom-menu/layout';
 	const JS_TEMPLATE_REL_PATH = 'components/popover-menu/newsroom-menu/layout';
-
 	const JS_FILES_REL_PATH = [
 		'js/components/newsroom-menu.js',
 	];
 
 	/** @var array $aParams */
 	protected $aParams;
-	
+
+	/**
+	 * Set all parameters at once
+	 *
+	 * @param array $aParams
+	 *
+	 * @return $this
+	 */
 	public function SetParams($aParams)
 	{
 		$this->aParams = $aParams;
 		return $this;
 	}
 
-	public function GetParams()
+	/**
+	 * Return all parameters as a JSON string
+	 *
+	 * @return false|string
+	 */
+	public function GetParamsAsJson()
 	{
 		return json_encode($this->aParams);
 	}

sources/application/UI/Component/PopoverMenu/NewsroomMenu/NewsroomMenuFactory.php

@@ -46,20 +46,26 @@ class NewsroomMenuFactory
 	public static function MakeNewsroomMenuForNavigationMenu()
 	{
 			$oMenu = new NewsroomMenu('ibo-navigation-menu--notifications-menu');
-			$oMenu->SetParams(static::PrepareNewsForNewsroomMenu());
+			$oMenu->SetParams(static::PrepareParametersForNewsroomMenu());
 			
 			return $oMenu;
 	}
 
-
-	protected static function PrepareNewsForNewsroomMenu()
+	/**
+	 * Prepare parameters for the newsroom JS widget
+	 *
+	 * @return array
+	 * @throws \CoreException
+	 * @throws \CoreUnexpectedValue
+	 * @throws \MySQLException
+	 * @throws \OQLException
+	 */
+	protected static function PrepareParametersForNewsroomMenu()
 	{
-		$aItems = [];
-
 		$aProviderParams=[];
 		$oUser = UserRights::GetUserObject();
 		/**
-		 * @var iNewsroomProvider[] $aProviders
+		 * @var \iNewsroomProvider[] $aProviders
 		 */
 		$aProviders = MetaModel::EnumPlugins('iNewsroomProvider');
 		foreach($aProviders as $oProvider)

sources/application/UI/Component/PopoverMenu/PopoverMenu.php

@@ -37,7 +37,6 @@ class PopoverMenu extends UIBlock
 	// Overloaded constants
 	const BLOCK_CODE = 'ibo-popover-menu';
 	const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/layout';
-	//const JS_TEMPLATE_REl_PATH = 'components/popover-menu/layout';
 	const JS_FILES_REL_PATH = [
 		'js/components/popover-menu.js',
 	];

sources/application/UI/Component/PopoverMenu/PopoverMenuItem/JsPopoverMenuItem.php

@@ -35,12 +35,19 @@ class JsPopoverMenuItem extends PopoverMenuItem
 	// Overloaded constants
 	const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/item/mode_js';
 
+	/**
+	 * @see \JSPopupMenuItem::GetJsCode()
+	 * @return string
+	 */
 	public function GetJsCode()
 	{
 		return $this->oPopupMenuItem->GetJSCode();
 	}
 
-	/** @ignore */
+	/**
+	 * @see \JSPopupMenuItem::GetUrl()
+	 * @return string
+	 */
 	public function GetUrl()
 	{
 		return $this->oPopupMenuItem->GetUrl();

sources/application/UI/Component/PopoverMenu/PopoverMenuItem/UrlPopoverMenuItem.php

@@ -33,13 +33,19 @@ class UrlPopoverMenuItem extends PopoverMenuItem
 	// Overloaded constants
 	const HTML_TEMPLATE_REL_PATH = 'components/popover-menu/item/mode_url';
 
-	/** @ignore */
+	/**
+	 * @see \URLPopupMenuItem::GetUrl()
+	 * @return string
+	 */
 	public function GetUrl()
 	{
 		return $this->oPopupMenuItem->GetUrl();
 	}
 	
-	/** @ignore */
+	/**
+	 * @see \URLPopupMenuItem::GetTarget()
+	 * @return string
+	 */
 	public function GetTarget()
 	{
 		return $this->oPopupMenuItem->GetTarget();

sources/application/UI/Component/QuickCreate/QuickCreate.php

@@ -56,13 +56,13 @@ class QuickCreate extends UIBlock
 	/**
 	 * QuickCreate constructor.
 	 *
-	 * @param string $sId
 	 * @param array $aLastClasses
+	 * @param string|null $sId
 	 *
 	 * @throws \CoreException
 	 * @throws \DictExceptionMissingString
 	 */
-	public function __construct($sId = null, $aLastClasses = [])
+	public function __construct($aLastClasses = [], $sId = null)
 	{
 		parent::__construct($sId);
 		$this->aAvailableClasses = UserRights::GetAllowedClasses(UR_ACTION_CREATE, array('bizmodel'), true);

sources/application/UI/Component/QuickCreate/QuickCreateFactory.php

@@ -42,6 +42,6 @@ class QuickCreateFactory
 	{
 		$aLastClasses = QuickCreateHelper::GetLastClasses();
 
-		return new QuickCreate(QuickCreate::BLOCK_CODE,$aLastClasses);
+		return new QuickCreate($aLastClasses, QuickCreate::BLOCK_CODE);
 	}
 }