Pagination.php 6.18 KB
Newer Older
Qiang Xue committed
1 2 3
<?php
/**
 * @link http://www.yiiframework.com/
Qiang Xue committed
4
 * @copyright Copyright (c) 2008 Yii Software LLC
Qiang Xue committed
5 6 7
 * @license http://www.yiiframework.com/license/
 */

8
namespace yii\data;
Qiang Xue committed
9

Qiang Xue committed
10
use Yii;
11
use yii\base\Object;
Qiang Xue committed
12

Qiang Xue committed
13
/**
Qiang Xue committed
14
 * Pagination represents information relevant to pagination of data items.
Qiang Xue committed
15
 *
Qiang Xue committed
16
 * When data needs to be rendered in multiple pages, Pagination can be used to
Qiang Xue committed
17
 * represent information such as [[totalCount|total item count]], [[pageSize|page size]],
Qiang Xue committed
18
 * [[page|current page]], etc. These information can be passed to [[yii\widgets\Pager|pagers]]
Qiang Xue committed
19
 * to render pagination buttons or links.
Qiang Xue committed
20
 *
Qiang Xue committed
21 22
 * The following example shows how to create a pagination object and feed it
 * to a pager.
Qiang Xue committed
23 24
 *
 * Controller action:
Qiang Xue committed
25 26 27 28
 *
 * ~~~
 * function actionIndex()
 * {
Alexander Makarov committed
29
 *     $query = Article::find()->where(['status' => 1]);
Qiang Xue committed
30
 *     $countQuery = clone $query;
Alexander Makarov committed
31
 *     $pages = new Pagination(['totalCount' => $countQuery->count()]);
Qiang Xue committed
32 33 34
 *     $models = $query->offset($pages->offset)
 *         ->limit($pages->limit)
 *         ->all();
Qiang Xue committed
35
 *
Alexander Makarov committed
36
 *     return $this->render('index', [
Qiang Xue committed
37
 *          'models' => $models,
Qiang Xue committed
38
 *          'pages' => $pages,
Alexander Makarov committed
39
 *     ]);
Qiang Xue committed
40
 * }
Qiang Xue committed
41
 * ~~~
Qiang Xue committed
42 43
 *
 * View:
Qiang Xue committed
44 45
 *
 * ~~~
resurtm committed
46
 * foreach ($models as $model) {
Qiang Xue committed
47 48
 *     // display $model here
 * }
Qiang Xue committed
49 50
 *
 * // display pagination
Alexander Makarov committed
51
 * echo LinkPager::widget([
gsd committed
52
 *     'pagination' => $pages,
Alexander Makarov committed
53
 * ]);
Qiang Xue committed
54
 * ~~~
Qiang Xue committed
55
 *
56 57 58 59 60
 * @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. Note that if the page size is infinite, a value -1 will be returned.
 * This property is read-only.
 * @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. This property is read-only.
61
 * @property integer $page The zero-based current page number.
62
 * @property integer $pageCount Number of pages. This property is read-only.
Qiang Xue committed
63 64
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
Qiang Xue committed
65
 * @since 2.0
Qiang Xue committed
66
 */
