Class yii\widgets\LinkPager

继承yii\widgets\LinkPager » yii\base\Widget » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable, yii\base\ViewContextInterface
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/widgets/LinkPager.php

LinkPager 显示导航到不同页面目标的超链接列表.

LinkPager 与 yii\data\Pagination 对象一起使用, 该对象指定页面总数和当前页码.

Note: 该 LinkPager 仅生成必要的 HTML 标记. 为了让它看起来像一个真正的分页条, 你应该为它提供一些 CSS 样式. 使用默认配置, 使用 Twitter Bootstrap CSS 框架, LinkPager 看起来应该不错.

有关 LinkPager 的更多详细信息和使用信息, 请参阅 权威指南 - 显示数据 - 分页(Pagination).

公共属性

隐藏继承的属性

属性类型描述定义在
$activePageCssClass string 活动(active, 当前选定)页面按钮的 CSS 类 yii\widgets\LinkPager
$autoIdPrefix string 自动生成的小部件 ID 的前缀. yii\base\Widget
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$counter integer 用于为小部件生成 $id 的计数器. yii\base\Widget
$disableCurrentPageButton boolean 是否将当前页面按钮渲染为禁用(disabled)状态. yii\widgets\LinkPager
$disabledListItemSubTagOptions array 在禁用列表元素中生成禁用标记的选项. yii\widgets\LinkPager
$disabledPageCssClass string 禁用(disabled)页面按钮的 CSS 类. yii\widgets\LinkPager
$firstPageCssClass string 页面按钮"first"的 CSS 类. yii\widgets\LinkPager
$firstPageLabel string|boolean 页面按钮"first"的文本标签. yii\widgets\LinkPager
$hideOnSinglePage boolean 只有一个页面存在时是否隐藏小部件. yii\widgets\LinkPager
$id string|null 小部件的 ID. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getId()setId(). yii\base\Widget
$lastPageCssClass string 页面按钮"last"的 CSS 类. yii\widgets\LinkPager
$lastPageLabel string|boolean 页面按钮"last"的文本标签. yii\widgets\LinkPager
$linkContainerOptions array 将应用于所有链接容器的 HTML 属性. yii\widgets\LinkPager
$linkOptions array 分页条容器标签中链接的 HTML 属性. yii\widgets\LinkPager
$maxButtonCount integer 可以显示的页面按钮的最大数量. yii\widgets\LinkPager
$nextPageCssClass string 页面按钮"next"的 CSS 类. yii\widgets\LinkPager
$nextPageLabel string|boolean 页面按钮"next"的文本标签. yii\widgets\LinkPager
$options array 分页条容器标签的 HTML 属性. yii\widgets\LinkPager
$pageCssClass string 每个页面按钮的 CSS 类. yii\widgets\LinkPager
$pagination yii\data\Pagination 与该分页条关联的分页对象. yii\widgets\LinkPager
$prevPageCssClass string 页面按钮"previous"的 CSS 类. yii\widgets\LinkPager
$prevPageLabel string|boolean 页面按钮"previous"的文本标签. yii\widgets\LinkPager
$registerLinkTags boolean 是否在 HTML 标头中为prev, next, firstlast页面注册链接标签. yii\widgets\LinkPager
$stack yii\base\Widget[] 当前正在渲染的小部件(未结束). yii\base\Widget
$view yii\web\View 可用于渲染视图或视图文件的视图对象. Note: 此属性的类型在 getter 和 setter 中不同. 有关详细信息, 请参阅 getView()setView(). yii\base\Widget
$viewPath string 包含此小部件的视图文件的目录. 该属性是只读的. yii\base\Widget

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的指定的方法. yii\base\Component
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\BaseObject
__get() 返回组件属性的值. yii\base\Component
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\Component
__set() 设置组件属性的值. yii\base\Component
__unset() 将组件属性设置为null. yii\base\Component
afterRun() 在执行小部件后立即调用该方法. yii\base\Widget
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
beforeRun() 在执行小部件之前立即调用该方法. yii\base\Widget
begin() 开始一个小部件. yii\base\Widget
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读取. yii\base\Component
canSetProperty() 返回一个值, 指示属性是否可设置. yii\base\Component
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
end() 结束小部件. yii\base\Widget
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getId() 返回小部件的 ID. yii\base\Widget
getView() 返回可用于渲染视图或视图文件的视图对象. yii\base\Widget
getViewPath() 返回包含此小部件的视图文件的目录. yii\base\Widget
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\Component
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\Component
init() 初始化分页条. yii\widgets\LinkPager
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
render() 渲染视图. yii\base\Widget
renderFile() 渲染视图文件. yii\base\Widget
run() 执行小部件. yii\widgets\LinkPager
setId() 设置小部件的 ID. yii\base\Widget
setView() 设置此小部件要使用的视图对象. yii\base\Widget
trigger() 触发事件. yii\base\Component
widget() 创建一个小部件实例并运行它. yii\base\Widget

受保护的方法

隐藏继承的方法

