Inheritance diagram for Widget:

Collaboration diagram for Widget:

Public Member Functions
	__construct ($identifier, $model, $modelInstance=NULL)

	show ($modelInstance)

	getModel ()

	setModel ($_model)

	getInstanceViewer ()

	setInstanceViewer ($_instanceViewer)

	getHtmlComponent ()

	setAttached ($value=true)

	afterCompile ($index, $callback)
	Associates a $callback function after the compilation of the field at $index position The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position. More...

	setColor ($color)

	setCaptions ($captions)

	setCaption ($index, $caption)

	setFields ($fields)

	addField ($field, $key=null)

	addFields ($fields)

	countFields ()

	addMessage ($attributes=NULL, $fieldName="message")

	addErrorMessage ()

	insertField ($index, $field, $key=null)

	insertInField ($index, $field, $key=null)

	setValueFunction ($index, $callback)
	Defines the function which displays the field value. More...

	setIdentifierFunction ($callback)

	getToolbar ()

	addInToolbar ($element, $callback=NULL)
	Adds a new element in toolbar. More...

	addItemInToolbar ($caption, $icon=NULL, $callback=NULL)

	addItemsInToolbar (array $items, $callback=NULL)

	addDropdownInToolbar ($value, $items, $callback=NULL)

	addButtonInToolbar ($caption, $cssStyle=null, $callback=NULL)

	addButtonsInToolbar (array $captions, $asIcon=false, $callback=NULL)

	addLabelledIconButtonInToolbar ($caption, $icon, $before=true, $labeled=false)

	addSubmitInToolbar ($identifier, $value, $cssStyle=NULL, $url=NULL, $responseElement=NULL, $parameters=NULL)

	setCaptionCallback ($captionCallback)
	Defines a callback function to call for modifying captions function parameters 0are. More...

	setEdition ($_edition=true)
	Makes the input fields editable. More...

	setDefaultValueFunction ($defaultValueFunction)
	Defines the default function which displays fields value. More...

	getDefaultValueFunction ()

	jsDisabled ($disable=true)

	addEditButtonInToolbar ($caption, $callback=NULL)

	setToolbar (HtmlMenu $_toolbar)

	setToolbarPosition ($_toolbarPosition)

	getForm ()

	run (JsUtils $js)

	setValidationParams (array $_validationParams)
	Sets the parameters for the Form validation (on, inline, delay...) More...

	moveFieldTo ($from, $to)

	swapFields ($index1, $index2)

	removeField ($index)

	asModal ($header=null)

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

	getModelInstance ()

	hasRules ()

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 Member Functions
	_init ($instanceViewer, $contentKey, $content, $edition)

	_getIndex ($fieldName)

	_getFieldIdentifier ($prefix, $name="")

	_getFieldName ($index)

	_getFieldCaption ($index)

	_setToolbarPosition ($table, $captions=NULL)

	runForm (JsUtils $js)

	_compileForm ()

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)

Protected Attributes
	$_model

	$_modelInstance

	$_instanceViewer

	$_toolbar

	$_toolbarPosition

	$_edition

	$_form

	$_generated

	$_runned

	$_hasRules

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

Detailed Description

Definition at line 22 of file Widget.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$model,
		$modelInstance = `NULL`
	)

Definition at line 69 of file Widget.php.

Member Function Documentation

◆ _compileForm()

_compileForm ( )

protected

Definition at line 481 of file Widget.php.

◆ _getFieldCaption()

_getFieldCaption ( $index )

protected

Definition at line 114 of file Widget.php.

◆ _getFieldIdentifier()

_getFieldIdentifier	(	$prefix,
		$name = `""`
	)

protected

Definition at line 106 of file Widget.php.

◆ _getFieldName()

_getFieldName ( $index )

protected

Definition at line 110 of file Widget.php.

◆ _getIndex()

_getIndex ( $fieldName )

protected

Parameters

int | string $fieldName

Returns: int|string|boolean

Definition at line 97 of file Widget.php.

◆ _init()

_init	(	$instanceViewer,
		$contentKey,
		$content,
		$edition
	)

protected

Definition at line 82 of file Widget.php.

◆ _setToolbarPosition()

_setToolbarPosition	(	$table,
		$captions = `NULL`
	)

abstractprotected

◆ addButtonInToolbar()

addButtonInToolbar	(	$caption,
		$cssStyle = `null`,
		$callback = `NULL`
	)

Parameters

string	$caption
string	$cssStyle
callable	$callback	function($element)

Returns

Definition at line 343 of file Widget.php.

◆ addButtonsInToolbar()

addButtonsInToolbar	(	array	$captions,
			$asIcon = `false`,
			$callback = `NULL`
	)

Parameters

array	$captions
boolean	$asIcon
callable	$callback	function($element)

Returns

Definition at line 356 of file Widget.php.

◆ addDropdownInToolbar()

addDropdownInToolbar	(	$value,
		$items,
		$callback = `NULL`
	)