67
class Pagination extends Object
Qiang Xue committed
68 69
{
	/**
Qiang Xue committed
70 71
	 * @var string name of the parameter storing the current page index. Defaults to 'page'.
	 * @see params
Qiang Xue committed
72
	 */
Qiang Xue committed
73
	public $pageVar = 'page';
Qiang Xue committed
74
	/**
Qiang Xue committed
75 76
	 * @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.
Qiang Xue committed
77
	 */
78
	public $forcePageVar = true;
Qiang Xue committed
79
	/**
Qiang Xue committed
80
	 * @var string the route of the controller action for displaying the paged contents.
Qiang Xue committed
81
	 * If not set, it means using the currently requested route.
Qiang Xue committed
82
	 */
Qiang Xue committed
83
	public $route;
Qiang Xue committed
84
	/**
resurtm committed
85
	 * @var array parameters (name => value) that should be used to obtain the current page number
Qiang Xue committed
86
	 * and to create new pagination URLs. If not set, $_GET will be used instead.
Qiang Xue committed
87
	 *
Qiang Xue committed
88 89
	 * 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.
Qiang Xue committed
90
	 */
Qiang Xue committed
91
	public $params;
Qiang Xue committed
92
	/**
Qiang Xue committed
93 94
	 * @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).
Qiang Xue committed
95
	 * Because [[pageCount]] relies on the correct value of [[totalCount]] which may not be available
Qiang Xue committed
96 97
	 * 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]].
Qiang Xue committed
98
	 */
Qiang Xue committed
99
	public $validatePage = true;
Qiang Xue committed
100
	/**
101
	 * @var integer number of items on each page. Defaults to 20.
Qiang Xue committed
102
	 * If it is less than 1, it means the page size is infinite, and thus a single page contains all items.
Qiang Xue committed
103
	 */
104
	public $pageSize = 20;
Qiang Xue committed
105
	/**
Qiang Xue committed
106
	 * @var integer total number of items.
Qiang Xue committed
107
	 */
Qiang Xue committed
108
	public $totalCount = 0;
Qiang Xue committed
109 110 111 112 113 114 115


	/**
	 * @return integer number of pages
	 */
	public function getPageCount()
	{
Qiang Xue committed
116
		if ($this->pageSize < 1) {
Qiang Xue committed
117
			return $this->totalCount > 0 ? 1 : 0;
Qiang Xue committed
118
		} else {
Qiang Xue committed
119 120
			$totalCount = $this->totalCount < 0 ? 0 : (int)$this->totalCount;
			return (int)(($totalCount + $this->pageSize - 1) / $this->pageSize);
Qiang Xue committed
121
		}
Qiang Xue committed
122 123
	}

Qiang Xue committed
124 125
	private $_page;

Qiang Xue committed
126
	/**
Qiang Xue committed
127
	 * Returns the zero-based current page number.
Qiang Xue committed
128
	 * @param boolean $recalculate whether to recalculate the current page based on the page size and item count.
Qiang Xue committed
129
	 * @return integer the zero-based current page number.
Qiang Xue committed
130
	 */
Qiang Xue committed
131
	public function getPage($recalculate = false)
Qiang Xue committed
132
	{
Qiang Xue committed
133 134
		if ($this->_page === null || $recalculate) {
			$params = $this->params === null ? $_GET : $this->params;
Qiang Xue committed
135
			if (isset($params[$this->pageVar]) && is_scalar($params[$this->pageVar])) {
Qiang Xue committed
136 137
				$this->_page = (int)$params[$this->pageVar] - 1;
				if ($this->validatePage) {
Qiang Xue committed
138
					$pageCount = $this->getPageCount();
Qiang Xue committed
139 140
					if ($this->_page >= $pageCount) {
						$this->_page = $pageCount - 1;
Qiang Xue committed
141
					}
Qiang Xue committed
142
				}
Qiang Xue committed
143 144
				if ($this->_page < 0) {
					$this->_page = 0;
Qiang Xue committed
145 146
				}
			} else {
Qiang Xue committed
147
				$this->_page = 0;
Qiang Xue committed
148 149
			}
		}
Qiang Xue committed
150
		return $this->_page;
Qiang Xue committed
151 152 153
	}

	/**
Qiang Xue committed
154
	 * Sets the current page number.
Qiang Xue committed
155 156
	 * @param integer $value the zero-based index of the current page.
	 */
Qiang Xue committed
157
	public function setPage($value)
Qiang Xue committed
158
	{
Qiang Xue committed
159
		$this->_page = $value;
Qiang Xue committed
160 161 162
	}

	/**
Qiang Xue committed
163 164 165
	 * 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.
Qiang Xue committed
166
	 * @return string the created URL
Qiang Xue committed
167 168
	 * @see params
	 * @see forcePageVar
Qiang Xue committed
169
	 */
Qiang Xue committed
170
	public function createUrl($page)
Qiang Xue committed
171
	{
Qiang Xue committed
172
		$params = $this->params === null ? $_GET : $this->params;
Qiang Xue committed
173
		if ($page > 0 || $page >= 0 && $this->forcePageVar) {
Qiang Xue committed
174 175
			$params[$this->pageVar] = $page + 1;
		} else {
Qiang Xue committed
176
			unset($params[$this->pageVar]);
Qiang Xue committed
177
		}
Qiang Xue committed
178 179
		$route = $this->route === null ? Yii::$app->controller->route : $this->route;
		return Yii::$app->getUrlManager()->createUrl($route, $params);
Qiang Xue committed
180 181 182 183 184 185 186 187
	}

	/**
	 * @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()
	{
Qiang Xue committed
188
		return $this->pageSize < 1 ? 0 : $this->getPage() * $this->pageSize;
Qiang Xue committed
189 190 191 192 193
	}

	/**
	 * @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.
Qiang Xue committed
194
	 * Note that if the page size is infinite, a value -1 will be returned.
Qiang Xue committed
195 196 197
	 */
	public function getLimit()
	{
Qiang Xue committed
198
		return $this->pageSize < 1 ? -1 : $this->pageSize;
Qiang Xue committed
199
	}
Zander Baldwin committed
200
}