phpMv  -UI toolkit 2.4.12
jQuery, jQuery UI, Twitter Bootstrap and Semantic-UI library for php & php MVC Frameworks
HtmlMessage Class Reference

Semantic Message component. More...

+ Inheritance diagram for HtmlMessage:
+ Collaboration diagram for HtmlMessage:

Public Member Functions

 __construct ($identifier, $content="")
 
 addHeader ($header)
 Adds an header to the message. More...
 
 setHeader ($header)
 
 setIcon ($icon)
 
 getOnClose ($url, $responseElement="", $parameters=array())
 Performs a get to $url on the click event on close button and display it in $responseElement. More...
 
 addLoader ($loaderIcon="notched circle")
 
 setDismissable ($dismiss=true)
 
 run (JsUtils $js)
 {} More...
 
 setState ($visible=true)
 
 setVariation ($value="floating")
 
 setStyle ($style)
 
 setError ()
 
 setWarning ()
 
 setMessage ($message)
 
- Public Member Functions inherited from HtmlSemDoubleElement
 __construct ($identifier, $tagName="p", $baseClass="ui", $content=NULL)
 
 setPopupAttributes ($variation=NULL, $popupEvent=NULL)
 Defines the popup attributes. More...
 
 addPopup ($title="", $content="", $variation=NULL, $params=array())
 Adds a popup to the element. More...
 
 addPopupHtml ($html="", $variation=NULL, $params=array())
 Adds an html popup to the element. More...
 
 addDimmer ($params=array(), $content=NULL)
 Adds a Dimmer to the element. More...
 
 addLabel ($label, $before=false, $icon=NULL)
 Adds a label to the element. More...
 
 attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)
 Adds an attached label to the element. More...
 
 asLink ($href=NULL, $target=NULL)
 Transforms the element into a link. More...
 
 jsShowDimmer ($show=true)
 Returns the script displaying the dimmer. More...
 
 compile (JsUtils $js=NULL, &$view=NULL)
 {} More...
 
 run (JsUtils $js)
 {} More...
 
 addList ($items, $ordered=false)
 
 asToast ($params=NULL)
 
 asSideBar ($classes='')
 
- Public Member Functions inherited from HtmlDoubleElement
 __construct ($identifier, $tagName="p")
 
 setContent ($content)
 
 getContent ()
 
 addContent ($content, $before=false)
 
 run (JsUtils $js)
 
 setValue ($value)
 
 wrapContent ($before, $after="")
 
 wrapWith (HtmlDoubleElement $container)
 Wraps the element with a container. More...
 
 getContentInstances ($class)
 
 asLink ($href=NULL, $target=NULL)
 Transforms the element into a link. More...
 
 getTextContent ()
 
 asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")
 
- Public Member Functions inherited from HtmlSingleElement
 __construct ($identifier, $tagName="br")
 
 setClass ($classNames)
 
 addClass ($classNames)
 
 setRole ($value)
 
 setTitle ($value)
 
 setStyle ($value)
 
 run (JsUtils $js)
 
 fromArray ($array)
 
 setSize ($size)
 
- Public Member Functions inherited from BaseHtml
 run (JsUtils $js)
 
 getTagName ()
 
 setTagName ($tagName)
 
 fromArray ($array)
 
 fromDatabaseObjects ($objects, $function)
 
 fromDatabaseObject ($object, $function)
 
 wrap ($before, $after="")
 
 getElementById ($identifier, $elements)
 
 getBsComponent ()
 
 setBsComponent ($bsComponent)
 
 compile (JsUtils $js=NULL, &$view=NULL)
 
 setDraggable ($attr="id", $dropZone=null, $parameters=[])
 Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop) More...
 
 asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])
 Declares the element as a drop zone (HTML5 drag and drop) More...
 
 asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])
 Declares the element as a drop zone for file uploading (HTML5 drag and drop) More...
 
 __toString ()
 
 onPostCompile ($callback)
 
 onPreCompile ($callback)
 
- Public Member Functions inherited from BaseWidget
 __construct ($identifier)
 
 getIdentifier ()
 
 setIdentifier ($identifier)
 
 getLibraryId ()
 
 setLibraryId ($_libraryId)
 

Protected Attributes

 $icon
 
 $close
 