Parameters

mixed	$value
array	$items
callable	$callback	function($element)

Returns

Definition at line 327 of file Widget.php.

◆ addEditButtonInToolbar()

addEditButtonInToolbar	(	$caption,
		$callback = `NULL`
	)

Parameters

string	$caption
callable	$callback	function($element)

Returns

Definition at line 440 of file Widget.php.

◆ addErrorMessage()

addErrorMessage ( )

Definition at line 208 of file Widget.php.

◆ addField()

addField	(	$field,
		$key = `null`
	)

Definition at line 188 of file Widget.php.

◆ addFields()

addFields ( $fields )

Definition at line 193 of file Widget.php.

◆ addInToolbar()

addInToolbar	(	$element,
		$callback = `NULL`
	)

Adds a new element in toolbar.

Parameters

mixed	$element
callable	$callback	function to call on $element

Returns

Definition at line 269 of file Widget.php.

◆ addItemInToolbar()

addItemInToolbar	(	$caption,
		$icon = `NULL`,
		$callback = `NULL`
	)

Parameters

string	$caption
string	$icon
callable	$callback	function($element)

Returns

Definition at line 292 of file Widget.php.

◆ addItemsInToolbar()

addItemsInToolbar	(	array	$items,
			$callback = `NULL`
	)

Parameters

array	$items
callable	$callback	function($element)

Returns

Definition at line 306 of file Widget.php.

◆ addLabelledIconButtonInToolbar()

addLabelledIconButtonInToolbar	(	$caption,
		$icon,
		$before = `true`,
		$labeled = `false`
	)

Parameters

string	$caption
string	$icon
boolean	$before
boolean	$labeled

Returns

Definition at line 369 of file Widget.php.

◆ addMessage()

addMessage	(	$attributes = `NULL`,
		$fieldName = `"message"`
	)

Definition at line 202 of file Widget.php.

◆ addSubmitInToolbar()

addSubmitInToolbar	(	$identifier,
		$value,
		$cssStyle = `NULL`,
		$url = `NULL`,
		$responseElement = `NULL`,
		$parameters = `NULL`
	)

Definition at line 375 of file Widget.php.

◆ addToProperty()

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

Definition at line 530 of file Widget.php.

◆ afterCompile()

afterCompile	(	$index,
		$callback
	)

Associates a $callback function after the compilation of the field at $index position The $callback function can take the following arguments : $field=>the compiled field, $instance : the active instance of the object, $index: the field position.

Parameters

int	$index	postion of the compiled field
callable	$callback	function called after the field compilation

Returns: Widget

Definition at line 161 of file Widget.php.

◆ asModal()

asModal ( $header = null )

Definition at line 521 of file Widget.php.

◆ countFields()

countFields ( )

Definition at line 198 of file Widget.php.

◆ getDefaultValueFunction()

getDefaultValueFunction ( )

Returns: callable

Definition at line 420 of file Widget.php.

◆ getForm()

getForm ( )

Definition at line 458 of file Widget.php.

◆ getHtmlComponent()

getHtmlComponent ( )

abstract

◆ getInstanceViewer()

getInstanceViewer ( )

Definition at line 136 of file Widget.php.

◆ getModel()

getModel ( )

Definition at line 127 of file Widget.php.

◆ getModelInstance()

getModelInstance ( )

Returns: mixed

Definition at line 538 of file Widget.php.

◆ getToolbar()

getToolbar ( )

Returns

Definition at line 254 of file Widget.php.

◆ hasRules()

hasRules ( )

Returns: mixed true if widget has validation rules

Definition at line 546 of file Widget.php.

◆ insertField()

insertField	(	$index,
		$field,
		$key = `null`
	)

Definition at line 214 of file Widget.php.

◆ insertInField()

insertInField	(	$index,
		$field,
		$key = `null`
	)

Definition at line 220 of file Widget.php.

◆ jsDisabled()

jsDisabled ( $disable = true )

Parameters

string | boolean $disable

Returns: string

Definition at line 429 of file Widget.php.

◆ moveFieldTo()

moveFieldTo	(	$from,
		$to
	)

Definition at line 503 of file Widget.php.

◆ removeField()

removeField ( $index )

Definition at line 513 of file Widget.php.

◆ run()

run ( JsUtils $js )

Definition at line 466 of file Widget.php.

◆ runForm()

runForm ( JsUtils $js )

protected

Definition at line 473 of file Widget.php.

◆ setAttached()

setAttached ( $value = true )

Definition at line 147 of file Widget.php.

◆ setCaption()

setCaption	(	$index,
		$caption
	)

Definition at line 178 of file Widget.php.

◆ setCaptionCallback()

setCaptionCallback ( $captionCallback )

Defines a callback function to call for modifying captions function parameters 0are.

captions: the captions to modify and

instance: the active model instance

Parameters

callable $captionCallback

Returns: Widget

Definition at line 388 of file Widget.php.

◆ setCaptions()

setCaptions ( $captions )

