N°4076 - PHPDoc

sources/application/TwigBase/Controller/Controller.php

@@ -65,6 +65,11 @@ abstract class Controller
 	private $m_aLinkedStylesheets;
 	private $m_aSaas;
 	private $m_aAjaxTabs;
+	/** parameters for page's blocks
+	 *
+	 * @var array
+	 * @since 3.0.0
+	 */
 	private $m_aBlockParams;
 	/** @var string */
 	private $m_sAccessTokenConfigParamId = null;
@@ -560,8 +565,9 @@ abstract class Controller
 
 	/**
 	 * @param array $aBlockParams
+	 * @since 3.0.0
 	 */
-	public function AddBlockParams(array $aBlockParams)
+	public function SetBlockParams(array $aBlockParams)
 	{
 		$this->m_aBlockParams = $aBlockParams;
 	}
@@ -688,7 +694,12 @@ abstract class Controller
 		$this->m_oPage->AddAjaxTab($sCode, $sURL, $bCache, $sTitle);
 	}
 
-	public function SetBlockParamToPage(string $sKey, $value)
+	/**
+	 * @param string $sKey
+	 * @param $value
+	 * @since 3.0.0
+	 */
+	private function SetBlockParamToPage(string $sKey, $value)
 	{
 		$this->m_oPage->SetBlockParam($sKey, $value);
 	}

sources/application/WebPage/WebPage.php

@@ -91,7 +91,7 @@ class WebPage implements Page
 	protected $a_ready_scripts;
 	/** @var array Scripts linked (externals) to the page through URIs */
 	protected $a_linked_scripts;
-	/** @var array Specific dictionnary entries to be used client side */
+	/** @var array Specific dictionary entries to be used client side */
 	protected $a_dict_entries;
 	/** @var array Sub-sets of dictionary entries (based on the given prefix) for the client side */
 	protected $a_dict_entries_prefixes;
@@ -99,7 +99,12 @@ class WebPage implements Page
 	protected $a_styles;
 	/** @var array Stylesheets linked (external) to the page through URIs */
 	protected $a_linked_stylesheets;
-	/** @var array Parameters to be used by page blocks */
+	/**
+	 * These parameters are used by page blocks and avoid accessing directly the blocks from external code
+	 *
+	 * @var array Parameters to be used by page blocks
+	 * @since 3.0.0
+	 */
 	protected $aBlockParams;
 	protected $a_headers;
 	protected $a_base;
@@ -1609,18 +1614,14 @@ EOD
 	}
 
 	/**
-	 * @return array
-	 */
-	public function GetBlockParams(): array
-	{
-		return $this->aBlockParams;
-	}
-
-	/**
+	 *
+	 * @see aBlockParams
+	 *
 	 * @param string $sKey
 	 * @param $value
 	 *
 	 * @return $this
+	 * @since 3.0.0
 	 */
 	public function SetBlockParam(string $sKey, $value)
 	{
@@ -1628,4 +1629,14 @@ EOD
 
 		return $this;
 	}
+
+	/**
+	 * @see aBlockParams
+	 * @return array
+	 * @since 3.0.0
+	 */
+	public function GetBlockParams(): array
+	{
+		return $this->aBlockParams;
+	}
 }

sources/application/WebPage/iTopWebPage.php

@@ -1173,6 +1173,13 @@ EOF
 		return $oBlock;
 	}
 
+	/**
+	 * @param string $sKey
+	 * @param $value
+	 *
+	 * @return \iTopWebPage
+	 * @since 3.0.0
+	 */
 	public function SetBlockParam(string $sKey, $value)
 	{
 		$oGlobalSearch = $this->GetTopBarLayout()->GetGlobalSearch();
@@ -1183,6 +1190,6 @@ EOF
 				break;
 		}
 
-		return parent::SetBlockParam($sKey, $value); // TODO: Change the autogenerated stub
+		return parent::SetBlockParam($sKey, $value);
 	}
 }