分页类
最后更新于：2022-04-01 03:54:48
# 分页类
CodeIgniter 的分页类非常容易使用，而且它 100% 可定制，可以通过动态的参数， 也可以通过保存在配置文件中的参数。
* [例子](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id2)
* [说明](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id3)
* [在配置文件中设置参数](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id4)
* [自定义分页](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id5)
* [添加封装标签](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id6)
* [自定义第一个链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id7)
* [自定义最后一个链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id8)
* [自定义下一页链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id9)
* [自定义上一页链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id10)
* [自定义当前页面链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id11)
* [自定义数字链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id12)
* [隐藏数字链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id13)
* [给链接添加属性](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id14)
* [禁用 "rel" 属性](http://codeigniter.org.cn/user_guide/libraries/pagination.html#rel)
* [类参考](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id15)
如果你还不熟悉 "分页" 这个词，它指的是用于你在页面之间进行导航的链接。像下面这样:
~~~
« First < 1 2 3 4 5 > Last »
~~~
## [例子](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id16)
下面是一个简单的例子，如何在你的 [控制器](http://codeigniter.org.cn/user_guide/general/controllers.html) 方法中创建分页:
~~~
$this->load->library('pagination');
$config['base_url'] = 'http://example.com/index.php/test/page/';
$config['total_rows'] = 200;
$config['per_page'] = 20;
$this->pagination->initialize($config);
echo $this->pagination->create_links();
~~~
### [说明](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id17)
如上所示，$config 数组包含了你的配置参数，被传递到 $this->pagination->initialize() 方法。 另外还有二十几个配置参数你可以选择，但是最少你只需要这三个配置参数。下面是这几个参数的含义：
* **base_url** 这是一个指向你的分页所在的控制器类/方法的完整的 URL ，在上面的这个例子里， 它指向了一个叫 "Test" 的控制器和它的一个叫 "Page" 的方法。记住，如果你需要一个不同格式的 URL ， 你可以 [重新路由](http://codeigniter.org.cn/user_guide/general/routing.html) 。
* **total_rows** 这个数字表示你需要做分页的数据的总行数。通常这个数值是你查询数据库得到的数据总量。
* **per_page** 这个数字表示每个页面中希望展示的数量，在上面的那个例子中，每页显示 20 个项目。
当你没有分页需要显示时，create_links() 方法会返回一个空的字符串。
### [在配置文件中设置参数](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id18)
如果你不喜欢用以上的方法进行参数设置，你可以将参数保存到配置文件中。 简单地创建一个名为 pagination.php 的文件，把 $config 数组加到这个文件中， 然后将文件保存到 application/config/pagination.php 。这样它就可以自动被调用。 用这个方法，你不再需要使用$this->pagination->initialize 方法。
## [自定义分页](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id19)
下面是所有的参数列表，可以传递给 initialization 方法来定制你喜欢的显示效果。
**$config['uri_segment'] = 3;**
分页方法自动检测你 URI 的哪一段包含页数，如果你的情况不一样，你可以明确指定它。
**$config['num_links'] = 2;**
放在你当前页码的前面和后面的“数字”链接的数量。比方说值为 2 就会在每一边放置两个数字链接， 就像此页顶端的示例链接那样。
**$config['use_page_numbers'] = TRUE;**
默认分页的 URL 中显示的是你当前正在从哪条记录开始分页，如果你希望显示实际的页数，将该参数设置为 TRUE 。
**$config['page_query_string'] = TRUE;**
默认情况下，分页类假设你使用 [URI 段](http://codeigniter.org.cn/user_guide/general/urls.html) ，并像这样构造你的链接：
> [http://example.com/index.php/test/page/20](http://example.com/index.php/test/page/20)
如果你把 $config['enable_query_strings'] 设置为 TRUE，你的链接将自动地被重写成查询字符串格式。 这个选项也可以被明确地设置，把$config['page_query_string'] 设置为 TRUE，分页链接将变成：
> [http://example.com/index.php?c=test&m=page&per_page=20](http://example.com/index.php?c=test&m=page&per_page=20)
请注意，"per_page" 是默认传递的查询字符串，但也可以使用 $config['query_string_segment'] = '你的字符串' 来配置。
**$config['reuse_query_string'] = FALSE;**
默认情况下你的查询字符串参数会被忽略，将这个参数设置为 TRUE ，将会将查询字符串参数添加到 URI 分段的后面 以及 URL 后缀的前面。:
~~~
http://example.com/index.php/test/page/20?query=search%term
~~~
这可以让你混合使用 [URI 分段](http://codeigniter.org.cn/user_guide/general/urls.html) 和 查询字符串参数，这在 3.0 之前的版本中是不行的。
**$config['prefix'] = '';**
给路径添加一个自定义前缀，前缀位于偏移段的前面。
**$config['suffix'] = '';**
给路径添加一个自定义后缀，后缀位于偏移段的后面。
**$config['use_global_url_suffix'] = FALSE;**
当该参数设置为 TRUE 时，会使用 **application/config/config.php** 配置文件中定义的 $config['url_suffix'] 参数 **重写** $config['suffix'] 的值。
## [添加封装标签](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id20)
如果你希望在整个分页的周围用一些标签包起来，你可以通过下面这两个参数：
**$config['full_tag_open'] = '';**
起始标签放在所有结果的左侧。
**$config['full_tag_close'] = '';**
结束标签放在所有结果的右侧。
## [自定义第一个链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id21)
**$config['first_link'] = 'First';**
左边第一个链接显示的文本，如果你不想显示该链接，将其设置为 FALSE 。
注解
该参数的值也可以通过语言文件来翻译。
**$config['first_tag_open'] = '';**
第一个链接的起始标签。
**$config['first_tag_close'] = '';**
第一个链接的结束标签。
**$config['first_url'] = '';**
可以为第一个链接设置一个自定义的 URL 。
## [自定义最后一个链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id22)
**$config['last_link'] = 'Last';**
右边最后一个链接显示的文本，如果你不想显示该链接，将其设置为 FALSE 。
注解
该参数的值也可以通过语言文件来翻译。
**$config['last_tag_open'] = '';**
最后一个链接的起始标签。
**$config['last_tag_close'] = '';**
最后一个链接的结束标签。
## [自定义下一页链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id23)
**$config['next_link'] = '>';**
下一页链接显示的文本，如果你不想显示该链接，将其设置为 FALSE 。
注解
该参数的值也可以通过语言文件来翻译。
**$config['next_tag_open'] = '';**
下一页链接的起始标签。
**$config['next_tag_close'] = '';**
下一页链接的结束标签。
## [自定义上一页链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id24)
**$config['prev_link'] = '<';**
上一页链接显示的文本，如果你不想显示该链接，将其设置为 FALSE 。
注解
该参数的值也可以通过语言文件来翻译。
**$config['prev_tag_open'] = '';**
上一页链接的起始标签。
**$config['prev_tag_close'] = '';**
上一页链接的结束标签。
## [自定义当前页面链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id25)
**$config['cur_tag_open'] = '';**
当前页链接的起始标签。
**$config['cur_tag_close'] = '';**
当前页链接的结束标签。
## [自定义数字链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id26)
**$config['num_tag_open'] = '';**
数字链接的起始标签。
**$config['num_tag_close'] = '';**
数字链接的结束标签。
## [隐藏数字链接](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id27)
如果你不想显示数字链接（例如你只想显示上一页和下一页链接），你可以通过下面的代码来阻止它显示:
~~~
$config['display_pages'] = FALSE;
~~~
## [给链接添加属性](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id28)
如果你想为分页类生成的每个链接添加额外的属性，你可以通过键值对设置 "attributes" 参数:
~~~
// Produces: class="myclass"
$config['attributes'] = array('class' => 'myclass');
~~~
注解
以前的通过 "anchor_class" 参数来设置 class 属性的方法已经废弃。
## [禁用 "rel" 属性](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id29)
默认 rel 属性会被自动的被添加到合适的链接上，如果由于某些原因，你想禁用它，你可以用下面的方法：
~~~
$config['attributes']['rel'] = FALSE;
~~~
## [类参考](http://codeigniter.org.cn/user_guide/libraries/pagination.html#id30)
classCI_Pagination
initialize([$params = array()])
参数:
* **$params** (array) -- Configuration parameters
返回: CI_Pagination instance (method chaining)
返回类型: CI_Pagination
使用提供的参数初始化分页类。
create_links()
返回: HTML-formatted pagination
返回类型: string
返回分页的代码，包含生成的链接。如果只有一个页面，将返回空字符串。