HtmlForm Class Reference

Semantic Form component. More...

Inheritance diagram for HtmlForm:

Public Member Functions
	__construct ($identifier, $elements=array())
	addHeader ($title, $niveau=1, $dividing=true)
	addDivider ($caption=NULL)
	Adds a divider.
	addFields ($fields=NULL, $label=NULL)
	Adds a group of fields.
	addItem ($item)
	adds and returns an item
	getField ($index)
	setEqualWidth ()
	automatically divide fields to be equal width
	addField ($field)
	Adds a field (alias for addItem)
	addMessage ($identifier, $content, $header=NULL, $icon=NULL, $type=NULL)
	compile (JsUtils $js=NULL, &$view=NULL)
	run (JsUtils $js)
	Parameters JsUtils $js Returns SimpleExtComponent See also \Ajax\common\html\BaseHtmlrun() See also \Ajax\common\html\BaseHtmlrun() See also \Ajax\common\html\BaseHtmlrun()
	getExtraFieldValidation ($fieldname)
	addValidationParam ($paramName, $paramValue, $before="", $after="")
	setValidationParams (array $_validationParams)
	hasValidationParams ()
	getValidationParams ()
	removeValidationParam ($param)
Public Member Functions inherited from HtmlSemCollection
	__construct ( $identifier, $tagName="div", $baseClass="")
Public Member Functions inherited from HtmlCollection
	addItems ($items)
	setItems ($items)
	getItems ()
	insertItem ($item, $position=0)
	getItem ($index)
	Return the item at index.
	setItem ($index, $value)
	removeItem ($index)
	count ()
	fromDatabaseObject ($object, $function)
	apply ($callBack)
	fromArray ($array)
	setProperties ($properties)
	setPropertyValues ($property, $values)
	Sets the values of a property for each item in the collection.
	addPropertyValues ($property, $values)
	Adds the values of a property for each item in the collection.
	getItemById ($identifier)
	asLinks ($hrefs=[], $target=NUll)
	splice ($offset, $length=null)
	Remove a portion of the items array and replace it with something else.
Public Member Functions inherited from HtmlDoubleElement
	setContent ($content)
	getContent ()
	addContent ($content, $before=false)
	setValue ($value)
	wrapContent ($before, $after="")
	wrapWith (HtmlDoubleElement $container)
	Wraps the element with a container.
	getContentInstances ($class)
	asLink ($href=NULL, $target=NULL)
	Transforms the element into a link.
	getTextContent ()
	asEditable (HtmlFormField $field, $asForm=false, $setValueProperty="val()")
Public Member Functions inherited from HtmlSingleElement
	setClass ($classNames)
	addClass ($classNames)
	setRole ($value)
	setTitle ($value)
	setStyle ($value)
	setSize ($size)
Public Member Functions inherited from BaseHtml
	getTagName ()
	setTagName ($tagName)
	fromDatabaseObjects ($objects, $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 ()
	jsHide ()
	jsToggle ($value)
	getEvents ()
Public Member Functions inherited from BaseHtmlPropertiesTrait
	getProperties ()
	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)
	addContent ($content, $before=false)
	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)
	setInverted ($recursive=true)
	can be formatted to appear on dark backgrounds
	setCircular ()
	setFloated ($direction="right")
	floatRight ()
	floatLeft ()
	getBaseClass ()
	getVariations ()
	getStates ()
Public Member Functions inherited from FieldsTrait
	getItem ($index)
	count ()
	addInputs ($inputs, $fieldslabel=null)
	setFieldsPropertyValues ($property, $values)
	Sets the values of a property for each Field of each item in the collection.
	addFieldRule ($index, $type, $prompt=NULL, $value=NULL)
	addFieldRules ($index, $rules)
	addDropdown ($identifier, $items=array(), $label=NULL, $value=NULL, $multiple=false)
	Adds a new dropdown element.
	addButtonGroups ($identifier, $elements=[], $asIcons=false)
	Adds a new button groups.
	addDropdownButton ($identifier, $value, $items=[], $asCombo=false, $icon=null)
	Adds a button with a dropdown button.
	addInput ($identifier, $label=NULL, $type="text", $value=NULL, $placeholder=NULL)
	addTextarea ($identifier, $label, $value=NULL, $placeholder=NULL, $rows=5)
	addPassword ($identifier, $label=NULL)
	addButton ($identifier, $value, $cssStyle=NULL, $onClick=NULL)
	addButtonIcon ($identifier, $icon, $cssStyle=NULL, $onClick=NULL)
	addCheckbox ($identifier, $label=NULL, $value=NULL, $type=NULL)
	addRadio ($identifier, $name, $label=NULL, $value=NULL)
	addElement ($identifier, $content, $label, $tagName="div", $baseClass="")
Public Member Functions inherited from FormTrait
	setLoading ()
	setState ($state)
	setAttached ($value=true)
	addErrorMessage ()
	jsState ($state)
	submitOn ($event, $identifierOrElement, $url, $responseElement, $parameters=NULL)
	submitOnClick ($identifier, $url, $responseElement, $parameters=NULL)
	addSubmit ($identifier, $value, $cssStyle=NULL, $url=NULL, $responseElement=NULL, $parameters=NULL)
	setSubmitParams ($url, $responseElement=NULL, $parameters=NULL)
	addReset ($identifier, $value, $cssStyle=NULL)
	onValid ($jsCode)
	Callback on each valid field.
	onSuccess ($jsCode)
	Callback if a form is all valid.
	addExtraFieldRules ($fieldname, $rules)
	addExtraFieldRule ($fieldname, $type, $prompt=NULL, $value=NULL)
	setOptional ($fieldname, $optional=true)
	setActionTarget (string $action, string $target)

