Yii2框架中的数据分页功能实现
在Web应用开发中,当需要展示大量数据时,数据分页是一个不可或缺的功能。它不仅能够显著提升页面的加载速度,还能改善用户的浏览体验。Yii2框架为开发者提供了两种主要且便捷的数据分页实现方式:一种是利用ActiveDataProvider和GridView部件进行自动化分页,适用于表格数据的展示;另一种是结合Pagination类和LinkPager部件实现更灵活的自定义分页。
方法一:利用ActiveDataProvider和GridView实现表格数据分页
当您希望以结构化的表格形式展示数据库记录,并且需要集成分页、排序、过滤等功能时,ActiveDataProvider与GridView的组合是Yii2中一种高效的解决方案。ActiveDataProvider负责处理数据查询、总数统计以及分页逻辑,而GridView则负责将这些数据渲染成带有分页导航的HTML表格。
控制器文件示例 (例如 controllers/ProductCatalogController.php)
在控制器中,您需要创建一个ActiveDataProvider实例。在此实例中,传入用于获取数据的查询对象和分页相关的配置,例如每页显示的记录数量。
<?php
namespace app\controllers;
use yii\web\Controller;
use yii\data\ActiveDataProvider;
use app\models\ProductRecord; // 假设您的产品模型名为 ProductRecord
class ProductCatalogController extends Controller
{
/**
* 显示带有分页的产品列表
* @return string
*/
public function actionProductOverview()
{
// 构建基础查询,例如只查询已上架的产品并按创建时间倒序
$mainProductQuery = ProductRecord::find()
->where(['is_active' => 1])
->orderBy('creation_timestamp DESC');
// 创建 ActiveDataProvider 实例
$productListingProvider = new ActiveDataProvider([
'query' => $mainProductQuery,
'pagination' => [
'pageSize' => 5, // 每页显示 5 条记录
],
]);
// 渲染视图,并将数据提供者传递给视图
return $this->render('product-grid', [
'listingProvider' => $productListingProvider,
]);
}
}
视图文件示例 (例如 views/product-catalog/product-grid.php)
在视图中,使用GridView部件,并将其dataProvider属性设置为控制器中创建的ActiveDataProvider实例。您可以通过配置GridView的各种属性(如layout、summary、pager和columns)来自定义表格的呈现方式和分页导航的样式。
<?php
use yii\grid\GridView;
?>
<h2>产品目录总览</h2>
= GridView::widget([
'dataProvider' => $listingProvider,
'layout' => "{summary}\n{items}\n{pager}", // 定义表格布局:总结信息、数据行、分页器
'summary' => "展示第 <b>{begin}-{end}</b> 条产品,共计 <b>{totalCount}</b> 条记录",
'tableOptions' => [
'class' => 'table table-hover table-striped', // 使用 Bootstrap 表格样式
],
'pager' => [
'firstPageLabel' => '《 首页',
'prevPageLabel' => '← 上一页', // 左箭头
'nextPageLabel' => '下一页 →', // 右箭头
'lastPageLabel' => '尾页 》',
'maxButtonCount' => 7, // 最多显示 7 个分页按钮
'linkContainerOptions' => ['class' => 'page-item'], // 分页链接容器的 CSS 类
'linkOptions' => ['class' => 'page-link'], // 分页链接本身的 CSS 类
'disabledListItemSubTagOptions' => [
'tag' => 'a',
'href' => 'javascript:void(0);', // 禁用链接的 href
'class' => 'page-link disabled' // 禁用链接的 CSS 类
],
],
'columns' => [
['class' => 'yii\grid\SerialColumn'], // 自动生成序号列
'product_code',
'product_name:text:产品名称', // 字段名:格式类型:列标题
[
'attribute' => 'category_id',
'label' => '分类',
'value' => function ($model) {
return $model->category->name ?? '未分类'; // 示例:从关联模型获取分类名称
},
],
'unit_price:currency:单价', // 示例:以货币格式显示
[
'attribute' => 'creation_timestamp',
'format' => ['date', 'php:Y-m-d H:i:s'],
'label' => '创建时间',
],
// 可根据需要添加其他列,如操作按钮列等
],
]); ?>
方法二:手动使用Pagination类和LinkPager部件实现自定义分页
当您的需求不适合使用GridView,或者您需要对数据展示进行更细致的定制时,可以手动使用Pagination类来处理分页逻辑,并结合LinkPager部件来渲染分页导航链接。
控制器文件示例 (例如 controllers/ActivityLogController.php)
在这种方法中,控制器通常需要执行两次数据库查询:一次用于获取总记录数以初始化分页信息,另一次则根据当前页码和每页大小获取对应的数据子集。
<?php
namespace app\controllers;
use yii\web\Controller;
use yii\data\Pagination;
use app\models\UserActivityLog; // 假设您的日志模型名为 UserActivityLog
class ActivityLogController extends Controller
{
/**
* 显示用户活动日志
* @return string
*/
public function actionViewActivity()
{
// 1. 创建基础查询对象,获取所有活动日志
$activityQuery = UserActivityLog::find()->where(['user_id' => \Yii::$app->user->id]);
// 2. 克隆查询对象以获取总记录数,避免影响实际数据查询
$totalActivities = $activityQuery->count();
// 3. 定义每页显示的记录数
$itemsPerPage = 4;
// 4. 初始化 Pagination 对象,用于计算分页信息
$pageNavigator = new Pagination([
'totalCount' => $totalActivities,
'pageSize' => $itemsPerPage,
]);
// 5. 根据 Pagination 对象确定的偏移量和限制,获取当前页的实际数据
$currentActivityRecords = $activityQuery->offset($pageNavigator->offset)
->limit($pageNavigator->limit)
->all();
// 6. 渲染视图,传递当前页数据和分页对象
return $this->render('activity-feed', [
'activityRecords' => $currentActivityRecords,
'pageNavigator' => $pageNavigator,
]);
}
}
视图文件示例 (例如 views/activity-log/activity-feed.php)
在视图中,您可以按照自定义的HTML结构遍历并显示控制器传递过来的数据模型数组。之后,将创建好的Pagination对象传递给LinkPager部件,它将自动根据分页信息生成一套带有页码链接的导航。
<?php
use yii\widgets\LinkPager;
use yii\helpers\Html; // 用于安全地编码输出内容
?>
<h2>我的活动日志</h2>
<div class="activity-list">
<?php if (!empty($activityRecords)): ?>
<?php foreach ($activityRecords as $record): ?>
<div class="activity-item card mb-3">
<div class="card-body">
<h5 class="card-title">活动ID: = Html::encode($record->activity_id) ?></h5>
<p class="card-text">
<strong>类型:</strong> = Html::encode($record->action_type) ?><br>
<strong>详情:</strong> = Html::encode($record->description) ?><br>
<strong>时间:</strong> = Html::encode($record->log_time) ?>
</p>
</div>
</div>
<?php endforeach; ?>
<?php else: ?>
<p class="alert alert-info">暂无活动日志记录。</p>
<?php endif; ?>
</div>
<nav aria-label="活动日志分页">
= LinkPager::widget([
'pagination' => $pageNavigator,
'nextPageLabel' => '下一页 >',
'prevPageLabel' => '< 上一页',
'firstPageLabel' => '« 第一页', // 双左箭头
'lastPageLabel' => '最后一页 »', // 双右箭头
'linkContainerOptions' => ['class' => 'page-item'],
'linkOptions' => ['class' => 'page-link'],
'disabledListItemSubTagOptions' => [
'tag' => 'a',
'href' => 'javascript:void(0);',
'tabindex' => '-1',
'class' => 'page-link disabled' // 添加 'disabled' 类以正确禁用链接样式
],
]);?>
</nav>