PHP Class TbPager

See also: http://twitter.github.com/bootstrap/components.html#pagination

Inheritance: extends CLinkPager

Public Properties

Property	Type	Description
$alignment		the pager alignment. Valid values are 'centered' and 'right'.
$cssFile		the URL of the CSS file used by this pager. Defaults to false, meaning that no CSS will be included.
$displayFirstAndLast		whether to display the first and last items.
$header		the text shown before page buttons. Defaults to an empty string, meaning that no header will be displayed.

Method	Description
init ( )	### .init()

Method	Description
createPageButton ( string $label, integer $page, string $class, boolean $hidden, boolean $selected ) : string	### .createPageButton()
createPageButtons ( ) : array	### .createPageButtons()

Creates a page button. You may override this method to customize the page buttons.

protected createPageButton ( string $label, integer $page, string $class, boolean $hidden, boolean $selected ) : string
$label	string	the text label for the button
$page	integer	the page number
$class	string	the CSS class for the page button. This could be 'page', 'first', 'last', 'next' or 'previous'.
$hidden	boolean	whether this page button is visible
$selected	boolean	whether this page button is selected
return	string	the generated button

Creates the page buttons.

protected createPageButtons ( ) : array
return	array	a list of page buttons (in HTML code).

Initializes the pager by setting some default property values.

public init ( )

the pager alignment. Valid values are 'centered' and 'right'.

public $alignment

the URL of the CSS file used by this pager. Defaults to false, meaning that no CSS will be included.

public $cssFile

whether to display the first and last items.

public $displayFirstAndLast

the text shown before page buttons. Defaults to an empty string, meaning that no header will be displayed.

public $header