Pagination
分页类。为 Joomla! CMS 提供内容分页的通用接口。
| 自版本 |
1.5 |
|---|---|
| 包 |
Joomla CMS |
方法
__construct
构造函数。
__construct( total, limitstart, limit, prefix = '', \Joomla\CMS\Application\CMSApplication app = null) :
| 自版本 |
1.5 |
|---|
参数
- total
int项目的总数。- limitstart
int要开始的项目的偏移量。- limit
int每页显示的项目数。- prefix
string用于请求变量的前缀。- app
CMSApplication应用程序对象
返回值
混合
_buildDataObject
创建并返回分页数据对象。
_buildDataObject() : \stdClass
| 自版本 |
1.5 |
|---|
返回值
stdClass分页数据对象。
_item_active
创建指向项目的活动分页链接的方法
_item_active(\Joomla\CMS\Pagination\PaginationObject item) :
_item_inactive
创建非活动分页字符串的方法
_item_inactive(\Joomla\CMS\Pagination\PaginationObject item) :
_list_render
创建列表页脚的 html
_list_render(mixed||string|int list) :
| 自版本 |
1.5 |
|---|
参数
- list
array<string|int, mixed>分页列表数据结构。
返回值
string列表开始、上一个、下一个、结束的 HTML
getAdditionalUrlParam
获取要添加到所有分页类生成的链接的附加 URL 参数（如果存在）的方法。
getAdditionalUrlParam( key) :
| 自版本 |
1.6 |
|---|
参数
- key
string要获取值的 URL 参数的名称。
返回值
mixed如果存在则为值，如果不存在则为 null。
getData
返回分页数据对象，仅在它不存在时才创建它。
getData() : \stdClass
| 自版本 |
1.5 |
|---|
返回值
stdClass分页数据对象。
getLimitBox
创建一个下拉框，用于选择每页显示多少条记录。
getLimitBox() :
| 自版本 |
1.5 |
|---|
返回值
string限制 # 输入框的 HTML。
getPagesCounter
创建并返回分页页面计数器字符串，例如第 2 页，共 4 页。
getPagesCounter() :
| 自版本 |
1.5 |
|---|
返回值
string分页页面计数器字符串。
getPagesLinks
创建并返回分页页面列表字符串，例如上一个、下一个、1 2 3 ... x。
getPagesLinks() :
| 自版本 |
1.5 |
|---|
返回值
string分页页面列表字符串。
getPaginationLinks
获取分页链接
getPaginationLinks( layoutId = 'joomla.pagination.links', mixed||string|int options = []) :
| 自版本 |
3.3 |
|---|
参数
- layoutId
string渲染链接的布局- options
array<string|int, mixed>布局设置的可选数组
返回值
string分页链接。
getPaginationPages
创建并返回分页页面列表，例如上一个、下一个、1 2 3 ... x。
getPaginationPages() : mixed||string|int
| 自版本 |
3.3 |
|---|
返回值
array<string|int, mixed>分页页面列表。
getResultsCounter
创建并返回分页结果集计数器字符串，例如结果 1-10，共 42 个。
getResultsCounter() :
| 自版本 |
1.5 |
|---|
返回值
string分页结果集计数器字符串。
getRowOffset
返回具有给定索引的行所对应的合理化偏移量。
getRowOffset( index) :
| 自版本 |
1.5 |
|---|
参数
- index
int行索引
返回值
int具有给定索引的行所对应的合理化偏移量。
orderDownIcon
返回向下移动项目的图标。
orderDownIcon( i, n, condition = true, task = 'orderdown', alt = 'JLIB_HTML_MOVE_DOWN', enabled = true, checkbox = 'cb') :
| 自版本 |
1.5 |
|---|
参数
- i
int行索引。- n
int列表中的项目数。- condition
bool是否显示图标。- task
string要触发的任务。- alt
string图像替换文本字符串。- enabled
bool操作访问控制的可选设置。- checkbox
string复选框的可选前缀。
返回值
string向下移动项目的图标或空格。
orderUpIcon
返回向上移动项目的图标。
orderUpIcon( i, condition = true, task = 'orderup', alt = 'JLIB_HTML_MOVE_UP', enabled = true, checkbox = 'cb') :
| 自版本 |
1.5 |
|---|
参数
- i
int行索引。- condition
bool是否显示图标。- task
string要触发的任务。- alt
string图像替换文本字符串。- enabled
bool操作访问控制的可选设置。- checkbox
string复选框的可选前缀。
返回值
string向上移动项目的图标或空格。
setAdditionalUrlParam
设置要添加到所有分页类生成的链接的附加 URL 参数的方法。
setAdditionalUrlParam( key, value) :
| 自版本 |
1.6 |
|---|
参数
- key
string要设置值的 URL 参数的名称。- value
mixed要为 URL 参数设置的值。
返回值
mixed参数的旧值。
属性
limitstart
要开始显示的记录编号。
| 自版本 |
1.5 |
|---|
类型
int
limit
每页显示的行数。
| 自版本 |
1.5 |
|---|
类型
int
total
行的总数。
| 自版本 |
1.5 |
|---|
类型
int
prefix
用于请求变量的前缀。
| 自版本 |
1.6 |
|---|
类型
int
pagesStart
分页对象开始的值
| 自版本 |
3.0 |
|---|
类型
int
pagesStop
分页对象结束的值
| 自版本 |
3.0 |
|---|
类型
int
pagesCurrent
当前页
| 自版本 |
3.0 |
|---|
类型
int
pagesTotal
总页数
| 自版本 |
3.0 |
|---|
类型
int
hideEmptyLimitstart
该标志指示是否将 limitstart=0 添加到 URL
| 自版本 |
3.9.0 |
|---|
类型
bool
viewall
查看全部标志
| 自版本 |
3.0 |
|---|
类型
bool
additionalUrlParams
要添加到类生成的分页 URL 的其他 URL 参数。在处理列表和 GET 请求时，这些参数可能对过滤器和额外值很有用。
| 自版本 |
3.0 |
|---|
类型
array<string|int, mixed>
data
分页数据对象
| 自版本 |
3.4 |
|---|
类型
object