Inheritance diagram for HtmlModal:

Public Member Functions

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

setHeader ($value)

setContent ($value)

setActions ($actions)

Adds the modal actions (buttons).

addAction ($action)

getAction ($index)

addContent ($content, $before=false)

addImageContent ($image, $description=NULL)

addIconContent ($icon, $description=NULL)

showDimmer ($value)

setInverted ($recursive=true)

can be formatted to appear on dark backgrounds

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

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

render the content of

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

{{}

See also: BaseHtml::compile()

}

run (JsUtils $js)

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

}

See also: HtmlDoubleElement::run()

}

jsDo ($behavior)

jsHide ()

onHidden ($js)

Public Member Functions inherited from HtmlSemDoubleElement

setPopupAttributes ($variation=NULL, $popupEvent=NULL)

Defines the popup attributes.

addPopup ($title="", $content="", $variation=NULL, $params=array())

Adds a popup to the element.

addPopupHtml ($html="", $variation=NULL, $params=array())

Adds an html popup to the element.

addDimmer ($params=array(), $content=NULL)

Adds a Dimmer to the element.

addLabel ($label, $before=false, $icon=NULL)

Adds a label to the element.

attachLabel ($label, $side=Side::TOP, $direction=Direction::NONE, $icon=NULL)

Adds an attached label to the element.

asLink ($href=NULL, $target=NULL)

Transforms the element into a link.

jsShowDimmer ($show=true)

Returns the script displaying the dimmer.

addList ($items, $ordered=false)

asToast ($params=NULL)

asSideBar ($classes='')

Public Member Functions inherited from HtmlDoubleElement

__construct ($identifier, $tagName="p")

getContent ()

setValue ($value)

wrapContent ($before, $after="")

wrapWith (HtmlDoubleElement $container)

Wraps the element with a container.

getContentInstances ($class)

getTextContent ()

asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")

Public Member Functions inherited from HtmlSingleElement

setClass ($classNames)

addClass ($classNames)

setRole ($value)

setTitle ($value)

setStyle ($value)

fromArray ($array)

setSize ($size)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

fromDatabaseObjects ($objects, $function)

fromDatabaseObject ($object, $function)

wrap ($before, $after="")

getElementById ($identifier, $elements)

getBsComponent ()

setBsComponent ($bsComponent)

setDraggable ($attr="id", $dropZone=null, $parameters=[])

Sets the element draggable, and eventualy defines the dropzone (HTML5 drag and drop)

asDropZone ($jsCallback="", $jqueryDone="append", $parameters=[])

Declares the element as a drop zone (HTML5 drag and drop)

asFileDropZone ($responseElement=null, $url=null, $progress=null, $jsCallback="", $parameters=[])

Declares the element as a drop zone for file uploading (HTML5 drag and drop)

__toString ()

onPostCompile ($callback)

onPreCompile ($callback)

Public Member Functions inherited from BaseWidget

__construct ($identifier)

getIdentifier ()

setIdentifier ($identifier)

getLibraryId ()

setLibraryId ($_libraryId)

Public Member Functions inherited from BaseHtmlEventsTrait

addEvent ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

trigger ($event, $params="[]")

jsTrigger ($event, $params="[this]")

_addEvent ($event, $jsCode)

on ($event, $jsCode, $stopPropagation=false, $preventDefault=false)

onClick ($jsCode, $stopPropagation=false, $preventDefault=true)

setClick ($jsCode)

onCreate ($jsCode)

addEventsOnRun (JsUtils $js=NULL)

_ajaxOn ($operation, $event, $url, $responseElement="", $parameters=array())

getOn ($event, $url, $responseElement="", $parameters=array())

Performs a get to $url on the event $event on $element and display it in $responseElement.

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

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

