data\Pagination getPageSize()

getPageSize() public method Returns the number of items per page. By default, this method will try to determine the page size by $pageSizeParam in $params. If the page size cannot be determined this way, $defaultPageSize will be returned. See also $pageSizeLimit. public integer getPageSize ( )return integer 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.

data\Pagination getPageCount()

getPageCount() public method public integer getPageCount ( )return integer Number of pages

data\Pagination getPage()

getPage() public method Returns the zero-based current page number. public integer getPage ( $recalculate = false )$recalculate boolean Whether to recalculate the current page based on the page size and item count. return integer The zero-based current page number.

data\Pagination getOffset()

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

data\Pagination getLinks()

getLinks() public method Returns a whole set of links for navigating to the first, last, next and previous pages. public array getLinks ( $absolute = false )$absolute boolean Whether the generated URLs should be absolute. return array 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.

data\Pagination getLimit()

getLimit() public method public integer getLimit ( )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.

data\Pagination createUrl()

createUrl() public method 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. See also: $params $forcePageParam public string createUrl ( $page, $pageSize = null, $absolute = false )$page integer The zero-based page number that the URL should point to. $pageSize integer The number of items on each page. If not set, the value of $pageSize will be used. $absolute boolean Whether to

data\Pagination $validatePage

$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

data\Pagination $urlManager

$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

data\Pagination $totalCount

$totalCount public property Total number of items. public integer $totalCount = 0