Semantic UI Breadcrumb component. More...

Inheritance diagram for HtmlBreadcrumb:

Collaboration diagram for HtmlBreadcrumb:

Public Member Functions
	__construct ($identifier, $items=array(), $autoActive=true, $startIndex=0, $hrefFunction=NULL)

	autoGetOnClick ($targetSelector)
	Associate an ajax get to the breadcrumb elements, displayed in $targetSelector $this->attr member is used to build each element url. More...

	contentAsString ()

	setActive ($index=null)

	fromDispatcher (JsUtils $js, $dispatcher, $startIndex=0)
	Adds new elements in breadcrumbs corresponding to request dispatcher : controllerName, actionName, parameters. More...

	getHref ($index=null, $separator="/")
	Returns the url of the element at $index or the breadcrumbs url if $index is ommited. More...

	setHrefFunction ($_hrefFunction)
	sets the function who generates the href elements. More...

	setStartIndex ($startIndex)

	setAutoActive ($autoActive)

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

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

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

	addIconAt ($icon, $index)

	addItem ($item)

	asTexts ()

	setAbsolutePaths ($absolutePaths)

Public Member Functions inherited from HtmlSemNavElement
	__construct ($identifier, $tagName, $baseClass)

	autoGetOnClick ($targetSelector)
	Associate an ajax get to the elements, displayed in $targetSelector. More...

	contentAsString ()

	setContentDivider ($divider, $index=NULL)

	setIconContentDivider ($iconContentDivider, $index=NULL)

Public Member Functions inherited from HtmlSemCollection
	__construct ( $identifier, $tagName="div", $baseClass="")

	run (JsUtils $js)

Public Member Functions inherited from HtmlCollection
	__construct ($identifier, $tagName="div")

	addItems ($items)

	setItems ($items)

	getItems ()

	addItem ($item)
	adds and returns an item More...

	insertItem ($item, $position=0)

	getItem ($index)
	Return the item at index. More...

	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. More...

	addPropertyValues ($property, $values)
	Adds the values of a property for each item in the collection. More...

	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. More...

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
	createItem ($value)
	{} More...

Protected Member Functions inherited from HtmlSemNavElement
	setDivider ($divider, $index)

	getContentDivider ($index)

Protected Member Functions inherited from HtmlCollection
	getItemToAdd ($item)

	setItemIdentifier ($item, $classname, $index)

	createItem ($value)
	The item factory. More...

	createCondition ($value)

	contentAs ($tagName)

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
	$startIndex = 0

	$autoActive

	$absolutePaths = false

	$_hrefFunction

Protected Attributes inherited from HtmlSemNavElement
	$root

	$attr

	$_contentSeparator = ""

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

Semantic UI Breadcrumb component.

See also: http://semantic-ui.com/collections/breadcrumb.html _hrefFunction($e)

Author: jc

Version: 1.001

Definition at line 17 of file HtmlBreadcrumb.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$items = `array()`,
		$autoActive = `true`,
		$startIndex = `0`,
		$hrefFunction = `NULL`
	)

Parameters

string	$identifier
array	$items
boolean	$autoActive	sets the last element's class to active if true
callable	$hrefFunction	the function who generates the href elements. default : function($e){return $e->getContent()}

Definition at line 52 of file HtmlBreadcrumb.php.

Member Function Documentation

◆ _ajaxOn()

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

Definition at line 181 of file HtmlBreadcrumb.php.

◆ addIconAt()

addIconAt	(	$icon,
		$index
	)

Definition at line 209 of file HtmlBreadcrumb.php.

◆ addItem()

addItem ( $item )

Definition at line 217 of file HtmlBreadcrumb.php.

◆ asTexts()

asTexts ( )

Definition at line 227 of file HtmlBreadcrumb.php.

◆ autoGetOnClick()

autoGetOnClick ( $targetSelector )

Associate an ajax get to the breadcrumb elements, displayed in $targetSelector $this->attr member is used to build each element url.

Parameters

string $targetSelector the target of the get

Returns: HtmlBreadcrumb

Definition at line 74 of file HtmlBreadcrumb.php.

◆ compile()

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

Definition at line 159 of file HtmlBreadcrumb.php.

◆ contentAsString()

contentAsString ( )

Definition at line 80 of file HtmlBreadcrumb.php.

◆ createItem()

createItem ( $value )

protected

{}

See also: createItem()

Definition at line 196 of file HtmlBreadcrumb.php.

◆ fromDispatcher()

fromDispatcher	(	JsUtils	$js,
			$dispatcher,
			$startIndex = `0`
	)

Adds new elements in breadcrumbs corresponding to request dispatcher : controllerName, actionName, parameters.

Parameters

JsUtils	$js
object	$dispatcher	the request dispatcher

Returns: HtmlBreadcrumb

Definition at line 108 of file HtmlBreadcrumb.php.

◆ getHref()

getHref	(	$index = `null`,
		$separator = `"/"`
	)

Returns the url of the element at $index or the breadcrumbs url if $index is ommited.

Parameters

int	$index
string	$separator

Returns: string

Definition at line 120 of file HtmlBreadcrumb.php.

◆ on()

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

Definition at line 174 of file HtmlBreadcrumb.php.

◆ setAbsolutePaths()

setAbsolutePaths ( $absolutePaths )

Definition at line 231 of file HtmlBreadcrumb.php.

◆ setActive()

setActive ( $index = null )

Parameters

int $index

Definition at line 91 of file HtmlBreadcrumb.php.

◆ setAutoActive()

setAutoActive ( $autoActive )

Definition at line 150 of file HtmlBreadcrumb.php.

◆ setHrefFunction()

setHrefFunction ( $_hrefFunction )

sets the function who generates the href elements.

default : function($element){return $element->getContent()}

Parameters

callable $_hrefFunction

Returns: HtmlBreadcrumb

Definition at line 140 of file HtmlBreadcrumb.php.

◆ setStartIndex()

setStartIndex ( $startIndex )

Definition at line 145 of file HtmlBreadcrumb.php.

Field Documentation

◆ $_hrefFunction

$_hrefFunction

protected

Definition at line 41 of file HtmlBreadcrumb.php.

◆ $absolutePaths

$absolutePaths = false

protected

Definition at line 35 of file HtmlBreadcrumb.php.

◆ $autoActive

$autoActive

protected

Definition at line 29 of file HtmlBreadcrumb.php.

◆ $startIndex

$startIndex = 0

protected

Definition at line 23 of file HtmlBreadcrumb.php.

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

Ajax/semantic/html/collections/HtmlBreadcrumb.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _ajaxOn()

◆ addIconAt()

◆ addItem()

◆ asTexts()

◆ autoGetOnClick()

◆ compile()

◆ contentAsString()

◆ createItem()

◆ fromDispatcher()

◆ getHref()

◆ on()

◆ setAbsolutePaths()

◆ setActive()

◆ setAutoActive()

◆ setHrefFunction()

◆ setStartIndex()

Field Documentation

◆ $_hrefFunction

◆ $absolutePaths

◆ $autoActive

◆ $startIndex