Class rex_pager

The rex_pager-class implements all the logic which is necessary to implement some sort of pagination.

Package: redaxo\core
Author: staabm
Located at redaxo/src/core/lib/util/pager.php

Methods summary

`public`	# `__construct( integer $rowsPerPage = 30, string $cursorName = 'start' )` Constructs a rex_pager. Constructs a rex_pager. Parameters `$rowsPerPage` The number of rows which should be displayed on one page `$cursorName` The name of the parameter used for pagination
`public`	# `setRowCount( integer $rowCount )` Sets the row count. Sets the row count. Parameters `$rowCount`
`public integer`	# `getRowCount( )` Returns the number of rows for pagination. Returns the number of rows for pagination. Returns `integer` The number of rows
`public integer`	# `getPageCount( )` Returns the number of pages which result from the given number of rows and the rows per page. Returns the number of pages which result from the given number of rows and the rows per page. Returns `integer` The number of pages
`public integer`	# `getRowsPerPage( )` Returns the number of rows which will be displayed on a page. Returns the number of rows which will be displayed on a page. Returns `integer` The rows displayed on a page
`public integer`	# `getCursor( integer $pageNo = null )` Returns the current pagination position. Returns the current pagination position. When the parameter pageNo is given, the cursor for the given page is returned. When no parameter is given, the cursor for active page is returned. Parameters `$pageNo` Returns `integer` int
`public integer`	# `validateCursor( integer $cursor )` Validates the cursor. Validates the cursor. Parameters `$cursor` Returns `integer` int
`public string`	# `getCursorName( )` Returns the name of the parameter which is used for pagination. Returns the name of the parameter which is used for pagination. Returns `string` The name of the cursor
`public integer`	# `getFirstPage( )` Returns the first page for pagination. Returns the first page for pagination. Returns `integer` The first page number
`public integer`	# `getPrevPage( )` Returns the previous page in respect to the current page. Returns the previous page in respect to the current page. Returns `integer` The previous page number
`public integer`	# `getCurrentPage( )` Returns the number of the current page. Returns the number of the current page. Returns `integer` The current page number
`public integer`	# `getNextPage( )` Returns the number of the next page in respect to the current page. Returns the number of the next page in respect to the current page. Returns `integer` The next page number
`public integer`	# `getLastPage( )` Return the page number of the last page. Return the page number of the last page. Returns `integer` the last page number
`public boolean`	# `isActivePage( integer $pageNo )` Checks wheter the given page number is the active/current page. Checks wheter the given page number is the active/current page. Parameters `$pageNo` Returns `boolean` True when the given pageNo is the current page, otherwise False