Twitter Bootstrap Breadcrumbs component. More...

Inheritance diagram for HtmlBreadcrumbs:

Public Member Functions

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

addElement ($element, $href="", $glyph=NULL)

setActive ($index=null)

addElements ($elements)

fromArray ($array)

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

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

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

fromDatabaseObject ($object, $function)

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

setAutoActive ($autoActive)

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

autoGetOnClick ($targetSelector)

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

contentAsString ()

getElement ($index)

addGlyph ($glyph, $index=0)

Add a glyphicon to the element at index $index.

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

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

setHrefFunction ($_hrefFunction)

sets the function who generates the href elements.

setStartIndex ($startIndex)

Public Member Functions inherited from HtmlNavElement

__construct ($identifier, $tagName)

Public Member Functions inherited from HtmlBsDoubleElement

addBadge ($caption, $leftSeparator=" ")

addLabel ($caption, $style="label-default", $leftSeparator=" ")

wrapContentWithGlyph ($glyphBefore, $glyphAfter="")

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)

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 ()

setProperties ($properties)

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

	$autoActive

	$absolutePaths

	$_hrefFunction

Protected Attributes inherited from HtmlNavElement
	$root

	$attr

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 ()

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

Detailed Description

Twitter Bootstrap Breadcrumbs component.

See also: http://getbootstrap.com/components/#breadcrumbs

Author: jc

Version: 1.001 @method _hrefFunction($e)

Definition at line 16 of file HtmlBreadcrumbs.php.

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

string	$identifier
array	$elements
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 44 of file HtmlBreadcrumbs.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 156 of file HtmlBreadcrumbs.php.

◆ addElement()

addElement	(	$element,
		$href = `""`,
		$glyph = `NULL`
	)

Parameters

mixed	$element
string	$href

Returns: \Ajax\bootstrap\html\HtmlLink

Definition at line 63 of file HtmlBreadcrumbs.php.

◆ addElements()

addElements ( $elements )

Definition at line 92 of file HtmlBreadcrumbs.php.

◆ addGlyph()

addGlyph	(	$glyph,
		$index = `0`
	)

Add a glyphicon to the element at index $index.

Parameters

mixed	$glyph
int	$index

Reimplemented from HtmlBsDoubleElement.

Definition at line 189 of file HtmlBreadcrumbs.php.

◆ autoGetOnClick()

autoGetOnClick ( $targetSelector )

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

Parameters

string $targetSelector the target of the get

Returns: HtmlBreadcrumbs

Reimplemented from HtmlNavElement.

Definition at line 169 of file HtmlBreadcrumbs.php.

◆ compile()

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

Reimplemented from BaseHtml.

Definition at line 126 of file HtmlBreadcrumbs.php.

◆ contentAsString()

contentAsString ( )

Reimplemented from HtmlNavElement.

Definition at line 173 of file HtmlBreadcrumbs.php.

◆ fromArray()

fromArray ( $array )

Reimplemented from HtmlSingleElement.

Definition at line 99 of file HtmlBreadcrumbs.php.

◆ fromDatabaseObject()

fromDatabaseObject	(	$object,
		$function
	)

Reimplemented from BaseHtml.

Definition at line 136 of file HtmlBreadcrumbs.php.

◆ fromDispatcher()

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

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

Parameters

JsUtils	$js
object	$dispatcher	the request dispatcher

Returns: \Ajax\bootstrap\html\HtmlBreadcrumbs

Reimplemented from NavElementTrait.

Definition at line 200 of file HtmlBreadcrumbs.php.

◆ getElement()

getElement ( $index )

Definition at line 180 of file HtmlBreadcrumbs.php.

◆ getHref()

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

Return 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 111 of file HtmlBreadcrumbs.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 144 of file HtmlBreadcrumbs.php.

◆ setActive()

setActive ( $index = null )

Definition at line 82 of file HtmlBreadcrumbs.php.

◆ setAutoActive()

setAutoActive ( $autoActive )

Definition at line 151 of file HtmlBreadcrumbs.php.

◆ setHrefFunction()

setHrefFunction ( $_hrefFunction )

sets the function who generates the href elements.

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

Parameters

callable $_hrefFunction

Returns: \Ajax\bootstrap\html\HtmlBreadcrumbs

Definition at line 211 of file HtmlBreadcrumbs.php.

◆ setStartIndex()

setStartIndex ( $startIndex )

Definition at line 216 of file HtmlBreadcrumbs.php.

Field Documentation

◆ $_hrefFunction

$_hrefFunction

protected

Definition at line 35 of file HtmlBreadcrumbs.php.

◆ $absolutePaths

$absolutePaths

protected

Definition at line 30 of file HtmlBreadcrumbs.php.

◆ $autoActive

$autoActive

protected

Definition at line 25 of file HtmlBreadcrumbs.php.

◆ $startIndex

$startIndex =0

protected

Definition at line 21 of file HtmlBreadcrumbs.php.

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

Ajax/bootstrap/html/HtmlBreadcrumbs.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _ajaxOn()

◆ addElement()

◆ addElements()

◆ addGlyph()

◆ autoGetOnClick()

◆ compile()

◆ contentAsString()

◆ fromArray()

◆ fromDatabaseObject()

◆ fromDispatcher()

◆ getElement()

◆ getHref()

◆ on()

◆ setActive()

◆ setAutoActive()

◆ setHrefFunction()

◆ setStartIndex()

Field Documentation

◆ $_hrefFunction

◆ $absolutePaths

◆ $autoActive

◆ $startIndex