Base class for Html collections. More...

Inheritance diagram for HtmlCollection:

Public Member Functions

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

addItems ($items)

setItems ($items)

getItems ()

addItem ($item)

adds and returns an item

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.

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

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)

run (JsUtils $js)

Parameters

JsUtils $js

Returns: SimpleExtComponent

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

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)

Protected Member Functions
	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)

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

Detailed Description

Base class for Html collections.

Author: jc

Version: 1.001

Definition at line 15 of file HtmlCollection.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$tagName = `"div"`
	)

Reimplemented from HtmlDoubleElement.

Reimplemented in HtmlAccordionMenu, HtmlIconMenu, HtmlLabeledIconMenu, HtmlPaginationMenu, HtmlSegmentGroups, HtmlShape, HtmlStep, HtmlCardGroups, HtmlForm, HtmlItems, HtmlList, HtmlMenu, HtmlList, and HtmlTab.

Definition at line 17 of file HtmlCollection.php.

Member Function Documentation

◆ addItem()

addItem ( $item )

adds and returns an item

Parameters

HtmlDoubleElement | string | array $item

Returns: \Ajax\common\html\HtmlDoubleElement

Reimplemented in HtmlForm, HtmlFormFields, HtmlBreadcrumb, and HtmlMenu.

Definition at line 65 of file HtmlCollection.php.

◆ addItems()

addItems ( $items )

Definition at line 22 of file HtmlCollection.php.

◆ addPropertyValues()

addPropertyValues	(	$property,
		$values
	)

Adds the values of a property for each item in the collection.

Parameters

string	$property
array \| mixed	$values

Returns: $this

Definition at line 182 of file HtmlCollection.php.

◆ apply()

apply ( $callBack )

Reimplemented in HtmlTR.

Definition at line 111 of file HtmlCollection.php.

◆ asLinks()

asLinks	(	$hrefs = `[]`,
		$target = `NUll`
	)

Parameters

array	$hrefs
string	$target

Returns: HtmlCollection

Reimplemented in HtmlList.

Definition at line 215 of file HtmlCollection.php.

◆ compile()

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

Reimplemented from BaseHtml.

Reimplemented in HtmlForm, HtmlFormFields, HtmlBreadcrumb, HtmlPaginationMenu, HtmlGridRow, HtmlList, HtmlStep, HtmlShape, and HtmlTab.

Definition at line 197 of file HtmlCollection.php.

◆ contentAs()

contentAs ( $tagName )

protected

Definition at line 136 of file HtmlCollection.php.

◆ count()

count ( )

Definition at line 100 of file HtmlCollection.php.

◆ createCondition()

createCondition ( $value )

protected

Reimplemented in HtmlDatalist, HtmlIconGroups, HtmlLabelGroups, HtmlSegmentGroups, HtmlAccordion, and HtmlShape.

Definition at line 132 of file HtmlCollection.php.

◆ createItem()

createItem ( $value )

abstractprotected

The item factory.

Parameters

mixed $value

Reimplemented in HtmlList, HtmlBreadcrumb, HtmlGrid, HtmlAccordionMenu, HtmlIconMenu, HtmlLabeledIconMenu, HtmlMenu, HtmlGridRow, HtmlTableContent, HtmlTR, HtmlViewGroups, HtmlDatalist, HtmlButtonGroups, HtmlIconGroups, HtmlLabelGroups, HtmlList, HtmlSegmentGroups, HtmlStep, HtmlAccordion, HtmlShape, and HtmlTab.

◆ fromArray()

fromArray ( $array )

Reimplemented from HtmlSingleElement.

Reimplemented in HtmlButtonGroups.

Definition at line 122 of file HtmlCollection.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from BaseHtml.

Reimplemented in HtmlMenu, HtmlViewGroups, and HtmlButtonGroups.

Definition at line 107 of file HtmlCollection.php.

◆ getItem()

getItem ( $index )

Return the item at index.

Parameters

int | string $index the index or the item identifier

Returns: \Ajax\common\html\HtmlDoubleElement

Reimplemented in HtmlFormFields, HtmlGrid, HtmlTableContent, HtmlTR, HtmlViewGroups, HtmlButtonGroups, HtmlIconGroups, HtmlList, and HtmlAccordion.

Definition at line 82 of file HtmlCollection.php.

◆ getItemById()

getItemById ( $identifier )

Definition at line 206 of file HtmlCollection.php.

◆ getItems()

getItems ( )

Definition at line 40 of file HtmlCollection.php.

◆ getItemToAdd()

getItemToAdd ( $item )

protected

Reimplemented in HtmlList.

Definition at line 44 of file HtmlCollection.php.

◆ insertItem()

insertItem	(	$item,
		$position = `0`
	)

Reimplemented in HtmlMenu.

Definition at line 71 of file HtmlCollection.php.

◆ removeItem()

removeItem ( $index )

Definition at line 96 of file HtmlCollection.php.

◆ setItem()

setItem	(	$index,
		$value
	)

Definition at line 91 of file HtmlCollection.php.

◆ setItemIdentifier()

setItemIdentifier	(	$item,
		$classname,
		$index
	)

protected

Definition at line 52 of file HtmlCollection.php.

◆ setItems()

setItems ( $items )

Definition at line 35 of file HtmlCollection.php.

◆ setProperties()

setProperties ( $properties )

Parameters

array $properties

Returns: $this

Reimplemented from BaseHtmlPropertiesTrait.

Definition at line 143 of file HtmlCollection.php.

◆ setPropertyValues()

setPropertyValues	(	$property,
		$values
	)

Sets the values of a property for each item in the collection.

Parameters

string	$property
array \| mixed	$values

Returns: $this

Definition at line 161 of file HtmlCollection.php.

◆ splice()

splice	(	$offset,
		$length = `null`
	)

Remove a portion of the items array and replace it with something else.

Parameters

int	$offset
int	$length	If length is omitted, removes everything from offset to the end of the array. If length is specified and is positive, then that many elements will be removed. If length is specified and is negative then the end of the removed portion will be that many elements from the end of the array. If length is specified and is zero, no elements will be removed. Tip: to remove everything from offset to the end of the array when replacement is also specified, use count($input) for length.

Returns: $this

Definition at line 233 of file HtmlCollection.php.

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

Ajax/common/html/HtmlCollection.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addItem()

◆ addItems()

◆ addPropertyValues()

◆ apply()

◆ asLinks()

◆ compile()

◆ contentAs()

◆ count()

◆ createCondition()

◆ createItem()

◆ fromArray()

◆ fromDatabaseObject()

◆ getItem()

◆ getItemById()

◆ getItems()

◆ getItemToAdd()

◆ insertItem()

◆ removeItem()

◆ setItem()

◆ setItemIdentifier()

◆ setItems()

◆ setProperties()

◆ setPropertyValues()

◆ splice()