Twitter Bootstrap Pagination component. More...

Inheritance diagram for HtmlPagination:

Public Member Functions

__construct ($identifier, $from=1, $to=1, $active=NULL, $countVisible=NULL)

_addEvent ($event, $jsCode)

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

set the active page corresponding to request dispatcher : controllerName, actionName, parameters and $urlMask

getUrl ($index)

setSize ($size)

define the buttons size available values : "lg","","sm","xs"

getFrom ()

setFrom ($from)

getTo ()

setTo ($to)

getActive ()

setActive ($active)

getUrlMask ()

setUrlMask ($urlMask)

getCountVisible ()

setCountVisible ($countVisible)

Public Member Functions inherited from HtmlNavElement

__construct ($identifier, $tagName)

autoGetOnClick ($targetSelector)

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

contentAsString ()

Public Member Functions inherited from HtmlBsDoubleElement

addBadge ($caption, $leftSeparator=" ")

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

addGlyph ($glyphicon, $before=true)

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)

fromArray ($array)

Public Member Functions inherited from BaseHtml

getTagName ()

setTagName ($tagName)

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)

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]")

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

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 Member Functions
	createContent ()

	half ()

	getStart ()

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 Attributes
	$from

	$to

	$countVisible

	$active

	$urlMask

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

Private Member Functions
	createElement ($num, $content, $disabled=false, $current=false)

Detailed Description

Twitter Bootstrap Pagination component.

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

Author: jc

Version: 1.001

Definition at line 17 of file HtmlPagination.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	$identifier,
		$from = `1`,
		$to = `1`,
		$active = `NULL`,
		$countVisible = `NULL`
	)

Parameters

string $identifier

Definition at line 48 of file HtmlPagination.php.

Member Function Documentation

◆ _addEvent()

_addEvent	(	$event,
		$jsCode
	)

Parameters

string	$event
string \| AjaxCall	$jsCode

Returns: BaseHtml

Reimplemented from BaseHtmlEventsTrait.

Definition at line 107 of file HtmlPagination.php.

◆ createContent()

createContent ( )

protected

Definition at line 84 of file HtmlPagination.php.

◆ createElement()

createElement	(	$num,
		$content,
		$disabled = `false`,
		$current = `false`
	)

private

Definition at line 62 of file HtmlPagination.php.

◆ fromDispatcher()

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

set the active page corresponding to request dispatcher : controllerName, actionName, parameters and $urlMask

Parameters

JsUtils	$js
object	$dispatcher	the request dispatcher

Returns: \Ajax\bootstrap\html\HtmlPagination

Reimplemented from NavElementTrait.

Definition at line 120 of file HtmlPagination.php.

◆ getActive()

getActive ( )

Definition at line 170 of file HtmlPagination.php.

◆ getCountVisible()

getCountVisible ( )

Definition at line 186 of file HtmlPagination.php.

◆ getFrom()

getFrom ( )

Definition at line 154 of file HtmlPagination.php.

◆ getStart()

getStart ( )

protected

Definition at line 99 of file HtmlPagination.php.

◆ getTo()

getTo ( )

Definition at line 162 of file HtmlPagination.php.

◆ getUrl()

getUrl ( $index )

Definition at line 135 of file HtmlPagination.php.

◆ getUrlMask()

getUrlMask ( )

Definition at line 178 of file HtmlPagination.php.

◆ half()

half ( )

protected

Definition at line 95 of file HtmlPagination.php.

◆ setActive()

setActive ( $active )

Definition at line 173 of file HtmlPagination.php.

◆ setCountVisible()

setCountVisible ( $countVisible )

Definition at line 189 of file HtmlPagination.php.

◆ setFrom()

setFrom ( $from )

Definition at line 157 of file HtmlPagination.php.

◆ setSize()

setSize ( $size )

define the buttons size available values : "lg","","sm","xs"

Parameters

string | int $size

Returns: HtmlPagination default : ""

Reimplemented from HtmlSingleElement.

Definition at line 145 of file HtmlPagination.php.

◆ setTo()

setTo ( $to )

Definition at line 165 of file HtmlPagination.php.

◆ setUrlMask()

setUrlMask ( $urlMask )

Definition at line 181 of file HtmlPagination.php.

Field Documentation

◆ $active

$active

protected

Definition at line 38 of file HtmlPagination.php.

◆ $countVisible

$countVisible

protected

Definition at line 33 of file HtmlPagination.php.

◆ $from

$from

protected

Definition at line 22 of file HtmlPagination.php.

◆ $to

$to

protected

Definition at line 27 of file HtmlPagination.php.

◆ $urlMask

$urlMask

protected

Definition at line 43 of file HtmlPagination.php.

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

Ajax/bootstrap/html/HtmlPagination.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _addEvent()

◆ createContent()

◆ createElement()

◆ fromDispatcher()

◆ getActive()

◆ getCountVisible()

◆ getFrom()

◆ getStart()

◆ getTo()

◆ getUrl()

◆ getUrlMask()

◆ half()

◆ setActive()

◆ setCountVisible()

◆ setFrom()

◆ setSize()

◆ setTo()

◆ setUrlMask()

Field Documentation

◆ $active

◆ $countVisible

◆ $from

◆ $to

◆ $urlMask