• Home
• yii
• widgets
• LinkPager

PHP Class yii\widgets\LinkPager

LinkPager works with a [[Pagination]] object which specifies the total number of pages and the current page number. Note that LinkPager only generates the necessary HTML markups. In order for it to look like a real pager, you should provide some CSS styles for it. With the default configuration, LinkPager should look good using Twitter Bootstrap CSS framework. For more details and usage information on LinkPager, see the guide article on pagination. Show file Open project: yiisoft/yii2 Class Usage Examples

Public Properties

Property	Type	Description
$activePageCssClass		the CSS class for the active (currently selected) page button.
$disabledListItemSubTagOptions		the options for the disabled tag to be generated inside the disabled list element. In order to customize the html tag, please use the tag key. php $disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];
$disabledPageCssClass		the CSS class for the disabled page buttons.
$firstPageCssClass		the CSS class for the "first" page button.
$firstPageLabel		the text label for the "first" page button. Note that this will NOT be HTML-encoded. If it's specified as true, page number will be used as label. Default is false that means the "first" page button will not be displayed.
$hideOnSinglePage		Hide widget when only one page exist.
$lastPageCssClass		the CSS class for the "last" page button.
$lastPageLabel		the text label for the "last" page button. Note that this will NOT be HTML-encoded. If it's specified as true, page number will be used as label. Default is false that means the "last" page button will not be displayed.
$linkOptions		HTML attributes for the link in a pager container tag.
$maxButtonCount		maximum number of page buttons that can be displayed. Defaults to 10.
$nextPageCssClass		the CSS class for the "next" page button.
$nextPageLabel		the label for the "next" page button. Note that this will NOT be HTML-encoded. If this property is false, the "next" page button will not be displayed.
$options		HTML attributes for the pager container tag.
$pageCssClass		the CSS class for the each page button.
$pagination		the pagination object that this pager is associated with. You must set this property in order to make LinkPager work.
$prevPageCssClass		the CSS class for the "previous" page button.
$prevPageLabel		the text label for the previous page button. Note that this will NOT be HTML-encoded. If this property is false, the "previous" page button will not be displayed.
$registerLinkTags		whether to register link tags in the HTML header for prev, next, first and last page. Defaults to false to avoid conflicts when multiple pagers are used on one page.

Public Methods

Method	Description
init ( )	Initializes the pager.
run ( )	Executes the widget.

Protected Methods

Method	Description
getPageRange ( ) : array
registerLinkTags ( )	Registers relational link tags in the html header for prev, next, first and last page.
renderPageButton ( string $label, integer $page, string $class, boolean $disabled, boolean $active ) : string	Renders a page button.
renderPageButtons ( ) : string	Renders the page buttons.

Method Details

Property Details