hehex/hehep-hpage

hehep-hpage 是一个PHP分页组件,支持自定义分页器,支持自定义分页样式,支持lastId模式

Maintainers

Details

github.com/chinahehex/hehep-hpage

Source

Issues

Installs: 7

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 1

Forks: 0

Open Issues: 0

v1.0.0 2024-09-13 16:20 UTC

Requires

  • php: >=7.1

Apache-2.0 00aea873774f516e6db779306bee51c09ba6e587

  • hehe

This package is auto-updated.

Last update: 2025-06-19 06:57:02 UTC

README

介绍

  • hehep-hpage 是一个PHP分页组件、
  • 支持自定义分页器
  • 支持自定义分页样式

安装

  • gitee下载:
git clone git@gitee.com:chinahehex/hehep-hpage.git
  • github下载:
git clone git@github.com:chinahehex/hehep-hpage.git
  • 命令安装：
composer require hehex/hehep-hpage

组件配置

$config = [
    // 分页管理器
    //'class'=>'hehe\core\hpage\Pagination',
    
    // 客户端页面参数名称
    'pageVar'=>'page',
    
    // 客户端每页条数参数名称
    'psizeVar'=>'psize',
    
    // 客户端lastId参数名称
    'lastIdVar'=>'lastId',
    
    // 预定义分页器
    'paginators' => [
        'query'=>['class'=>QueryPaginator::class,'styleClass'=>'样式类路径']
    ],
    
    // toArray 返回的变量别名,基本格式<键名=>别名>
    'retAlias'=>[
        'total'=>'total',// 总条数
        'psize'=>'psize',// 每页条数
        'totalPage'=>'totalPage',// 总页数
        'currentPage'=>'currentPage',// 当前页码
        'data'=>'data',// 当前页数据
        'lastId'=>'lastId'// 当前页最后一条数据id
    ],
    
    // url地址生成器call_user_func 方法格式,Route::buildUrl,闭包
   'uriBuilder'=>[],
];

基本示例

  • 客户端分页
use hehe\core\hpage\Pagination;
use hehe\core\hroute\Route;
$hpage = new Pagination();
// 表单数据
$form = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
];

// 设置全局url地址生成器
$hpage->setUriBuilder('hehe\core\hroute\Route::buildUrl');

// 创建一个客户端分页器
$paginator = $hpage->queryPaginator($form);

// 主动设置每页显示条数(不接受客户端每页条数参数)
$paginator->setPageSize(10);

// 主动设置当前页码(不接受客户端页码参数)
$paginator->setCurrentPage(2);

// 设置总条数
$paginator->setTotalCount(3000);

// 获取总页数
$paginator->getTotalPage();

// 获取分页起始位置(用于数据库查询)
$paginator->getOffset();

// 获取分页条数(用于数据库查询)
$paginator->getLimit();

// 设置当前分页数据
$paginator->setData([]);

// 获取分页相关参数
$paginator->toArray();
  • 内部分页
use hehe\core\hpage\Pagination;
$hpage = new Pagination();
// 创建一个内部 分页器
$paginator = $hpage->paginator(1,10);

// 主动设置每页显示条数
$paginator->setPageSize(10);

// 主动设置当前页码
$paginator->setCurrentPage(2);

// 设置总条数
$paginator->setTotalCount(3000);

// 获取总页数
$paginator->getTotalPage();

// 获取分页起始位置(用于数据库查询)
$paginator->getOffset();

// 获取分页条数(用于数据库查询)
$paginator->getLimit();

// 设置当前分页数据
$paginator->setData([]);

// 获取分页相关参数
$paginator->toArray();

默认分页器

  • 说明
类路径：\hehe\core\hpage\Paginator
功能:提供分页基本功能，封装了分页相关参数，支持自定义分页样式。
  • 创建默认分页器
use \hehe\core\hpage\Pagination;
use \hehe\core\hpage\paginators\Paginator;
use \hehe\core\hpage\paginators\QueryPaginator;
$hpage = new Pagination();

// 创建一个默认分页器,默认每页显示10条数据,当前页码为1
$paginator = $hpage->paginator(1,10);
$paginator = new Paginator(1,10);

// toArray 返回分页相关参数
$result = $paginator->toArray();

// 返回的结果为：
$result = [
    'total'=>10,// 总条数 
    'psize'=>1,// 每页显示条数 
    'totalPage'=>0,// 总页数
    'currentPage'=>0,// 当前页码 
    'data'=>[],// 当前页数据
];
  • 创建客户端分页器
use \hehe\core\hpage\Pagination;
use \hehe\core\hpage\paginators\QueryPaginator;
$hpage = new Pagination();
$formQuery = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
    'lastId'=>''// 当前页最后一条数据id
];
$paginator = $hpage->queryPaginator($formQuery,10);
$paginator = new QueryPaginator($formQuery,10);

