HtmlBreadcrumb Class Reference

Semantic UI Breadcrumb component. More...

Inheritance 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.
	contentAsString ()
	setActive ($index=null)
	fromDispatcher (JsUtils $js, $dispatcher, $startIndex=0)
	Adds new elements in breadcrumbs corresponding to request dispatcher : controllerName, actionName, parameters.
	getHref ($index=null, $separator="/")
	Returns the url of the element at $index or the breadcrumbs url if $index is ommited.
	setHrefFunction ($_hrefFunction)
	sets the function who generates the href elements.
	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)
	adds and returns an item
	asTexts ()
	setAbsolutePaths ($absolutePaths)
Public Member Functions inherited from HtmlSemNavElement
	__construct ($identifier, $tagName, $baseClass)
	setContentDivider ($divider, $index=NULL)
	setIconContentDivider ($iconContentDivider, $index=NULL)
Public Member Functions inherited from HtmlSemCollection
	run (JsUtils $js)
	Parameters JsUtils $js Returns SimpleExtComponent 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)
	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)
	onClick ($jsCode, $stopPropagation=false, $preventDefault=true)
	setClick ($jsCode)
	onCreate ($jsCode)
	addEventsOnRun (JsUtils $js=NULL)
	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 ()
	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 NavElementTrait
	jsSetContent (JsUtils $jsUtils)
	Generate the jquery script to set the elements to the HtmlNavElement.
	getRoot ()
	setRoot ($root)
	getAttr ()
	setAttr ($attr)
	Define the html attribute for each element url in ajax.
	__call ($method, $args)

Protected Member Functions
	createItem ($value)
	{The item factory. Parameters mixed $value }
Protected Member Functions inherited from HtmlSemNavElement
	setDivider ($divider, $index)
	getContentDivider ($index)
Protected Member Functions inherited from HtmlCollection
	getItemToAdd ($item)
	setItemIdentifier ($item, $classname, $index)
	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 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
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 UI Breadcrumb component.

See also

http://semantic-ui.com/collections/breadcrumb.html @method _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()
	)

Parameters

string	$operation	http method get, post, postForm or json
string	$event	the event that triggers the request
string	$url	The url of the request
string	$responseElement	The selector of the HTML element displaying the answer
array	$parameters	default : array("preventDefault"=>true,"stopPropagation"=>true,"params"=>"{}","jsCallback"=>NULL,"attr"=>"id","hasLoader"=>true,"ajaxLoader"=>null,"immediatly"=>true,"jqueryDone"=>"html","ajaxTransition"=>null,"jsCondition"=>null,"headers"=>null,"historize"=>false)

Returns

$this

Reimplemented from BaseHtmlEventsTrait.

Definition at line 181 of file HtmlBreadcrumb.php.

addIconAt()

addIconAt	(		$icon,
			$index
	)

Definition at line 209 of file HtmlBreadcrumb.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 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

Reimplemented from HtmlSemNavElement.

Definition at line 74 of file HtmlBreadcrumb.php.

compile()

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

Reimplemented from HtmlCollection.

Definition at line 159 of file HtmlBreadcrumb.php.

contentAsString()

contentAsString

(

)

Reimplemented from HtmlSemNavElement.

Definition at line 80 of file HtmlBreadcrumb.php.

createItem()

createItem (   $value )

protected

{The item factory.

Parameters

mixed

$value

}

See also

\Ajax\common\html\HtmlCollection::createItem()

Reimplemented from HtmlCollection.

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

Reimplemented from NavElementTrait.

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
	)

Parameters

string	$event
string	$jsCode
boolean	$stopPropagation
boolean	$preventDefault

Returns

BaseHtml

Reimplemented from BaseHtmlEventsTrait.

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

Reimplemented from BaseTrait.

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