postOn ($event, $url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the event $event on $element and display it in $responseElement.

postOnClick ($url, $params="{}", $responseElement="", $parameters=array())

Performs a post to $url on the click event on $element and display it in $responseElement.

postFormOn ($event, $url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax.

postFormOnClick ($url, $form, $responseElement="", $parameters=array())

Performs a post form with ajax on click.

jsDoJquery ($jqueryCall, $param="")

executeOnRun ($jsCode)

jsHtml ($content="")

jsShow ()

jsToggle ($value)

getEvents ()

Public Member Functions inherited from BaseHtmlPropertiesTrait

getProperties ()

setProperties ($properties)

setProperty ($name, $value)

getProperty ($name)

addToProperty ($name, $value, $separator=" ")

addProperties ($properties)

removePropertyValue ($name, $value)

addToPropertyCtrl ($name, $value, $typeCtrl)

addToPropertyCtrlCheck ($name, $value, $typeCtrl)

removeProperty ($name)

propertyContains ($propertyName, $value)

Public Member Functions inherited from BaseTrait

addToProperty ($name, $value, $separator=" ")

setProperty ($name, $value)

onCreate ($jsCode)

addVariation ($variation)

addState ($state)

setVariation ($variation)

setVariations ($variations)

setState ($state)

addVariations ($variations=array())

addStates ($states=array())

setStates ($states)

addIcon ($icon, $before=true)

addSticky ($context="body")

setSize ($size)

setDisabled ($disable=true)

show it is currently unable to be interacted with

setColor ($color)

setFluid ()

asHeader ()

setActive ($value=true)

show it is currently the active user selection

setAttached ($value=true)

setCircular ()

setFloated ($direction="right")

floatRight ()

floatLeft ()

getBaseClass ()

getVariations ()

getStates ()

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

Protected Attributes inherited from BaseHtmlEventsTrait
	$_events =array ()

Protected Attributes inherited from BaseHtmlPropertiesTrait
	$properties =array ()

Protected Attributes inherited from BaseTrait
	$_variations =[ ]

	$_states =[ ]

	$_baseClass

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)
	{}

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)

Protected Member Functions inherited from BaseHtmlEventsTrait
	_eventsOnCreate (JsUtils $js=NULL)

Protected Member Functions inherited from BaseHtmlPropertiesTrait
	removePropertyValues ($name, $values)

	addToPropertyUnique ($name, $value, $typeCtrl)

	setPropertyCtrl ($name, $value, $typeCtrl)

	getElementByPropertyValue ($propertyName, $value, $elements)

Protected Member Functions inherited from BaseTrait
	setPropertyCtrl ($name, $value, $typeCtrl)

	addToPropertyCtrl ($name, $value, $typeCtrl)

	addToPropertyCtrlCheck ($name, $value, $typeCtrl)

	addBehavior (&$array, $key, $value, $before="", $after="")

Detailed Description

Author: jc

Definition at line 17 of file HtmlModal.php.

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented from HtmlSemDoubleElement.

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`
	)

Reimplemented from HtmlDoubleElement.

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: BaseHtml::compile()

}

See also: \Ajax\semantic\html\base\HtmlSemDoubleElement::compile()

Reimplemented from HtmlSemDoubleElement.

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 ( )

Reimplemented from BaseHtmlEventsTrait.

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 )

{{

Parameters

JsUtils $js

Returns: SimpleExtComponent

See also: \Ajax\common\html\BaseHtmlrun()

See also: \Ajax\common\html\BaseHtmlrun()

}

See also: HtmlDoubleElement::run()

}

See also: HtmlDoubleElement::run()

Reimplemented from HtmlSemDoubleElement.

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 )

Reimplemented from HtmlDoubleElement.

Definition at line 41 of file HtmlModal.php.

◆ setHeader()

setHeader ( $value )

Definition at line 36 of file HtmlModal.php.

◆ setInverted()

setInverted ( $recursive = true )

can be formatted to appear on dark backgrounds

Reimplemented from BaseTrait.

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