// toArray 返回分页相关参数
$result = $paginator->toArray();

// 返回的结果为：
$result = [
    'psize'=>10,// 每页显示条数
    'currentPage'=>1,// 当前页码
    'total'=>0,// 总条数
    'totalPage'=>0,// 总页数
    'data'=>[],// 当前页数据
    'pageVar'=>'',// 客户端页码参数名称
    'psizeVar'=>'',// 客户端每页条数
    'lastId'=>'',// 当前页最后一条数据id
];
  • 设置/获取分页参数
use \hehe\core\hpage\Pagination;
$hpage = new Pagination();
$paginator = $hpage->paginator();

// 每页显示条数(10)
$paginator->setPageSize(10);
$paginator->getPageSize();

// 当前页码(1)
$paginator->setCurrentPage(1);
$paginator->getCurrentPage();

// 总条数(3000)
$paginator->setTotalCount(3000);
$paginator->getTotalCount();

// 总页数(300)
$paginator->getTotalPage();

// 分页数据库起始位置,读取条数
$paginator->getOffset();
$paginator->getLimit();

// 设置当前分页数据
$paginator->setData([]);

// 获取分页相关参数
$paginator->toArray();
  • LastId模式
use \hehe\core\hpage\Pagination;
$hpage = new Pagination();
$formQuery = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
    'lastId'=>2// 当前页最后一条数据id
];
$paginator = $hpage->queryPaginator($formQuery);

// 开启lastId模式，并设置数据端参数名称:"id",'desc' id 的排序规则,客户端参数名称:"lastId"
$paginator->asLastMode('id','desc','lastId');

// 获取客户端lastId参数:2
$paginator->getQueryLastId();

$paginator->setData([
    ['id'=>1, 'name'=>'test1','roleId'=>1],
    ['id'=>2, 'name'=>'test2','roleId'=>3],
    ['id'=>3, 'name'=>'test3','roleId'=>4],
    ['id'=>4, 'name'=>'test4','roleId'=>4],
]);

// 获取数据端最后一条数据id:4
$paginator->getDataLastId();

// 获取是否需要查询总条数状态,当客户端lastId参数为空时，返回true
$paginator->isQueryCount();

分页URL

  • 独立设置分页URL
use \hehe\core\hpage\Pagination;
$hpage = new Pagination();
$formQuery = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
];
$paginator = $hpage->queryPaginator($formQuery);
$style = $paginator->newStyle();

// 设置分页URL
$style->setPath('api/test?id=1');

// 带[PAGE]占位符URL
$style->setPath('api/test/[PAGE]?id=1');

$currentPageUrl = $style->getCurrentPageUrl();
// $currentPageUrl: api/test?id=1&page=2
  • 全局URL生成器
use \hehe\core\hpage\Pagination;
$hpage = new Pagination();
// 设置全局URL生成器
$hpage->setUriBuilder(function(string $uri,array $uriParams = []){
    // 自定义自己的URL生成规则
    // $uriParams 已经包含了分页参数
    // return Route::buildUrL($uri,$uriParams);
    return $uri . '?' . http_build_query($uriParams);
});
$hpage = new Pagination();
$formQuery = ['page'=>2,'psize'=>10];
$paginator = $hpage->queryPaginator($formQuery);
$style = $paginator->newStyle();

// 设置分页样式url生成器
$style->setUriBuilder();

$style->setUrl('user/logs',['userId'=>1]);

// 获取当前页URL
$currentPageUrl = $style->getCurrentPageUrl();
// $currentPageUrl : user/logs?userId=1&page=2

分页样式器

  • 说明
类路径：\hehe\core\hpage\styles\PaginatorStyle
  • 默认分页样式器
use \hehe\core\hpage\Pagination;
use hehe\core\hpage\styles\PaginatorStyle;
$hpage = new Pagination();
$formQuery = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
];
$paginator = $hpage->queryPaginator($formQuery);

// 分页器与样式绑定
$pstyle = $paginator->setStyleClass(PaginatorStyle::class);

// 创建分页器样式对象
$args = [];// 分页样式器构造参数
$style = $paginator->newStyle(...$args);

// 获取分页器样式参数
$style->toArray();
  • 数字分页样式器
use \hehe\core\hpage\Pagination;
use hehe\core\hpage\styles\NumPaginatorStyle;
$hpage = new Pagination();
$formQuery = [
    'page'=>1,// 当前页码
    'psize'=>10,// 每页显示条数
];
$paginator = $hpage->queryPaginator($formQuery);

// 分页器与样式绑定
$pstyle = $paginator->setStyleClass(NumPaginatorStyle::class);

// 创建分页器样式对象
$args = [6];// 分页样式器构造参数
$style = $paginator->newStyle(...$args);

// 获取分页器样式参数
$style->toArray();