# Class yii\widgets\LinkPager

Inheritance | yii\widgets\LinkPager » yii\base\Widget » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\base\ViewContextInterface
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/widgets/LinkPager.php

LinkPager displays a list of hyperlinks that lead to different pages of target.

LinkPager works with a yii\data\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.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$activePageCssClass | string | The CSS class for the active (currently selected) page button. | yii\widgets\LinkPager
$autoIdPrefix | string | The prefix to the automatically generated widget IDs. | yii\base\Widget
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$counter | integer | A counter used to generate $id for widgets. | yii\base\Widget
$disableCurrentPageButton | boolean | Whether to render current page button as disabled. | yii\widgets\LinkPager
$disabledListItemSubTagOptions | array | The options for the disabled tag to be generated inside the disabled list element. | yii\widgets\LinkPager
$disabledPageCssClass | string | The CSS class for the disabled page buttons. | yii\widgets\LinkPager
$firstPageCssClass | string | The CSS class for the "first" page button. | yii\widgets\LinkPager
$firstPageLabel | string|boolean | The text label for the "first" page button. | yii\widgets\LinkPager
$hideOnSinglePage | boolean | Hide widget when only one page exist. | yii\widgets\LinkPager
$id | string|null | ID of the widget. Note that the type of this property differs in getter and setter. See getId() and setId() for details. | yii\base\Widget
$lastPageCssClass | string | The CSS class for the "last" page button. | yii\widgets\LinkPager
$lastPageLabel | string|boolean | The text label for the "last" page button. | yii\widgets\LinkPager
$linkContainerOptions | array | HTML attributes which will be applied to all link containers | yii\widgets\LinkPager
$linkOptions | array | HTML attributes for the link in a pager container tag. | yii\widgets\LinkPager
$maxButtonCount | integer | Maximum number of page buttons that can be displayed. | yii\widgets\LinkPager
$nextPageCssClass | string | The CSS class for the "next" page button. | yii\widgets\LinkPager
$nextPageLabel | string|boolean | The label for the "next" page button. | yii\widgets\LinkPager
$options | array | HTML attributes for the pager container tag. | yii\widgets\LinkPager
$pageCssClass | string | The CSS class for the each page button. | yii\widgets\LinkPager
$pagination | yii\data\Pagination | The pagination object that this pager is associated with. | yii\widgets\LinkPager
$prevPageCssClass | string | The CSS class for the "previous" page button. | yii\widgets\LinkPager
$prevPageLabel | string|boolean | The text label for the "previous" page button. | yii\widgets\LinkPager
$registerLinkTags | boolean | Whether to register link tags in the HTML header for prev, next, first and last page. | yii\widgets\LinkPager
$stack | yii\base\Widget[] | The widgets that are currently being rendered (not ended). | yii\base\Widget
$view | yii\web\View | The view object that can be used to render views or view files. Note that the type of this property differs in getter and setter. See getView() and setView() for details. | yii\base\Widget
$viewPath | string | The directory containing the view files for this widget. This property is read-only. | yii\base\Widget

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\BaseObject
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
afterRun() | This method is invoked right after a widget is executed. | yii\base\Widget
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
beforeRun() | This method is invoked right before the widget is executed. | yii\base\Widget
begin() | Begins a widget. | yii\base\Widget
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
end() | Ends a widget. | yii\base\Widget
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getId() | Returns the ID of the widget. | yii\base\Widget
getView() | Returns the view object that can be used to render views or view files. | yii\base\Widget
getViewPath() | Returns the directory containing the view files for this widget. | yii\base\Widget
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the pager. | yii\widgets\LinkPager
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
render() | Renders a view. | yii\base\Widget
renderFile() | Renders a view file. | yii\base\Widget
run() | Executes the widget. | yii\widgets\LinkPager
setId() | Sets the ID of the widget. | yii\base\Widget
setView() | Sets the view object to be used by this widget. | yii\base\Widget
trigger() | Triggers an event. | yii\base\Component
widget() | Creates a widget instance and runs it. | yii\base\Widget

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
getPageRange() |  | yii\widgets\LinkPager
registerLinkTags() | Registers relational link tags in the html header for prev, next, first and last page. | yii\widgets\LinkPager
renderPageButton() | Renders a page button. | yii\widgets\LinkPager
renderPageButtons() | Renders the page buttons. | yii\widgets\LinkPager

