diff --git a/sources/application/UI/Base/Component/Alert/Alert.php b/sources/application/UI/Base/Component/Alert/Alert.php index 87c44c1827..d7947d7cef 100644 --- a/sources/application/UI/Base/Component/Alert/Alert.php +++ b/sources/application/UI/Base/Component/Alert/Alert.php @@ -24,7 +24,8 @@ use Combodo\iTop\Application\UI\Base\Component\Html\Html; use Combodo\iTop\Application\UI\Base\Layout\UIContentBlock; /** - * Class Alert + * Alerts are the main component to give feedback to the user or communicate page specific to system wide messages. + * Alerts are a rectangular component displaying a title and a message. * * @author Stephen Abello * @package Combodo\iTop\Application\UI\Base\Component\Alert @@ -143,7 +144,7 @@ class Alert extends UIContentBlock } /** - * @param string $sTitle + * @param string $sTitle Title of the alert * * @return $this */ @@ -167,7 +168,7 @@ class Alert extends UIContentBlock /** * Set the raw HTML content, must be already sanitized. * - * @param string $sContent + * @param string $sContent The raw HTML content, must be already sanitized * * @return $this */ @@ -187,7 +188,8 @@ class Alert extends UIContentBlock } /** - * @param string $sColor + * @param string $sColor Color of the alert (check CSS classes ibo-is- for colors) + * * @return $this */ public function SetColor(string $sColor) @@ -208,7 +210,8 @@ class Alert extends UIContentBlock /** * @see self::$bIsClosable - * @param bool $bIsClosable + * + * @param bool $bIsClosable Indicates if the user can remove the alert from the screen * * @return $this */ @@ -230,7 +233,8 @@ class Alert extends UIContentBlock /** * @see self::$bIsCollapsible - * @param bool $bIsCollapsible + * + * @param bool $bIsCollapsible Indicates if the user can collapse the alert to display only the title * * @return $this */ @@ -255,7 +259,7 @@ class Alert extends UIContentBlock } /** - * @param bool $bIsOpenedByDefault + * @param bool $bIsOpenedByDefault Indicates if the alert is collapsed or not by default * * @return $this */ diff --git a/sources/application/UI/Base/Component/Alert/AlertUIBlockFactory.php b/sources/application/UI/Base/Component/Alert/AlertUIBlockFactory.php index 85fdc77078..74ae9dec61 100644 --- a/sources/application/UI/Base/Component/Alert/AlertUIBlockFactory.php +++ b/sources/application/UI/Base/Component/Alert/AlertUIBlockFactory.php @@ -38,9 +38,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make a basis Alert component * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -52,9 +52,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component for informational messages * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -67,7 +67,7 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component for successful messages * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized * @param string|null $sId * @@ -81,9 +81,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component for warning messages * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -95,9 +95,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component for danger messages * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -109,9 +109,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component for failure messages * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -123,9 +123,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component with primary color scheme * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ @@ -137,9 +137,9 @@ class AlertUIBlockFactory extends AbstractUIBlockFactory /** * Make an Alert component with secondary color scheme * - * @param string $sTitle + * @param string $sTitle Title of the alert * @param string $sContent The raw HTML content, must be already sanitized - * @param string|null $sId + * @param string|null $sId id of the html block * * @return \Combodo\iTop\Application\UI\Base\Component\Alert\Alert */ diff --git a/sources/application/UI/Base/Layout/iUIContentBlock.php b/sources/application/UI/Base/Layout/iUIContentBlock.php index 0b51d20a49..a2636e7c1d 100644 --- a/sources/application/UI/Base/Layout/iUIContentBlock.php +++ b/sources/application/UI/Base/Layout/iUIContentBlock.php @@ -21,7 +21,7 @@ interface iUIContentBlock { /** * Add raw HTML to the block * - * @param string $sHtml + * @param string $sHtml HTML to add to the block (must have been sanitized) * * @return $this */ @@ -30,7 +30,7 @@ interface iUIContentBlock { /** * Add $oSubBlock, replacing any block with the same ID * - * @param \Combodo\iTop\Application\UI\Base\iUIBlock $oSubBlock + * @param \Combodo\iTop\Application\UI\Base\iUIBlock|null $oSubBlock Sub-block to add into the current block * * @return $this */ @@ -79,7 +79,7 @@ interface iUIContentBlock { /** * Set all sub blocks at once, replacing all existing ones * - * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aSubBlocks + * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aSubBlocks Array of blocks to set into the current block * * @return $this */ @@ -89,7 +89,7 @@ interface iUIContentBlock { /** * Add $oDeferredBlock, replacing any block with the same ID * - * @param \Combodo\iTop\Application\UI\Base\iUIBlock $oDeferredBlock + * @param \Combodo\iTop\Application\UI\Base\iUIBlock $oDeferredBlock Block added at the end of the page * * @return $this */ @@ -133,7 +133,7 @@ interface iUIContentBlock { /** * Set all sub blocks at once, replacing all existing ones * - * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aDeferredBlocks + * @param \Combodo\iTop\Application\UI\Base\iUIBlock[] $aDeferredBlocks Array of blocks set at the end of the page * * @return $this */ diff --git a/sources/application/UI/Base/UIBlock.php b/sources/application/UI/Base/UIBlock.php index d409598abd..7a5b809c29 100644 --- a/sources/application/UI/Base/UIBlock.php +++ b/sources/application/UI/Base/UIBlock.php @@ -300,7 +300,7 @@ abstract class UIBlock implements iUIBlock /** * Note: If $sCSSClass is already present, proceeds silently * - * @param string $sCSSClass + * @param string $sCSSClass CSS class to add to the generated html block * * @return $this * @@ -436,7 +436,7 @@ abstract class UIBlock implements iUIBlock } /** - * @param array $aDataAttributes + * @param array $aDataAttributes Array of data attributes in the format ['name' => 'value'] * * @return $this */ @@ -478,7 +478,7 @@ abstract class UIBlock implements iUIBlock } /** - * @param bool $bIsHidden + * @param bool $bIsHidden Indicates if the block is hidden by default * * @return $this */ diff --git a/sources/application/UI/Base/iUIBlock.php b/sources/application/UI/Base/iUIBlock.php index d813802f6b..14dd539170 100644 --- a/sources/application/UI/Base/iUIBlock.php +++ b/sources/application/UI/Base/iUIBlock.php @@ -139,7 +139,7 @@ interface iUIBlock { /** * Add a JS file to a block * - * @param string $sPath + * @param string $sPath relative path of a JS file to add * * @return $this */ @@ -148,7 +148,7 @@ interface iUIBlock { /** * Add a CSS file to a block * - * @param string $sPath + * @param string $sPath relative path of a CSS file to add * * @return $this */