方法描述定义在
getPageRange() yii\widgets\LinkPager
registerLinkTags() prev, next, firstlast页面的 HTML 标头中注册关系链接标签. yii\widgets\LinkPager
renderPageButton() 渲染页面按钮. yii\widgets\LinkPager
renderPageButtons() 渲染页面按钮. yii\widgets\LinkPager

事件

隐藏继承的事件

事件类型描述定义在
EVENT_AFTER_RUN yii\base\WidgetEvent 在执行小部件之后立即触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_BEFORE_RUN yii\base\WidgetEvent 在执行小部件之前触发的事件. (available since version 2.0.11) yii\base\Widget
EVENT_INIT yii\base\Event 当通过 init() 初始化小部件时触发的事件. (available since version 2.0.11) yii\base\Widget

属性详情

$activePageCssClass public 属性

活动(active, 当前选定)页面按钮的 CSS 类

public string $activePageCssClass 'active'
$disableCurrentPageButton public 属性 (可用自版本: 2.0.12)

是否将当前页面按钮渲染为禁用(disabled)状态.

$disabledListItemSubTagOptions public 属性 (可用自版本: 2.0.11)

在禁用列表元素中生成禁用标记的选项. 为了定制 html 标签, 请使用标签键.

$disabledListItemSubTagOptions = ['tag' => 'div', 'class' => 'disabled-div'];
$disabledPageCssClass public 属性

禁用(disabled)页面按钮的 CSS 类.

public string $disabledPageCssClass 'disabled'
$firstPageCssClass public 属性

页面按钮"first"的 CSS 类.

public string $firstPageCssClass 'first'
$firstPageLabel public 属性

页面按钮"first"的文本标签. 如果它指定为true, 则页面将用作标签. 默认值为false, 表示将不显示"first"页面按钮.

Note: 这将不会进行 HTML 编码.

$hideOnSinglePage public 属性

只有一个页面存在时是否隐藏小部件.

public boolean $hideOnSinglePage true
$lastPageCssClass public 属性

页面按钮"last"的 CSS 类.

public string $lastPageCssClass 'last'
$lastPageLabel public 属性

页面按钮"last"的文本标签. 如果它指定为true, 则页面将用作标签. 默认值为false, 表示将不显示"last"页面按钮.

Note: 这将不会进行 HTML 编码.

public string|boolean $lastPageLabel false
$linkContainerOptions public 属性 (可用自版本: 2.0.13)

将应用于所有链接容器的 HTML 属性.

$linkOptions public 属性

分页条容器标签中链接的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $linkOptions = []
$maxButtonCount public 属性

可以显示的页面按钮的最大数量. 默认为10.

$nextPageCssClass public 属性

页面按钮"next"的 CSS 类.

public string $nextPageCssClass 'next'
$nextPageLabel public 属性

页面按钮"next"的文本标签. 如果此属性为false, 则不会显示"next"页面按钮.

Note: 这将不会进行 HTML 编码.

public string|boolean $nextPageLabel '»'
$options public 属性

分页条容器标签的 HTML 属性.

参见 yii\helpers\Html::renderTagAttributes() 有关如何渲染属性的详细信息.

public array $options = ['class' => 'pagination']
$pageCssClass public 属性 (可用自版本: 2.0.7)

每个页面按钮的 CSS 类.

public string $pageCssClass null
$pagination public 属性

与该分页条关联的分页对象. 你必须设置此属性才能使 LinkPager 正常工作.

$prevPageCssClass public 属性

页面按钮"previous"的 CSS 类.

public string $prevPageCssClass 'prev'
$prevPageLabel public 属性

页面按钮"previous"的文本标签. 如果此属性为false, 则不会显示"previous"页面按钮.

Note: 这将不会进行 HTML 编码.

public string|boolean $prevPageLabel '«'
$registerLinkTags public 属性

是否在 HTML 标头中为prev, next, firstlast页面注册链接标签. 默认为false以避免如果在一个页面上使用多个分页条是出现冲突.

参见:

public boolean $registerLinkTags false

方法详情

getPageRange() protected 方法

protected array getPageRange ( )
return array

需要显示的开始和结束页面.

init() public 方法

初始化分页条.

public void init ( )
registerLinkTags() protected 方法

prev, next, firstlast页面的 HTML 标头中注册关系链接标签.

这些链接是使用 yii\data\Pagination::getLinks() 生成的.

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

protected void registerLinkTags ( )
renderPageButton() protected 方法

渲染页面按钮.

你可以重写此方法来自定义页面按钮的生成.

protected string renderPageButton ( $label, $page, $class, $disabled, $active )
$label string

按钮的文本标签.

$page integer

页码.

$class string

页面按钮的 CSS 类.

$disabled boolean

此页面按钮是否被禁用(disabled).

$active boolean

此页面按钮是否处于活动状态(active).

return string

渲染结果.

renderPageButtons() protected 方法

渲染页面按钮.

protected string renderPageButtons ( )
return string

渲染结果.

run() public 方法

执行小部件.

这将通过显示生成的页面按钮来覆盖父实现.

public void run ( )