Protected Member Functions
	getForm ()
Protected Member Functions inherited from HtmlCollection
	getItemToAdd ($item)
	setItemIdentifier ($item, $classname, $index)
	createItem ($value)
	The item factory.
	createCondition ($value)
	contentAs ($tagName)
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="")
Protected Member Functions inherited from FieldsTrait
	createItem ($value)
	createCondition ($value)
Protected Member Functions inherited from FormTrait
	addCompoValidation (Form $compo, HtmlFormField $field)
	addExtraCompoValidation (Form $compo, FieldValidation $validation)
	_runValidationParams (Form &$compo, JsUtils $js=NULL)
	_compileAjaxSubmit ($ajaxSubmit, JsUtils $js=null)
	_buttonAsSubmit (BaseHtml &$button, $event, $url, $responseElement=NULL, $parameters=NULL)

Protected Attributes
	$_fields
	$_validationParams
	$_extraFieldRules
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

Detailed Description

Semantic Form component.

See also

http://semantic-ui.com/collections/form.html

Author

jc

Version

1.001

Definition at line 24 of file HtmlForm.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$identifier,
			$elements = array()
	)

Reimplemented from HtmlCollection.

Definition at line 37 of file HtmlForm.php.

Member Function Documentation

addDivider()

addDivider

(

$caption = NULL

)

Adds a divider.

Parameters

string

$caption

Returns

HtmlForm

Definition at line 69 of file HtmlForm.php.

addField()

addField

(

$field

)

Adds a field (alias for addItem)

Parameters

HtmlFormField

$field

Returns

HtmlDoubleElement

Definition at line 138 of file HtmlForm.php.

addFields()

addFields	(		$fields = NULL,
			$label = NULL
	)

Adds a group of fields.

Parameters

array	$fields
string	$label

Returns

HtmlFormFields

Reimplemented from FieldsTrait.

Definition at line 79 of file HtmlForm.php.

addHeader()

addHeader	(		$title,
			$niveau = 1,
			$dividing = true
	)

Parameters

string	$title
number	$niveau
string	$dividing

Returns

HtmlHeader

Definition at line 57 of file HtmlForm.php.

addItem()

addItem

(

$item

)

adds and returns an item

Parameters

HtmlDoubleElement | string | array

$item

Returns

\Ajax\common\html\HtmlDoubleElement

Reimplemented from HtmlCollection.

Definition at line 104 of file HtmlForm.php.

addMessage()

addMessage	(		$identifier,
			$content,
			$header = NULL,
			$icon = NULL,
			$type = NULL
	)

Parameters

string	$identifier
string	$content
string	$header
string	$icon
string	$type

Returns

HtmlMessage

Definition at line 151 of file HtmlForm.php.

addValidationParam()

addValidationParam	(		$paramName,
			$paramValue,
			$before = "",
			$after = ""
	)

Definition at line 205 of file HtmlForm.php.

compile()

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

Reimplemented from HtmlCollection.

Definition at line 164 of file HtmlForm.php.

getExtraFieldValidation()

getExtraFieldValidation

(

$fieldname

)

Definition at line 198 of file HtmlForm.php.

getField()

getField

(

$index

)

Parameters

int

$index

Returns

mixed|NULL|BaseHtml

Definition at line 116 of file HtmlForm.php.

getForm()

getForm ( )

protected

Returns

HtmlForm

Reimplemented from FormTrait.

Definition at line 47 of file HtmlForm.php.

getValidationParams()

getValidationParams

(

)

Definition at line 219 of file HtmlForm.php.

hasValidationParams()

hasValidationParams

(

)

Definition at line 215 of file HtmlForm.php.

removeValidationParam()

removeValidationParam

(

$param

)

Definition at line 223 of file HtmlForm.php.

run()

run

(

JsUtils

$js

)

Parameters

JsUtils

$js

Returns

SimpleExtComponent

See also

\Ajax\common\html\BaseHtmlrun()

See also

\Ajax\common\html\BaseHtmlrun()

See also

\Ajax\common\html\BaseHtmlrun()

See also

\Ajax\common\html\BaseHtml::run()

Reimplemented from HtmlSemCollection.

Definition at line 170 of file HtmlForm.php.

setEqualWidth()

setEqualWidth

(

)

automatically divide fields to be equal width

Returns

HtmlForm

Definition at line 129 of file HtmlForm.php.

setValidationParams()

setValidationParams

(

array

$_validationParams

)

Definition at line 210 of file HtmlForm.php.

Field Documentation

$_extraFieldRules

$_extraFieldRules

protected

Definition at line 35 of file HtmlForm.php.

$_fields

$_fields

protected

Definition at line 28 of file HtmlForm.php.

$_validationParams

$_validationParams

protected

Definition at line 33 of file HtmlForm.php.

---

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

• Ajax/semantic/html/collections/form/HtmlForm.php