composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-04-23 18:48:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

PHP doc

Browse Source
This commit is contained in:
Eric
2021-05-28 18:04:11 +02:00
parent aed1e7dfdc
commit e46480032e
5 changed files with 36 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
sources/application/UI/Base/Component/Alert/Alert.php
View File

@@ -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 <stephen.abello@combodo.com>
* @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-<color> 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
*/

30
sources/application/UI/Base/Component/Alert/AlertUIBlockFactory.php
View File

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