You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

207 lines
6.3 KiB

13 years ago
<?php
/**
* @link http://www.yiiframework.com/
12 years ago
* @copyright Copyright (c) 2008 Yii Software LLC
13 years ago
* @license http://www.yiiframework.com/license/
*/
12 years ago
namespace yii\web;
use Yii;
13 years ago
/**
* Pagination represents information relevant to pagination of data items.
13 years ago
*
* When data needs to be rendered in multiple pages, Pagination can be used to
* represent information such as [[itemCount|total item count]], [[pageSize|page size]],
* [[page|current page]], etc. These information can be passed to [[yii\web\widgets\Pager|pagers]]
* to render pagination buttons or links.
13 years ago
*
* The following example shows how to create a pagination object and feed it
* to a pager.
13 years ago
*
* Controller action:
12 years ago
*
* ~~~
* function actionIndex()
* {
* $query = Article::find()->where(array('status' => 1));
* $countQuery = clone $query;
* $pages = new Pagination($countQuery->count());
* $models = $query->offset($pages->offset)
* ->limit($pages->limit)
* ->all();
13 years ago
*
* $this->render('index', array(
* 'models' => $models,
12 years ago
* 'pages' => $pages,
13 years ago
* ));
* }
12 years ago
* ~~~
13 years ago
*
* View:
*
* ~~~
12 years ago
* foreach($models as $model) {
* // display $model here
* }
13 years ago
*
* // display pagination
12 years ago
* $this->widget('yii\web\widgets\LinkPager', array(
13 years ago
* 'pages' => $pages,
12 years ago
* ));
* ~~~
13 years ago
*
* @property integer $pageCount Number of pages.
* @property integer $page The zero-based index of the current page.
13 years ago
* @property integer $offset The offset of the data. This may be used to set the
* OFFSET value for a SQL statement for fetching the current page of data.
* @property integer $limit The limit of the data. This may be used to set the
* LIMIT value for a SQL statement for fetching the current page of data.
*
* @author Qiang Xue <qiang.xue@gmail.com>
12 years ago
* @since 2.0
13 years ago
*/
12 years ago
class Pagination extends \yii\base\Object
13 years ago
{
/**
* @var string name of the GET variable storing the current page index. Defaults to 'page'.
*/
12 years ago
public $pageVar = 'page';
13 years ago
/**
* @var boolean whether to always have the page parameter in the URL created by [[createUrl()]].
* If false and [[page]] is 0, the page parameter will not be put in the URL.
13 years ago
*/
public $forcePageVar = false;
13 years ago
/**
12 years ago
* @var string the route of the controller action for displaying the paged contents.
* If not set, it means using the currently requested route.
13 years ago
*/
public $route;
13 years ago
/**
* @var array parameters (name=>value) that should be used to obtain the current page number
* and to create new pagination URLs. If not set, $_GET will be used instead.
12 years ago
*
* The array element indexed by [[pageVar]] is considered to be the current page number.
* If the element does not exist, the current page number is considered 0.
13 years ago
*/
public $params;
13 years ago
/**
* @var boolean whether to check if [[page]] is within valid range.
* When this property is true, the value of [[page]] will always be between 0 and ([[pageCount]]-1).
* Because [[pageCount]] relies on the correct value of [[itemCount]] which may not be available
* in some cases (e.g. MongoDB), you may want to set this property to be false to disable the page
* number validation. By doing so, [[page]] will return the value indexed by [[pageVar]] in [[params]].
13 years ago
*/
public $validatePage = true;
13 years ago
/**
* @var integer number of items on each page. Defaults to 10.
* If it is less than 1, it means the page size is infinite, and thus a single page contains all items.
13 years ago
*/
public $pageSize = 10;
13 years ago
/**
* @var integer total number of items.
13 years ago
*/
public $itemCount;
13 years ago
/**
* Constructor.
* @param integer $itemCount total number of items.
* @param array $config name-value pairs that will be used to initialize the object properties
13 years ago
*/
public function __construct($itemCount, $config = array())
13 years ago
{
$this->itemCount = $itemCount;
parent::__construct($config);
13 years ago
}
/**
* @return integer number of pages
*/
public function getPageCount()
{
if ($this->pageSize < 1) {
return $this->itemCount > 0 ? 1 : 0;
} else {
$itemCount = $this->itemCount < 0 ? 0 : (int)$this->itemCount;
return (int)(($itemCount + $this->pageSize - 1) / $this->pageSize);
}
13 years ago
}
private $_page;
13 years ago
/**
* Returns the zero-based current page number.
13 years ago
* @param boolean $recalculate whether to recalculate the current page based on the page size and item count.
* @return integer the zero-based current page number.
13 years ago
*/
public function getPage($recalculate = false)
13 years ago
{
if ($this->_page === null || $recalculate) {
$params = $this->params === null ? $_GET : $this->params;
12 years ago
if (isset($params[$this->pageVar]) && is_scalar($params[$this->pageVar])) {
$this->_page = (int)$params[$this->pageVar] - 1;
if ($this->validatePage) {
12 years ago
$pageCount = $this->getPageCount();
if ($this->_page >= $pageCount) {
$this->_page = $pageCount - 1;
12 years ago
}
13 years ago
}
if ($this->_page < 0) {
$this->_page = 0;
12 years ago
}
} else {
$this->_page = 0;
13 years ago
}
}
return $this->_page;
13 years ago
}
/**
* Sets the current page number.
13 years ago
* @param integer $value the zero-based index of the current page.
*/
public function setPage($value)
13 years ago
{
$this->_page = $value;
13 years ago
}
/**
* Creates the URL suitable for pagination with the specified page number.
* This method is mainly called by pagers when creating URLs used to perform pagination.
* @param integer $page the zero-based page number that the URL should point to.
13 years ago
* @return string the created URL
* @see params
* @see forcePageVar
13 years ago
*/
public function createUrl($page)
13 years ago
{
12 years ago
$params = $this->params === null ? $_GET : $this->params;
if ($page > 0 || $page >= 0 && $this->forcePageVar) {
12 years ago
$params[$this->pageVar] = $page + 1;
} else {
13 years ago
unset($params[$this->pageVar]);
12 years ago
}
$route = $this->route === null ? Yii::$app->controller->route : $this->route;
return Yii::$app->getUrlManager()->createUrl($route, $params);
13 years ago
}
/**
* @return integer the offset of the data. This may be used to set the
* OFFSET value for a SQL statement for fetching the current page of data.
*/
public function getOffset()
{
return $this->pageSize < 1 ? 0 : $this->getPage() * $this->pageSize;
13 years ago
}
/**
* @return integer the limit of the data. This may be used to set the
* LIMIT value for a SQL statement for fetching the current page of data.
* Note that if the page size is infinite, a value -1 will be returned.
13 years ago
*/
public function getLimit()
{
return $this->pageSize < 1 ? -1 : $this->pageSize;
13 years ago
}
}