Class yii\data\Pagination

Inheritance	yii\data\Pagination » yii\base\Object
Implements	yii\base\Configurable, yii\web\Linkable
Available since version	2.0
Source Code	https://github.com/yiisoft/yii2/blob/master/framework/data/Pagination.php

Pagination represents information relevant to pagination of data items.

When data needs to be rendered in multiple pages, Pagination can be used to represent information such as total item count, page size, current page, etc. These information can be passed to pagers to render pagination buttons or links.

The following example shows how to create a pagination object and feed it to a pager.

Controller action:

public function actionIndex()
{
    $query = Article::find()->where(['status' => 1]);
    $countQuery = clone $query;
    $pages = new Pagination(['totalCount' => $countQuery->count()]);
    $models = $query->offset($pages->offset)
        ->limit($pages->limit)
        ->all();

    return $this->render('index', [
         'models' => $models,
         'pages' => $pages,
    ]);
}

View:

foreach ($models as $model) {
    // display $model here
}

// display pagination
echo LinkPager::widget([
    'pagination' => $pages,
]);

For more details and usage information on Pagination, see the guide article on pagination.

Public Properties

Property	Type	Description	Defined By
$defaultPageSize	integer	The default page size.	yii\data\Pagination
$forcePageParam	boolean	Whether to always have the page parameter in the URL created by createUrl().	yii\data\Pagination
$limit	integer	The limit of the data.	yii\data\Pagination
$links	array	The links for navigational purpose.	yii\data\Pagination
$offset	integer	The offset of the data.	yii\data\Pagination
$page	integer	The zero-based current page number.	yii\data\Pagination
$pageCount	integer	Number of pages	yii\data\Pagination
$pageParam	string	Name of the parameter storing the current page index.	yii\data\Pagination
$pageSize	integer	The number of items per page.	yii\data\Pagination
$pageSizeLimit	array|false	The page size limits.	yii\data\Pagination
$pageSizeParam	string	Name of the parameter storing the page size.	yii\data\Pagination
$params	array	Parameters (name => value) that should be used to obtain the current page number and to create new pagination URLs.	yii\data\Pagination
$route	string	The route of the controller action for displaying the paged contents.	yii\data\Pagination
$totalCount	integer	Total number of items.	yii\data\Pagination
$urlManager	yii\web\UrlManager	The URL manager used for creating pagination URLs.	yii\data\Pagination
$validatePage	boolean	Whether to check if $page is within valid range.	yii\data\Pagination

Public Methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Object
__construct()	Constructor.	yii\base\Object
__get()	Returns the value of an object property.	yii\base\Object
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Object
__set()	Sets value of an object property.	yii\base\Object
__unset()	Sets an object property to null.	yii\base\Object
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Object
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Object
className()	Returns the fully qualified name of this class.	yii\base\Object
createUrl()	Creates the URL suitable for pagination with the specified page number.	yii\data\Pagination
getLimit()		yii\data\Pagination
getLinks()	Returns a whole set of links for navigating to the first, last, next and previous pages.	yii\data\Pagination
getOffset()		yii\data\Pagination
getPage()	Returns the zero-based current page number.	yii\data\Pagination
getPageCount()		yii\data\Pagination
getPageSize()	Returns the number of items per page.	yii\data\Pagination
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Object
hasProperty()	Returns a value indicating whether a property is defined.	yii\base\Object
init()	Initializes the object.	yii\base\Object
setPage()	Sets the current page number.	yii\data\Pagination
setPageSize()		yii\data\Pagination

Protected Methods

Method	Description	Defined By
getQueryParam()	Returns the value of the specified query parameter.	yii\data\Pagination

Constants

Constant	Value	Description	Defined By
LINK_FIRST	'first'		yii\data\Pagination
LINK_LAST	'last'		yii\data\Pagination
LINK_NEXT	'next'		yii\data\Pagination
LINK_PREV	'prev'		yii\data\Pagination

Property Details

$defaultPageSize public property

The default page size. This property will be returned by $pageSize when page size cannot be determined by $pageSizeParam from $params.

public integer $defaultPageSize = 20

$forcePageParam public property

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.

public boolean $forcePageParam = true

$limit public read-only property

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.

public integer getLimit ( )

$links public read-only property

The links for navigational purpose. The array keys specify the purpose of the links (e.g. LINK_FIRST), and the array values are the corresponding URLs.

public array getLinks ( $absolute = false )

$offset public read-only property

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 integer getOffset ( )

$page public property

The zero-based current page number.

public integer getPage ( $recalculate = false )
public void setPage ( $value, $validatePage = false )

$pageCount public read-only property

Number of pages

public integer getPageCount ( )

$pageParam public property

Name of the parameter storing the current page index.

See also $params.

public string $pageParam = 'page'

$pageSize public property

The number of items per page. If it is less than 1, it means the page size is infinite, and thus a single page contains all items.

public integer getPageSize ( )
public void setPageSize ( $value, $validatePageSize = false )

$pageSizeLimit public property

The page size limits. The first array element stands for the minimal page size, and the second the maximal page size. If this is false, it means $pageSize should always return the value of $defaultPageSize.

public array|false $pageSizeLimit = [1, 50]

$pageSizeParam public property

Name of the parameter storing the page size.

See also $params.

public string $pageSizeParam = 'per-page'

$params public property

Parameters (name => value) that should be used to obtain the current page number and to create new pagination URLs. If not set, all parameters from $_GET will be used instead.

In order to add hash to all links use array_merge($_GET, ['#' => 'my-hash']).

The array element indexed by $pageParam is considered to be the current page number (defaults to 0); while the element indexed by $pageSizeParam is treated as the page size (defaults to $defaultPageSize).

public array $params = null

$route public property

The route of the controller action for displaying the paged contents. If not set, it means using the currently requested route.

public string $route = null

$totalCount public property

Total number of items.

public integer $totalCount = 0

$urlManager public property

The URL manager used for creating pagination URLs. If not set, the "urlManager" application component will be used.

public yii\web\UrlManager $urlManager = null

$validatePage public property

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 $totalCount 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 $pageParam in $params.

public boolean $validatePage = true

Method Details