Pagination - 类別

如何使用 Pagination 类别的简单例子，你可以将它放进你控制器内的 action 方法。

如何使用查讯建立器来分页

$config = array(
	'pagination_url' => 'http://localhost/fuel/welcome/index/',
	'total_items'    => 10,
	'per_page'       => 5,
	'uri_segment'    => 3,
	// 或者，如果你偏好透过查询字串的分页
	//'uri_segment'    => 'page',
);

// 建立一个名为 'mypagination' 的实例
$pagination = Pagination::forge('mypagination', $config);

$data['example_data'] = DB::select('id', 'value')
				->from('pagination')
				->limit($pagination->per_page)
				->offset($pagination->offset)
				->execute()
				->as_array();

// 我们传递物件，当在检视中输出时它会被呈现
$data['pagination'] = $pagination;

// 回传检视
return \View::forge('welcome/index', $data);

如何使用 ORM 来分页

$config = array(
	'pagination_url' => 'http://localhost/fuel/posts/index/',
	'total_items'    => Model_Post::count(),
	'per_page'       => 10,
	'uri_segment'    => 3,
	// 或者，如果你偏好透过查询字串的分页
	//'uri_segment'    => 'page',
);

$pagination = Pagination::forge('mypagination', $config);

$data['example_data'] = Model_Post::query()
				->rows_offset($pagination->offset)
				->rows_limit($pagination->per_page)
				->get();

// 我们传递物件，当在检视中输出时它会被呈现
$data['pagination'] = $pagination;

// 回传检视
return \View::forge('posts/index', $data);

配置

你可以透过几种方法配置分页实例。你可以传递一个带有配置的阵列当你锻造（forge）实例， 或者你可以直接在该实例上更新特性。

可定义以下的配置设定：

null

3

5

0

10

null

false

false

0.50

连结偏移

预设情况下，Pagination 类别会尝试定位活跃连结（目前页面） 在分页区块中间。

你可以使用配置中的 link_offset 值来控制此行为。这个值可以定义为 0 到 1 之间的浮点数，或 1 到 100 之间的整数（像百分比）。预设情况下，这个值是设为 0.5 （= 50%）。 如果你让值变小，活跃连结会往左移动，如果你让值变大， 活跃连结会往右移动。

範例

让我们假设你有共 20 页可以显示。你已经设定 num_links 为 5，总共显示 5 页的连结， 而你显示上一页和下一页连结也是如此。你目前选择的是第 6 页。

• 随着预设 0.5 的设定，会显示

  «  4  5  6  7  8  »

  ， 保持选择的第 6 页恰好地在区块中间。
• 当你变更设定为 0，Pagination 会始终试着让第一个连结为活跃连结。在这个情况下，

  «  6  7  8  9  10  »

  会被显示，让选择的第 6 页为区块中的第一个连结。
• 如果你想变更设定为 1，Pagination 会始终试着让最后一个连结为活跃连结。在这个情况下，

  «  2  3  4  5  6  »

  会被显示。

你可以使用範围内的任何值，要逐步转移活跃焦点往左或右。很明显地，你显示愈多连结， 就可以愈精细切换焦点。

这只会在有足够页面可以这样做的时候适用。如果你只有 5 页可用，你想要显示 5 个连结，而第 3 页是目前页面，没有显示上一页和下一页连结，目前页面会在中间，不管 link_offset 的设定是什幺。根本没有足够的页面可用来移动目前页面连结往左或右。

样板化

每个 Pagination 实例使用一个样板来产生需要用来建立分页标记的 HTML。 你可以在 config/pagination.php 档案中储存你的标准样板。 在你做任何修改之前，从核心 config 文件夹複製到你的 app config 文件夹。 预设配置档案配有三个样板，FuelPHP 预设以及相容 Twitter Bootstrap v2 和 v3 的样板。

以下样板条目必须被定义：

<div class="pagination">\n\t{pagination}\n</div>\n

<span class="first">\n\t{link}\n</span>\n

««

\t\t<a href="{uri}">{page}</a>\n

<span class="previous">\n\t{link}\n</span>\n

«

\t\t<a href="{uri}" rel="prev">{page}</a>\n

<span class="previous-inactive">\n\t{link}\n</span>\n

\t\t<a href="{uri}" rel="prev">{page}</a>\n

<span>\n\t{link}\n</span>\n

\t\t<a href="{uri}">{page}</a>\n

<span class="active">\n\t{link}\n</span>\n

\t\t<a href="{uri}">{page}</a>\n

<span class="next">\n\t{link}\n</span>\n

»

\t\t<a href="{uri}" rel="next">{page}</a>\n

<span class="next-inactive">\n\t{link}\n</span>\n

\t\t<a href="{uri}" rel="next">{page}</a>\n

<span class="last">\n\t{link}\n</span>\n

»»

\t\t<a href="{uri}">{page}</a>\n

在样板中，{uri} 将被产生的分页连结取代（# 如果是非活跃样板）， 并且 {page} 被页码或上一个／下一个标记取代。 如果你想要在这些标记使用图像，只要修改定义在样板中相应的连结， 用图像标记取代 {page}。

当你锻造 Pagination 实例时所传递的配置将与定义在你配置档案中的预设样板合併。 这能让你指传递你想要覆写值。 如果你在配置档案中的样板不完整， 上面所提的预设值将被使用。

静态介面

为了方便你， Pagination 类别也有一个只对预设实例操作的静态介面。

// 取回目前页码
$page_number = Pagination::get('current_page');

// 这是一个别名
$page_number = Pagination::instance()->current_page;

// 设定列总数
$page_number = Pagination::set('total_items', 610);

// 这是一个别名
Pagination::instance()->total_items = 610;

为了向下相容，静态方法 set_config()、create_links()、 next_link() 和 prev_link() 将被模拟在预设实例， 以最小化升级一个已存在的应用程序到 FuelPHP v1.4+ 的迁移影响。

请注意，现下没有可能的方法模拟直接存取静态类别特性， 所以如果你的应用程序使用的话，你将必须改变它们：

// v1.4 前用法：
Pagination::$per_page = 10;

// 新用法：
Pagination::set('per_page', 10);

// v1.4 前用法：
Model_Article::find()
	->order_by('date', 'ASC')
	->rows_offset(\Pagination::$offset)
	->rows_limit(\Pagination::$per_page)
	->get();

// 新用法：
Model_Article::query()
	->order_by('date', 'ASC')
	->rows_offset(\Pagination::get('offset'))
	->rows_limit(\Pagination::get('per_page'))
	->get();