Pagination.php 6.86 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;
12
use yii\web\Request;
Qiang Xue committed
13

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


	/**
	 * @return integer number of pages
	 */
	public function getPageCount()
	{
Qiang Xue committed
122
		if ($this->pageSize < 1) {
Qiang Xue committed
123
			return $this->totalCount > 0 ? 1 : 0;
Qiang Xue committed
124
		} else {
Qiang Xue committed
125 126
			$totalCount = $this->totalCount < 0 ? 0 : (int)$this->totalCount;
			return (int)(($totalCount + $this->pageSize - 1) / $this->pageSize);
Qiang Xue committed
127
		}
Qiang Xue committed
128 129
	}

Qiang Xue committed
130 131
	private $_page;

Qiang Xue committed
132
	/**
Qiang Xue committed
133
	 * Returns the zero-based current page number.
Qiang Xue committed
134
	 * @param boolean $recalculate whether to recalculate the current page based on the page size and item count.
Qiang Xue committed
135
	 * @return integer the zero-based current page number.
Qiang Xue committed
136
	 */
Qiang Xue committed
137
	public function getPage($recalculate = false)
Qiang Xue committed
138
	{
Qiang Xue committed
139
		if ($this->_page === null || $recalculate) {
140
			if (($params = $this->params) === null) {
Qiang Xue committed
141 142
				$request = Yii::$app->getRequest();
				$params = $request instanceof Request ? $request->get() : [];
143
			}
Qiang Xue committed
144
			if (isset($params[$this->pageVar]) && is_scalar($params[$this->pageVar])) {
Qiang Xue committed
145 146
				$this->_page = (int)$params[$this->pageVar] - 1;
				if ($this->validatePage) {
Qiang Xue committed
147
					$pageCount = $this->getPageCount();
Qiang Xue committed
148 149
					if ($this->_page >= $pageCount) {
						$this->_page = $pageCount - 1;
Qiang Xue committed
150
					}
Qiang Xue committed
151
				}
Qiang Xue committed
152 153
				if ($this->_page < 0) {
					$this->_page = 0;
Qiang Xue committed
154 155
				}
			} else {
Qiang Xue committed
156
				$this->_page = 0;
Qiang Xue committed
157 158
			}
		}
Qiang Xue committed
159
		return $this->_page;
Qiang Xue committed
160 161 162
	}

	/**
Qiang Xue committed
163
	 * Sets the current page number.
Qiang Xue committed
164 165
	 * @param integer $value the zero-based index of the current page.
	 */
Qiang Xue committed
166
	public function setPage($value)
Qiang Xue committed
167
	{
Qiang Xue committed
168
		$this->_page = $value;
Qiang Xue committed
169 170 171
	}

	/**
Qiang Xue committed
172 173 174
	 * 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.
175
	 * @param boolean $absolute whether to create an absolute URL. Defaults to `false`.
Qiang Xue committed
176
	 * @return string the created URL
Qiang Xue committed
177 178
	 * @see params
	 * @see forcePageVar
Qiang Xue committed
179
	 */
180
	public function createUrl($page, $absolute = false)
Qiang Xue committed
181
	{
182
		if (($params = $this->params) === null) {
Qiang Xue committed
183 184
			$request = Yii::$app->getRequest();
			$params = $request instanceof Request ? $request->get() : [];
185
		}
Qiang Xue committed
186
		if ($page > 0 || $page >= 0 && $this->forcePageVar) {
Qiang Xue committed
187 188
			$params[$this->pageVar] = $page + 1;
		} else {
Qiang Xue committed
189
			unset($params[$this->pageVar]);
Qiang Xue committed
190
		}
191
		$route = $this->route === null ? Yii::$app->controller->getRoute() : $this->route;
192 193 194 195 196 197
		$urlManager = $this->urlManager === null ? Yii::$app->getUrlManager() : $this->urlManager;
		if ($absolute) {
			return $urlManager->createAbsoluteUrl($route, $params);
		} else {
			return $urlManager->createUrl($route, $params);
		}
Qiang Xue committed
198 199 200 201 202 203 204 205
	}

	/**
	 * @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
206
		return $this->pageSize < 1 ? 0 : $this->getPage() * $this->pageSize;
Qiang Xue committed
207 208 209 210 211
	}

	/**
	 * @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
212
	 * Note that if the page size is infinite, a value -1 will be returned.
Qiang Xue committed
213 214 215
	 */
	public function getLimit()
	{
Qiang Xue committed
216
		return $this->pageSize < 1 ? -1 : $this->pageSize;
Qiang Xue committed
217
	}
Zander Baldwin committed
218
}