FLEAPHP中FLEA_Helper_Pager分页组件使用详解

Pager 分页函数构造函数逻辑

FLEA_Helper_Pager的构造函数根据传入的 $source 参数类型采取不同的数据获取策略：

1. 当 $source 为 TableDataGateway 对象时：
     自动调用该对象的 findCount() 方法统计总记录数，并缓存查询条件与排序规则，便于后续翻页时复用上下文。
2. 当 $source 为 SQL 字符串时：
     将 SQL 包裹在 SELECT COUNT(*) FROM ( ... ) as _count_table 中进行子查询以获取总数。此时需手动通过 setCount() 或确保源对象可被正确解析，且无需额外提供条件和排序参数。

// 伪代码示意内部处理分支
if (is_object($source)) {
    // 自动从TDG获取总数
    $this->totalCount = (int)$this->source->findCount($conditions);
} elseif (!empty($source)) {
    // 从SQL字符串构建COUNT查询
    $sql = "SELECT COUNT(*) FROM ( $source ) as _count_table";
    $this->dbo =& FLEA::getDBO();
    $this->totalCount = (int)$this->dbo->getOne($sql);
}

关键参数说明

在使用分页器时，需关注以下输入参数对行为的影响：

• $source：数据来源，支持 FLEA_Db_TableDataGateway 实例或 SQL 语句字符串。
• $currentPage：当前请求的页码索引（通常从0或1开始，取决于 $basePageIndex 配置）。
• $pageSize：每页显示的记录数量，默认为 20。
• $conditions：查询条件数组或字符串，仅在 $source 为 TDG 对象时生效。
• $sortby：排序方式字符串，仅在 $source 为 TDG 对象时生效。
• $basePageIndex：页码基数，决定第一页的索引值（如 0 或 1）。

完整使用示例

以下示例演示如何连接数据库、定义数据表模型，并实例化分页器获取分页数据。

第1步：环境初始化与数据库连接

首先引入必要的文件并配置 DSN（数据源名称）。这里以 WordPress 的 wp_posts 表为例，假设数据库名为 wordpress。

$dirname = dirname(__FILE__);
define('APP_DIR', $dirname . '/APP');
define('NO_LEGACY_FLEAPHP', true);
require($dirname.'/FleaPHP/FLEA/FLEA.php');

// 设置缓存目录（可选）
FLEA::setAppInf('internalCacheDir',$dirname.'/_Cache');

// 链接数据库配置
$dsn = array(
    'driver' => 'mysql',
    'host' => 'localhost',
    'login' => 'root',
    'password' => '',
    'database' => 'wordpress'
);
FLEA::setAppInf('dbDSN',$dsn);

第2步：加载类与定义数据表网关

加载 FLEA_Db_TableDataGateway 类，并继承它以指定具体的表名和主键。这将为后续的自动计数提供结构支持。

FLEA::loadClass('FLEA_Db_TableDataGateway');
FLEA::loadClass('FLEA_Helper_Pager');

class Teble_Class extends FLEA_Db_TableDataGateway {
    var $tableName = 'wp_posts';
    var $primaryKey = 'ID';
}

第3步：实例化分页器并获取数据

创建数据表实例和分页器实例。此处设置为第 2 页，每页显示 5 条记录。最后调用 getPagerData() 获取结构化分页信息。

$tableposts =& new Teble_Class();
// 参数：数据源(对象), 当前页(2), 每页条数(5)
$pager =& new FLEA_Helper_Pager($tableposts, 2, 5);

// 获取分页结果数组
$page = $pager->getPagerData();
print_r($page);

getPagerData 返回数据结构

getPagerData() 返回一个关联数组，包含前端渲染列表导航所需的全部元数据：

• 'pageSize'：每页条数。
• 'totalCount' / 'count'：符合条件的总记录数。
• 'pageCount'：总页数。
• 'firstPage' / 'lastPage'：首页和末页的数据切片对象或标记。
• 'prevPage' / 'nextPage'：上一页和下一页的指针信息。
• 'currentPage' / 'currentPageNumber'：当前页对象及数字索引。

开发者可根据 'prevPage' 和 'nextPage' 是否为空来判断是否显示“上一页/下一页”按钮，并结合 'pageCount' 生成完整的页码列表。

注意事项与排错

• SQL 模式限制：若 $source 传入的是 SQL 字符串，FLEA_Helper_Pager 不会自动缓存查询条件。若在翻页过程中需要保持相同的过滤条件，必须确保每次重建分页器时都传入相同的 SQL 语句或切换回 TDG 对象模式。
• 数据库对象获取：在 SQL 模式下，若无显式调用 setDBO()，类会尝试通过 FLEA::getDBO() 获取默认数据库连接。若未配置 DSN 或未初始化框架，可能导致连接失败。
• 性能考量：对于大数据量，自动生成的 COUNT(*) 子查询可能在某些 MySQL 版本上较慢。若遇到性能瓶颈，可考虑先自行执行 Count 查询，再通过 setCount() 或直接传递已知总数给底层逻辑优化。