Inheritance diagram for HtmlModal:

Collaboration diagram for HtmlModal:

Public Member Functions
	__construct ($identifier, $header='', $content='', $actions=null)

	setHeader ($value)

	setContent ($value)

	setActions ($actions)
	Adds the modal actions (buttons). More...

	addAction ($action)

	getAction ($index)

	addContent ($content, $before=false)

	addImageContent ($image, $description=NULL)

	addIconContent ($icon, $description=NULL)

	showDimmer ($value)

	setInverted ($recursive=true)

	setBasic ()

	setTransition ($value)

	renderView (JsUtils $js, $initialController, $viewName, $params=array())
	render the content of an existing view : $controller/$action and set the response to the modal content More...

	forward (JsUtils $js, $initialControllerInstance, $controllerName, $actionName, $params=NULL)
	render the content of More...

	compile (JsUtils $js=NULL, &$view=NULL)
	{} More...

	run (JsUtils $js)

	jsDo ($behavior)

	jsHide ()

	onHidden ($js)

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
	$_params = []

	$_paramParts = []

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

Private Member Functions
	addElementInPart ($element, $part)

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

Author: jc

Definition at line 17 of file HtmlModal.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$header = `''`,
		$content = `''`,
		$actions = `null`
	)

Definition at line 23 of file HtmlModal.php.

Member Function Documentation

◆ addAction()

addAction ( $action )

Parameters

string | BaseHtml $action

Returns: HtmlButton

Definition at line 70 of file HtmlModal.php.

◆ addContent()

addContent	(	$content,
		$before = `false`
	)

Definition at line 103 of file HtmlModal.php.

◆ addElementInPart()

addElementInPart	(	$element,
		$part
	)

private

Definition at line 136 of file HtmlModal.php.

◆ addIconContent()

addIconContent	(	$icon,
		$description = `NULL`
	)

Definition at line 122 of file HtmlModal.php.

◆ addImageContent()

addImageContent	(	$image,
		$description = `NULL`
	)

Definition at line 108 of file HtmlModal.php.

◆ compile()

compile	(	JsUtils	$js = `NULL`,
		&	$view = `NULL`
	)

{}

See also: ::compile()

Definition at line 200 of file HtmlModal.php.

◆ forward()

forward	(	JsUtils	$js,
			$initialControllerInstance,
			$controllerName,
			$actionName,
			$params = `NULL`
	)

render the content of

$controller::$action and set the response to the modal content

Parameters

JsUtils	$js
object	$initialControllerInstance
string	$controllerName	the controller name
string	$actionName	the action name
array	$params

Definition at line 190 of file HtmlModal.php.

◆ getAction()

getAction ( $index )

Parameters

int $index

Returns: HtmlButton

Definition at line 99 of file HtmlModal.php.

◆ jsDo()

jsDo ( $behavior )

Definition at line 223 of file HtmlModal.php.

◆ jsHide()

jsHide ( )

Definition at line 227 of file HtmlModal.php.

◆ onHidden()

onHidden ( $js )

Definition at line 231 of file HtmlModal.php.

◆ renderView()

renderView	(	JsUtils	$js,
			$initialController,
			$viewName,
			$params = `array()`
	)

render the content of an existing view : $controller/$action and set the response to the modal content

Parameters

JsUtils	$js
object	$initialController
string	$viewName
array	$params	The parameters to pass to the view

Definition at line 175 of file HtmlModal.php.

◆ run()

run ( JsUtils $js )

Definition at line 216 of file HtmlModal.php.

◆ setActions()

setActions ( $actions )

Adds the modal actions (buttons).

Parameters

string | array $actions

Returns: HtmlButton[]

Definition at line 52 of file HtmlModal.php.

◆ setBasic()

setBasic ( )

Definition at line 154 of file HtmlModal.php.

◆ setContent()

setContent ( $value )

Definition at line 41 of file HtmlModal.php.

◆ setHeader()

setHeader ( $value )

Definition at line 36 of file HtmlModal.php.

◆ setInverted()

setInverted ( $recursive = true )

Definition at line 149 of file HtmlModal.php.

◆ setTransition()

setTransition ( $value )

Definition at line 158 of file HtmlModal.php.

◆ showDimmer()

showDimmer ( $value )

Definition at line 141 of file HtmlModal.php.

Field Documentation

◆ $_paramParts

$_paramParts = []

protected

Definition at line 21 of file HtmlModal.php.

◆ $_params

$_params = []

protected

Definition at line 19 of file HtmlModal.php.

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

Ajax/semantic/html/modules/HtmlModal.php

Public Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addAction()

◆ addContent()

◆ addElementInPart()

◆ addIconContent()

◆ addImageContent()

◆ compile()

◆ forward()

◆ getAction()

◆ jsDo()

◆ jsHide()

◆ onHidden()

◆ renderView()

◆ run()

◆ setActions()

◆ setBasic()

◆ setContent()

◆ setHeader()

◆ setInverted()

◆ setTransition()

◆ showDimmer()

Field Documentation

◆ $_paramParts

◆ $_params