HtmlFormFields Class Reference

Inheritance diagram for HtmlFormFields:

Public Member Functions
	__construct ($identifier, $fields=array(), $equalWidth=true)
	addFields ($fields=NULL, $label=NULL)
	setLabel ($label)
	addItem ($item)
	adds and returns an item
	getItem ($index)
	compile (JsUtils $js=NULL, &$view=NULL)
	setWidth ($index, $width)
	setInline ()
	setGrouped ()
	getName ()
	setName ($_name)
	setEqualWidth ($_equalWidth)
	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()
Public Member Functions inherited from HtmlCollection
	__construct ($identifier, $tagName="div")
	addItems ($items)
	setItems ($items)
	getItems ()
	insertItem ($item, $position=0)
	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
	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="")

Static Public Member Functions
static	radios ($identifier, $name, $items=array(), $label=NULL, $value=null, $type=NULL)
static	checkeds ($identifier, $name, $items=array(), $label=NULL, $values=array(), $type=NULL)

Protected Attributes
	$_equalWidth
	$_name
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

Additional Inherited Members
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)

Detailed Description

Definition at line 12 of file HtmlFormFields.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$identifier,
			$fields = array(),
			$equalWidth = true
	)

Reimplemented from HtmlSemCollection.

Definition at line 16 of file HtmlFormFields.php.

Member Function Documentation

addFields()

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

Reimplemented from FieldsTrait.

Definition at line 22 of file HtmlFormFields.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 56 of file HtmlFormFields.php.

checkeds()

static checkeds (   $identifier,   $name,   $items = array(),   $label = NULL,   $values = array(),   $type = NULL  )

static

Definition at line 125 of file HtmlFormFields.php.

compile()

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

Reimplemented from HtmlCollection.

Definition at line 70 of file HtmlFormFields.php.

getItem()

getItem

(

$index

)

Returns

HtmlFormField

Reimplemented from HtmlCollection.

Definition at line 66 of file HtmlFormFields.php.

getName()

getName

(

)

Definition at line 95 of file HtmlFormFields.php.

radios()

static radios (   $identifier,   $name,   $items = array(),   $label = NULL,   $value = null,   $type = NULL  )

static

Definition at line 105 of file HtmlFormFields.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 147 of file HtmlFormFields.php.

setEqualWidth()

setEqualWidth

(

$_equalWidth

)

Definition at line 142 of file HtmlFormFields.php.

setGrouped()

setGrouped

(

)

Definition at line 90 of file HtmlFormFields.php.

setInline()

setInline

(

)

Definition at line 84 of file HtmlFormFields.php.

setLabel()

setLabel

(

$label

)

Parameters

string | HtmlSemDoubleElement

$label

Returns

\Ajax\semantic\html\base\HtmlSemDoubleElement

Definition at line 47 of file HtmlFormFields.php.

setName()

setName

(

$_name

)

Definition at line 99 of file HtmlFormFields.php.

setWidth()

setWidth	(		$index,
			$width
	)

Definition at line 79 of file HtmlFormFields.php.

Field Documentation

$_equalWidth

$_equalWidth

protected

Definition at line 13 of file HtmlFormFields.php.

$_name

$_name

protected

Definition at line 14 of file HtmlFormFields.php.

---

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

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