LinkPager

API reference › Bootstrap 6 › LinkPager

class	`yii2\extensions\bootstrap6\LinkPager`
Extends	`Widget` » `yii\base\Widget` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\ViewContextInterface`, `yii\base\Configurable`
Uses traits	`AttributesTrait`, `BootstrapWidgetTrait`
Source	`src/LinkPager.php`

Renders Bootstrap pagination links for a Pagination object.

To use it in every GridView/ListView, register it in the DI container as the definition of LinkPager.

Properties

Property	Type	Description	Defined by
`$activePageCssClass`	`string`	CSS class of the active (current) page item. Default: `'active'`.	`LinkPager`
`$autoIdPrefix` static	`string`	The prefix to the automatically generated widget IDs. Default: `'w'`.	`yii\base\Widget`
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$clientEvents`	`array<string,` `yii\web\JsExpression\|string>`	Event handlers attached to the widget element, as event name => JavaScript handler source. Default: `[]`.	`BootstrapWidgetTrait`
`$clientOptions`	`array<string, mixed>\|false`	Options passed to the plugin constructor, or `false` to skip the JavaScript initialization. Default: `[]`.	`BootstrapWidgetTrait`
`$disableCurrentPageButton`	`bool`	Whether to render the current page button as disabled. Default: `false`.	`LinkPager`
`$disabledListItemSubTagOptions`	`array<string, mixed>`	HTML attributes merged into the links of disabled page items. Default: `[]`.	`LinkPager`
`$disabledPageCssClass`	`string`	CSS class of the disabled page items. Default: `'disabled'`.	`LinkPager`
`$firstPageCssClass`	`string`	CSS class of the “first” page item. Default: `'first'`.	`LinkPager`
`$firstPageLabel`	`bool\|string`	Label of the “first” page button (not HTML-encoded), `true` for the page number, or `false` to omit it. Default: `false`.	`LinkPager`
`$hideOnSinglePage`	`bool`	Whether to render nothing when there is only one page. Default: `true`.	`LinkPager`
`$id`	`string`	Id of the widget.	`yii\base\Widget`
`$lastPageCssClass`	`string`	CSS class of the “last” page item. Default: `'last'`.	`LinkPager`
`$lastPageLabel`	`bool\|string`	Label of the “last” page button (not HTML-encoded), `true` for the page number, or `false` to omit it. Default: `false`.	`LinkPager`
`$linkContainerOptions`	`array<string, mixed>`	HTML attributes of every page item; the `tag` option sets the tag name (default `li`). Default: `['class' => ['page-item']]`.	`LinkPager`
`$linkOptions`	`array<string, mixed>`	HTML attributes of every page link. Default: `['class' => ['page-link']]`.	`LinkPager`
`$listOptions`	`array<string, mixed>`	HTML attributes of the list tag; the `tag` option sets the tag name (default `ul`). Default: `['class' => ['pagination']]`.	`LinkPager`
`$maxButtonCount`	`int`	Maximum number of internal page buttons. Default: `10`.	`LinkPager`
`$nextPageCssClass`	`string`	CSS class of the “next” page item. Default: `'next'`.	`LinkPager`
`$nextPageLabel`	`false\|string`	Label of the “next” page button (not HTML-encoded), or `false` to omit it. Default: `'<span aria-hidden="true">»</span>'`.	`LinkPager`
`$options`	`array<string, mixed>`	HTML attributes of the container tag; the `tag` option sets the tag name (default `nav`). Default: `[]`.	`LinkPager`
`$pageCssClass`	`string`	CSS class of the internal page items. Default: `'page-item'`.	`LinkPager`
`$pagination`	`yii\data\Pagination\|null`	Pagination that provides the page count, the current page, and the page URLs. Default: `null`.	`LinkPager`
`$prevPageCssClass`	`string`	CSS class of the “previous” page item. Default: `'prev'`.	`LinkPager`
`$prevPageLabel`	`false\|string`	Label of the “previous” page button (not HTML-encoded), or `false` to omit it. Default: `'<span aria-hidden="true">«</span>'`.	`LinkPager`
`$registerLinkTags`	`bool`	Whether to register `<link>` tags for the first, previous, next, and last pages in the view head. Default: `false`.	`LinkPager`
`$size`	`yii2\extensions\bootstrap6\enum\Size\|string\|null`	Size modifier rendered as the `pagination-{value}` class (`sm` or `lg`), or `null` for the default size. Default: `null`.	`LinkPager`
`$theme`	`yii2\extensions\bootstrap6\enum\Theme\|string\|null`	Theme color rendered as the `theme-{value}` class on the list, or `null` for the default color. Default: `null`.	`LinkPager`
`$view`	`yii\web\View`	The view object that can be used to render views or view files.	`yii\base\Widget`
`$viewPath` read-only	`string`	The directory containing the view files for this widget.	`yii\base\Widget`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\BaseObject`
`__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`
`__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`
`addAttributes()`	Adds a set of HTML attributes; attributes already set with the same name are replaced.	`AttributesTrait`
`addClass()`	Adds one or more CSS classes to the existing classes; duplicated classes are collapsed.	`AttributesTrait`
`addCssStyle()`	Adds CSS style properties to the `style` attribute.	`AttributesTrait`
`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`
`attribute()`	Sets an HTML attribute value.	`AttributesTrait`
`beforeRun()`	This method is invoked right before the widget is executed.	`yii\base\Widget`
`begin()` static	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`
`class()`	Replaces the existing CSS classes with the specified ones.	`AttributesTrait`
`className()` static	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()` static	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 widget and validates `$size` and `$theme`.	`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()`		`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()` static	Creates a widget instance and runs it.	`yii\base\Widget`
`getPageRange()` protected	Returns the first and last internal page indexes to render.	`LinkPager`
`pluginInitialization()` protected	Returns the JavaScript that initializes a plugin with its normalized constructor options.	`BootstrapWidgetTrait`
`registerClientEvents()` protected	Registers the JavaScript event handlers listed in `$clientEvents` at `View::POS_END`.	`BootstrapWidgetTrait`
`registerLinkTags()` protected	Registers the relational link tags returned by `Pagination::getLinks()`.	`LinkPager`
`registerPlugin()` protected	Registers the plugin asset, the plugin initialization when needed, and the `$clientEvents`.	`BootstrapWidgetTrait`
`renderPageButton()` protected	Renders a page item.	`LinkPager`
`renderPageButtons()` protected	Renders the list of page items, or an empty `string` when a single page is hidden.	`LinkPager`

Events

Event	Type	Description	Defined by
`EVENT_INIT`	`yii\base\Event`	An event that is triggered when the widget is initialized via `init()`. Event name: `'init'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_BEFORE_RUN`	`yii\base\WidgetEvent`	An event raised right before executing a widget. Event name: `'beforeRun'`. Available since 2.0.11.	`yii\base\Widget`
`EVENT_AFTER_RUN`	`yii\base\WidgetEvent`	An event raised right after executing a widget. Event name: `'afterRun'`. Available since 2.0.11.	`yii\base\Widget`

Method details

init()

public function init(): void

Initializes the widget and validates $size and $theme.

Throws

yii\base\InvalidConfigException: if $size or $theme is not a value of its enum.

run()

public function run(): string

Returns

string

Throws

yii\base\InvalidConfigException: if $pagination is not set.

getPageRange()

protected function getPageRange(yii\data\Pagination $pagination): array{int, int}

Returns the first and last internal page indexes to render.

Parameters

Parameter	Type	Description
`$pagination`	`yii\data\Pagination`

Returns

array{int, int}

registerLinkTags()

protected function registerLinkTags(yii\data\Pagination $pagination): void

Registers the relational link tags returned by Pagination::getLinks().

Parameters

Parameter	Type	Description
`$pagination`	`yii\data\Pagination`

renderPageButton()

protected function renderPageButton(string $label, int $page, string $class, bool $disabled, bool $active, array<string, mixed> $linkOptions = []): string

Renders a page item.

Parameters

Parameter	Type	Description
`$label`	`string`	Link content; it is not HTML-encoded.
`$page`	`int`	Zero-based page index.
`$class`	`string`	CSS class of the item, or an empty `string` for `$pageCssClass`.
`$disabled`	`bool`	Whether the item is disabled.
`$active`	`bool`	Whether the item is the current page.
`$linkOptions`	`array<string, mixed>`	Extra HTML attributes of the link.

Returns

string: Generated HTML.

renderPageButtons()

protected function renderPageButtons(yii\data\Pagination $pagination): string

Renders the list of page items, or an empty string when a single page is hidden.

Parameters

Parameter	Type	Description
`$pagination`	`yii\data\Pagination`

Returns

string