## Events

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_AFTER_RUN | yii\base\WidgetEvent | An event raised right after executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_BEFORE_RUN | yii\base\WidgetEvent | An event raised right before executing a widget. (available since version 2.0.11) | yii\base\Widget
EVENT_INIT | yii\base\Event | An event that is triggered when the widget is initialized via init(). (available since version 2.0.11) | yii\base\Widget

## Property Details

$activePageCssClass public property

The CSS class for the active (currently selected) page button.

public string $activePageCssClass = 'active'
$disableCurrentPageButton public property (available since version 2.0.12)

Whether to render current page button as disabled.

public boolean $disableCurrentPageButton = false
$disabledListItemSubTagOptions public property (available since version 2.0.11)

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.

    $disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];

public array $disabledListItemSubTagOptions = []
$disabledPageCssClass public property

The CSS class for the disabled page buttons.

public string $disabledPageCssClass = 'disabled'
$firstPageCssClass public property

The CSS class for the "first" page button.

public string $firstPageCssClass = 'first'
$firstPageLabel public property

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.

public string|boolean $firstPageLabel = false
$hideOnSinglePage public property

Hide widget when only one page exist.

public boolean $hideOnSinglePage = true
$lastPageCssClass public property

The CSS class for the "last" page button.

public string $lastPageCssClass = 'last'
$lastPageLabel public property

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.

public string|boolean $lastPageLabel = false
$linkContainerOptions public property (available since version 2.0.13)

HTML attributes which will be applied to all link containers

public array $linkContainerOptions = []
$linkOptions public property

HTML attributes for the link in a pager container tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $linkOptions = []
$maxButtonCount public property

Maximum number of page buttons that can be displayed. Defaults to 10.

public integer $maxButtonCount = 10
$nextPageCssClass public property

The CSS class for the "next" page button.

public string $nextPageCssClass = 'next'
$nextPageLabel public property

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.

public string|boolean $nextPageLabel = '&raquo;'
$options public property

HTML attributes for the pager container tag.

See also yii\helpers\Html::renderTagAttributes() for details on how attributes are being rendered.

public array $options = ['class' => 'pagination']
$pageCssClass public property (available since version 2.0.7)

The CSS class for the each page button.

public string $pageCssClass = null
$pagination public property

The pagination object that this pager is associated with. You must set this property in order to make LinkPager work.

public yii\data\Pagination $pagination = null
$prevPageCssClass public property

The CSS class for the "previous" page button.

public string $prevPageCssClass = 'prev'
$prevPageLabel public property

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.

public string|boolean $prevPageLabel = '&laquo;'
$registerLinkTags public property

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.

See also:

- http://www.w3.org/TR/html401/struct/links.html#h-12.1.2
- registerLinkTags()

public boolean $registerLinkTags = false

## Method Details

getPageRange() protected method

protected array getPageRange ( )
return | array | The begin and end pages that need to be displayed.

init() public method

Initializes the pager.

public void init ( )

registerLinkTags() protected method

Registers relational link tags in the html header for prev, next, first and last page.

These links are generated using yii\data\Pagination::getLinks().

See also http://www.w3.org/TR/html401/struct/links.html#h-12.1.2.

protected void registerLinkTags ( )

renderPageButton() protected method

Renders a page button.

You may override this method to customize the generation of page buttons.

protected string renderPageButton ( $label, $page, $class, $disabled, $active )
$label | string | The text label for the button
$page | integer | The page number
$class | string | The CSS class for the page button.
$disabled | boolean | Whether this page button is disabled
$active | boolean | Whether this page button is active
return | string | The rendering result

renderPageButtons() protected method

Renders the page buttons.

protected string renderPageButtons ( )
return | string | The rendering result

run() public method

Executes the widget.

This overrides the parent implementation by displaying the generated page buttons.

public void run ( )