Класс PageNavigation

Граф наследования:PageNavigation:

Открытые члены
	__construct (string $id)
	initFromUri ()
	getPageCount ()
	setPageSize ($n)
	setCurrentPage ($n)
	getCurrentPage ()
	allowAllRecords ($mode)
	setRecordCount ($n)
	getRecordCount ()
	setPageSizes (array $sizes)
	getPageSizes ()
	getPageSize ()
	getId ()
	getOffset ()
	getLimit ()
	allRecordsShown ()
	allRecordsAllowed ()
	addParams (Web\Uri $uri, $sef, $page, $size=null)
	clearParams (Web\Uri $uri, $sef)

Защищенные данные
	$id
	$pageSizes = array()
	$pageSize = 20
	$recordCount
	$currentPage
	$allowAll = false
	$allRecords = false

Подробное описание

Class PageNavigation

This class helps to calculate limits for DB queries and other data sources to organize page navigation through results.

Examples of supported URLs: /page.php?nav-cars=page-5&nav-books=page-2&other=params /page.php?nav-cars=page-5-size-20&nav-books=page-2 /page.php?nav-cars=page-all&nav-books=page-2 /page/nav-cars/page-2/size-20/something/ /page/nav-cars/page-all/something/?other=params /page/nav-cars/page-5/nav-books/page-2/size-10

См. определение в файле pagenavigation.php строка 26

Конструктор(ы)

__construct()

__construct

(

string

$id

)

Аргументы

string

$id

Navigation identity like "nav-cars".

См. определение в файле pagenavigation.php строка 39

Методы

addParams()

addParams	(	Web\Uri	$uri,
			$sef,
			$page,
			$size = null )

Returns an URI with navigation parameters compatible with initFromUri().

Аргументы

Web\Uri	$uri
bool	$sef	SEF mode.
string	$page	Page number.
string	$size	Page size.

Возвращает

Web\Uri

См. определение в файле pagenavigation.php строка 287

allowAllRecords()

allowAllRecords

(

$mode

)

Аргументы

bool

$mode

Allows to show all records, yes or no.

Возвращает

$this

См. определение в файле pagenavigation.php строка 172

allRecordsAllowed()

allRecordsAllowed

(

)

Returns true if showing all records is allowed.

Возвращает

bool

См. определение в файле pagenavigation.php строка 274

allRecordsShown()

allRecordsShown

(

)

Returns true if all the records are shown in one page.

Возвращает

bool

См. определение в файле pagenavigation.php строка 265

clearParams()

clearParams	(	Web\Uri	$uri,
			$sef )

Clears an URI from navigation parameters and returns it.

Аргументы

Web\Uri	$uri
bool	$sef	SEF mode.

Возвращает

Web\Uri

См. определение в файле pagenavigation.php строка 311

getCurrentPage()

getCurrentPage

(

)

Returns the current page number.

Возвращает

int

Переопределяется в ReversePageNavigation.

См. определение в файле pagenavigation.php строка 159

getId()

getId

(

)

Returns navigation ID.

Возвращает

string

См. определение в файле pagenavigation.php строка 230

getLimit()

getLimit

(

)

Returns the number of records in the current page.

Возвращает

int

Переопределяется в ReversePageNavigation.

См. определение в файле pagenavigation.php строка 252

getOffset()

getOffset

(

)

Returns offset of the first record of the current page.

Возвращает

int

Переопределяется в ReversePageNavigation.

См. определение в файле pagenavigation.php строка 239

getPageCount()

getPageCount

(

)

Returns number of pages or 0 if recordCount is not set.

Возвращает

int

Переопределяется в ReversePageNavigation.

См. определение в файле pagenavigation.php строка 121

getPageSize()

getPageSize

(

)

Returns "formal" page size.

Возвращает

int

См. определение в файле pagenavigation.php строка 221

getPageSizes()

getPageSizes

(

)

Returns allowed page sizes.

Возвращает

array

См. определение в файле pagenavigation.php строка 212

getRecordCount()

getRecordCount

(

)

Returns number of records.

Возвращает

int|null

См. определение в файле pagenavigation.php строка 192

initFromUri()

initFromUri

(

)

Initializes the navigation from URI.

Возвращает

void

Переопределяется в PageNavigation.

См. определение в файле pagenavigation.php строка 49

setCurrentPage()

setCurrentPage

(

$n

)

Аргументы

int

$n

The current page number.

Возвращает

$this

См. определение в файле pagenavigation.php строка 149

setPageSize()

setPageSize

(

$n

)

Аргументы

int

$n

Page size.

Возвращает

$this

См. определение в файле pagenavigation.php строка 139

setPageSizes()

setPageSizes

(

array

$sizes

)

This controls which sizes are available via user interface.

Аргументы

array

$sizes

Array of integers.

Возвращает

$this

См. определение в файле pagenavigation.php строка 202

setRecordCount()

setRecordCount

(

$n

)

Аргументы

int

$n

Number of records (to calculate number of pages).

Возвращает

$this

См. определение в файле pagenavigation.php строка 182

Поля

$allowAll

$allowAll = false

protected

См. определение в файле pagenavigation.php строка 33

$allRecords

$allRecords = false

protected

См. определение в файле pagenavigation.php строка 34

$currentPage

$currentPage

protected

См. определение в файле pagenavigation.php строка 32

$id

$id

protected

См. определение в файле pagenavigation.php строка 28

$pageSize

$pageSize = 20

protected

См. определение в файле pagenavigation.php строка 30

$pageSizes

$pageSizes = array()

protected

См. определение в файле pagenavigation.php строка 29

$recordCount

$recordCount

protected

См. определение в файле pagenavigation.php строка 31

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/ui/pagenavigation.php