- Protected Attributes inherited from HtmlSemDoubleElement
 $_popup = NULL
 
 $_dimmer = NULL
 
 $_toast = NULL
 
 $_sidebar = NULL
 
 $_params = array()
 
- Protected Attributes inherited from HtmlDoubleElement
 $content
 
 $wrapContentBefore = ""
 
 $wrapContentAfter = ""
 
 $_editableContent
 
- Protected Attributes inherited from BaseHtml
 $_template
 
 $tagName
 
 $_wrapBefore = array()
 
 $_wrapAfter = array()
 
 $_bsComponent
 
 $_compiled = false
 
 $_runned = false
 
 $_postCompile
 
 $_preCompile
 
- Protected Attributes inherited from BaseWidget
 $identifier
 
 $_identifier
 
 $_libraryId
 
 $_self
 

Additional Inherited Members

- Protected Member Functions inherited from HtmlDoubleElement
 _getContentInstances ($class, $content)
 
 compile_once (\Ajax\JsUtils $js=NULL, &$view=NULL)
 {} More...
 
- Protected Member Functions inherited from BaseHtml
 getTemplate (JsUtils $js=NULL, $view=null)
 
 ctrl ($name, $value, $typeCtrl)
 
 setMemberCtrl (&$name, $value, $typeCtrl)
 
 addToMemberUnique (&$name, $value, $typeCtrl, $separator=" ")
 
 addToMemberCtrl (&$name, $value, $typeCtrl, $separator=" ")
 
 addToMember (&$name, $value, $separator=' ')
 
 removeOldValues (&$oldValue, $allValues)
 
 _getElementBy ($callback, $elements)
 
 setWrapBefore ($wrapBefore)
 
 setWrapAfter ($wrapAfter)
 
 compile_once (JsUtils $js=NULL, &$view=NULL)
 
- Protected Member Functions inherited from BaseWidget
 cleanIdentifier ($id)
 

Detailed Description

Semantic Message component.

See also
http://semantic-ui.com/collections/message.html
Author
jc
Version
1.001

Definition at line 18 of file HtmlMessage.php.

Constructor & Destructor Documentation

◆ __construct()

__construct (   $identifier,
  $content = "" 
)

Definition at line 25 of file HtmlMessage.php.

Member Function Documentation

◆ addHeader()

addHeader (   $header)

Adds an header to the message.

Parameters
string | HtmlSemDoubleElement$header
Returns

Definition at line 38 of file HtmlMessage.php.

◆ addLoader()

addLoader (   $loaderIcon = "notched circle")

Definition at line 81 of file HtmlMessage.php.

◆ getOnClose()

getOnClose (   $url,
  $responseElement = "",
  $parameters = array() 
)

Performs a get to $url on the click event on close button and display it in $responseElement.

Parameters
string$urlThe url of the request
string$responseElementThe selector of the HTML element displaying the answer
array$parametersdefault : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)
Returns
$this

Definition at line 75 of file HtmlMessage.php.

◆ run()

run ( JsUtils  $js)

{}

See also
run()

Definition at line 100 of file HtmlMessage.php.

◆ setDismissable()

setDismissable (   $dismiss = true)

Definition at line 87 of file HtmlMessage.php.

◆ setError()

setError ( )

Definition at line 131 of file HtmlMessage.php.

◆ setHeader()

setHeader (   $header)

Definition at line 48 of file HtmlMessage.php.

◆ setIcon()

setIcon (   $icon)

Definition at line 52 of file HtmlMessage.php.

◆ setMessage()

setMessage (   $message)

Definition at line 139 of file HtmlMessage.php.

◆ setState()

setState (   $visible = true)

Definition at line 112 of file HtmlMessage.php.

◆ setStyle()

setStyle (   $style)

Definition at line 127 of file HtmlMessage.php.

◆ setVariation()

setVariation (   $value = "floating")

Definition at line 120 of file HtmlMessage.php.

◆ setWarning()

setWarning ( )

Definition at line 135 of file HtmlMessage.php.

Field Documentation

◆ $close

$close
protected

Definition at line 23 of file HtmlMessage.php.

◆ $icon

$icon
protected

Definition at line 21 of file HtmlMessage.php.


The documentation for this class was generated from the following file: