<?php
class WHMCS_Pagination extends WHMCS_TableQuery{
protected $page = 1;
protected $defaultsort = 'ASC';
protected $defaultorderby = 'id';
protected $name = 'default';
protected $sort = '';
protected $orderby = '';
protected $numResults = 0;
protected $pagination = true;
public function __construct($name = '', $defaultorderby = '', $defaultsort = '')
{
if( $name )
{
$this->name = $name;
}
else
{
$name = $this->name;
}
if( $defaultorderby )
{
$this->setDefaultOrderBy($defaultorderby);
}
if( $defaultsort )
{
$this->setDefaultSortDirection($defaultsort);
}
return $this;
}
/**
* This function reads and interprets the sorting data (SD) stored
* in cookies for the current page.
*
* NB: It must be called prior to any filter class store function
* in order to correctly preserve applied filters.
*
* @return void
*/
public function digestCookieData()
{
global $whmcs;
$sortdata = WHMCS_Cookie::get('SD', true);
$name = $this->name;
if( array_key_exists($name, $sortdata) )
{
$orderby = $sortdata[$name]['orderby'];
if( $orderby )
{
$this->setOrderBy($orderby);
}
$orderbysort = $sortdata[$name]['sort'];
if( $orderbysort )
{
$this->setSortDirection($orderbysort);
}
}
if( $orderby = $whmcs->get_req_var('orderby') )
{
$this->setOrderBy($orderby);
$sortdata[$name] = array( 'orderby' => $this->orderby, 'sort' => $this->sort );
WHMCS_Cookie::set('SD', $sortdata);
redir("filter=1");
}
if( $page = $whmcs->get_req_var('page') )
{
$this->setPage($page);
}
$this->setRecordLimit($whmcs->get_config('NumRecordstoDisplay'));
}
public function setPage($page)
{
$this->page = (int) $page;
return true;
}
public function getPage()
{
$page = (int) $this->page;
$totalpages = $this->getTotalPages();
if( $page < 1 )
{
$page = 1;
}
if( $totalpages < $page )
{
$page = $totalpages;
}
return $page;
}
public function setNumResults($num)
{
$this->numResults = $num;
}
public function getNumResults()
{
return (int) $this->numResults;
}
public function getTotalPages()
{
$pages = ceil($this->getNumResults() / $this->getRecordLimit());
if( $pages < 1 )
{
$pages = 1;
}
return $pages;
}
public function getPrevPage()
{
$page = $this->getPage();
$pages = $this->getTotalPages();
if( $page <= 1 || $pages <= 1 )
{
return '';
}
return $page - 1;
}
public function getNextPage()
{
$page = $this->getPage();
$pages = $this->getTotalPages();
if( $pages <= $page )
{
return '';
}
return $page + 1;
}
public function setDefaultOrderBy($field)
{
global $whmcs;
$this->defaultorderby = $whmcs->sanitize('a-z', $field);
}
public function setDefaultSortDirection($sort)
{
$this->defaultsort = strtoupper($sort) == 'DESC' ? 'DESC' : 'ASC';
}
public function setOrderBy($field)
{
if( $this->orderby == $field )
{
$this->reverseSortDirection();
}
else
{
$this->orderby = $field;
}
return true;
}
public function setValidOrderByValues($array)
{
if( !is_array($array) )
{
return false;
}
$this->validorderbyvalues = $array;
return true;
}
public function getValidOrderByValues()
{
return $this->validorderbyvalues;
}
public function isValidOrderBy($field)
{
return in_array($field, $this->getValidOrderByValues());
}
public function getOrderBy()
{
if( $this->isValidOrderBy($this->orderby) )
{
return $this->orderby;
}
$this->setSortDirection('');
return $this->defaultorderby;
}
public function setSortDirection($sort)
{
$this->sort = $sort;
return true;
}
public function reverseSortDirection()
{
if( $this->sort == 'ASC' )
{
$this->sort = 'DESC';
}
else
{
$this->sort = 'ASC';
}
return true;
}
public function getSortDirection()
{
if( in_array($this->sort, array( 'ASC', 'DESC' )) )
{
return $this->sort;
}
return $this->defaultsort;
}
public function setPagination($boolean)
{
$this->pagination = $boolean;
}
public function isPaginated()
{
return $this->pagination ? true : false;
}
}