Definition at line 173 of file Widget.php.

◆ setColor()

setColor ( $color )

Definition at line 169 of file Widget.php.

◆ setDefaultValueFunction()

setDefaultValueFunction ( $defaultValueFunction )

Defines the default function which displays fields value.

Parameters

callable $defaultValueFunction function parameters are : $name : the field name, $value : the field value ,$index : the field index, $instance : the active instance of model

Returns

Definition at line 411 of file Widget.php.

◆ setEdition()

setEdition ( $_edition = true )

Makes the input fields editable.

Parameters

boolean $_edition

Returns

Definition at line 399 of file Widget.php.

◆ setFields()

setFields ( $fields )

Definition at line 183 of file Widget.php.

◆ setIdentifierFunction()

setIdentifierFunction ( $callback )

Definition at line 245 of file Widget.php.

◆ setInstanceViewer()

setInstanceViewer ( $_instanceViewer )

Definition at line 140 of file Widget.php.

◆ setModel()

setModel ( $_model )

Definition at line 131 of file Widget.php.

◆ setToolbar()

setToolbar ( HtmlMenu $_toolbar )

Definition at line 448 of file Widget.php.

◆ setToolbarPosition()

setToolbarPosition ( $_toolbarPosition )

Definition at line 453 of file Widget.php.

◆ setValidationParams()

setValidationParams ( array $_validationParams )

Sets the parameters for the Form validation (on, inline, delay...)

Parameters

array $_validationParams example : ["on"=>"blur","inline"=>true]

Returns: Widget

See also: https://semantic-ui.com/behaviors/form.html#/settings

Definition at line 498 of file Widget.php.

◆ setValueFunction()

setValueFunction	(	$index,
		$callback
	)

Defines the function which displays the field value.

Parameters

int \| string	$index	index or name of the field to display
callable	$callback	function parameters are : $value : the field value, $instance : the active instance of model, $fieldIndex : the field index, $rowIndex : the row index

Returns: Widget

Definition at line 237 of file Widget.php.

◆ show()

show ( $modelInstance )

Definition at line 120 of file Widget.php.

◆ swapFields()

swapFields	(	$index1,
		$index2
	)

Definition at line 507 of file Widget.php.

Field Documentation

◆ $_edition

$_edition

protected

Definition at line 55 of file Widget.php.

◆ $_form

$_form

protected

Definition at line 61 of file Widget.php.

◆ $_generated

$_generated

protected

Definition at line 63 of file Widget.php.

◆ $_hasRules

$_hasRules

protected

Definition at line 67 of file Widget.php.

◆ $_instanceViewer

$_instanceViewer

protected

Definition at line 37 of file Widget.php.

◆ $_model

$_model

protected

Definition at line 29 of file Widget.php.

◆ $_modelInstance

$_modelInstance

protected

Definition at line 31 of file Widget.php.

◆ $_runned

$_runned

protected

Definition at line 65 of file Widget.php.

◆ $_toolbar

$_toolbar

protected

Definition at line 43 of file Widget.php.

◆ $_toolbarPosition

$_toolbarPosition

protected

Definition at line 49 of file Widget.php.

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

Ajax/common/Widget.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _compileForm()

◆ _getFieldCaption()

◆ _getFieldIdentifier()

◆ _getFieldName()

◆ _getIndex()

◆ _init()

◆ _setToolbarPosition()

◆ addButtonInToolbar()

◆ addButtonsInToolbar()

◆ addDropdownInToolbar()

◆ addEditButtonInToolbar()

◆ addErrorMessage()

◆ addField()

◆ addFields()

◆ addInToolbar()

◆ addItemInToolbar()

◆ addItemsInToolbar()

◆ addLabelledIconButtonInToolbar()

◆ addMessage()

◆ addSubmitInToolbar()

◆ addToProperty()

◆ afterCompile()

◆ asModal()

◆ countFields()

◆ getDefaultValueFunction()

◆ getForm()

◆ getHtmlComponent()

◆ getInstanceViewer()

◆ getModel()

◆ getModelInstance()

◆ getToolbar()

◆ hasRules()

◆ insertField()

◆ insertInField()

◆ jsDisabled()

◆ moveFieldTo()

◆ removeField()

◆ run()

◆ runForm()

◆ setAttached()

◆ setCaption()

◆ setCaptionCallback()

◆ setCaptions()

◆ setColor()

◆ setDefaultValueFunction()

◆ setEdition()

◆ setFields()

◆ setIdentifierFunction()

◆ setInstanceViewer()

◆ setModel()

◆ setToolbar()

◆ setToolbarPosition()

◆ setValidationParams()

◆ setValueFunction()

◆ show()

◆ swapFields()

Field Documentation

◆ $_edition

◆ $_form

◆ $_generated

◆ $_hasRules

◆ $_instanceViewer

◆ $_model

◆ $_modelInstance

◆ $_runned

◆ $_toolbar

◆ $_toolbarPosition