API 文档 - ginkgo


ginkgo\Paginator

分页处理器


类摘要

namespace ginkgo;

class Paginator {
    // 属性
    public $config = array();
    public $current;
    public $count;
    public $totalRow;

    protected static $instance;

    private $configThis = array(
        'perpage'      => 10,
        'pergroup'     => 10,
        'pageparam'    => 'page',
    );

    // 方法
    public static instance( [ array $config ] ) : object
    public config( array $config )
    public make( [ mixed $current = 'get' ] ) : array
    public current( [ mixed $current = 'get' ] )
    public count( [ int $count ] ) : int
    public perpage( [ int $perpage ] ) : int
    public pergroup( [ int $pergroup ] ) : int
    public pageparam( [ string $pageparam ] ) : string

    protected __construct( [ array $config ] ) : object
    protected __clone()

    private totalProcess() : array
    private groupProcess() : array
    private offsetProcess() : int
    private stepProcess() : array
}

成员目录

- 权限 类型 描述
属性 - - -
$config public array 配置
$current public int 当前页码
$count public int 总记录数
$totalRow public array 分页统计
$instance protected object static 本类实例
$configThis private array 默认配置
方法 - - -
__construct() protected instance()
__clone() protected 克隆,无实际功能,仅供限制为单例模式使用
instance() public static 实例化
config() public 配置
make() public 生成分页参数
current() public 设置、获取当前页码
count() public 设置、获取总记录数
perpage() public 设置、获取每页记录数
pergroup() public 设置、获取每组页数
pageparam() public 设置、获取分页参数
totalProcess() private 总页数处理
groupProcess() private 分组处理
offsetProcess() private 偏移处理
stepProcess() private 步进处理

$config 配置,$configThis 默认配置

public static $config;
private static $configThis;

结构

名称 类型 默认 描述
perpage int 10 每页记录数
pergroup int 10 每组页数
pageparam string page 分页参数

config() 配置

public function config( array $config )

参数

返回


make() 生成分页参数

public function make( [ mixed $current = 'get' ] ) : array

参数

返回

  • 分页参数

current() 设置、获取当前页码

public function current( [ mixed $current ] ) : int

参数

  • current 当前页码,为空时获取当前页码

    混合型,默认为 get

    可能的值

    描述
    get 用 get 方法获取页码
    post 用 post 方法获取页码
    整数 当前页码

返回

  • 当前页码

count() 设置、获取总记录数

public function count( [ int $count ] ) : int

参数

  • count 总记录数,为空时获取总记录数

返回

  • 总记录数

perpage() 设置、获取每页记录数

public function perpage( [ int $perpage ] ) : int

参数

  • perpage 每页记录数,为空时获取每页记录数

返回

  • 每页记录数

pergroup() 设置、获取每组页数

public function pergroup( [ int $pergroup ] ) : int

参数

  • pergroup 每组页数,为空时获取每组页数

返回

  • 每组页数

pageparam() 设置、获取分页参数

public function pageparam( [ string $pageparam ] ) : string

参数

  • pageparam 分页参数,为空时获取分页参数

返回

  • 分页参数

totalProcess() 总页数处理

private function totalProcess() : array

参数

返回

  • 总页数参数

groupProcess() 分组处理

private function groupProcess() : array

参数

返回

  • 分组参数

offsetProcess() 偏移处理

private function offsetProcess() : int

参数

返回

  • 偏移数

stepProcess() 步进处理

private function stepProcess() : array

参数

返回

  • 步进参数