TYPO3\CMS\Core\Pagination\SimplePagination Class Reference

Inheritance diagram for TYPO3\CMS\Core\Pagination\SimplePagination:

Public Member Functions
	__construct (PaginatorInterface $paginator)
	getPreviousPageNumber ()
	getNextPageNumber ()
	getFirstPageNumber ()
	getLastPageNumber ()
	getStartRecordNumber ()
	getEndRecordNumber ()
int[]	getAllPageNumbers ()

Protected Attributes
PaginatorInterface	$paginator

Detailed Description

Definition at line 20 of file SimplePagination.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Pagination\SimplePagination::__construct

(

PaginatorInterface

$paginator

)

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 26 of file SimplePagination.php.

References TYPO3\CMS\Core\Pagination\SimplePagination\$paginator.

Member Function Documentation

getAllPageNumbers()

int [] TYPO3\CMS\Core\Pagination\SimplePagination::getAllPageNumbers

(

)

Returns

‪int[]

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 86 of file SimplePagination.php.

References TYPO3\CMS\Core\Pagination\SimplePagination\getFirstPageNumber(), and TYPO3\CMS\Core\Pagination\SimplePagination\getLastPageNumber().

getEndRecordNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getEndRecordNumber

(

)

Must return the human-readable index of the last paginated item

Example: given a set of 10 total items, 5 items per page and the current page being 2, the end record number is 10.

Page 1: Records 1-5 Page 2: Records 6-10

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 74 of file SimplePagination.php.

getFirstPageNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getFirstPageNumber

(

)

Must return the first page number, usually this will return 1

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 55 of file SimplePagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SimplePagination\getAllPageNumbers(), and TYPO3\CMS\Core\Pagination\SimplePagination\getPreviousPageNumber().

getLastPageNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getLastPageNumber

(

)

Must return the last page number, usually this will return the total amount of pages

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 60 of file SimplePagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SimplePagination\getAllPageNumbers().

getNextPageNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getNextPageNumber

(

)

Must return the next page number

Is allowed to return null to indicate that there is no next page, e.g. when being on the last page

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 45 of file SimplePagination.php.

getPreviousPageNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getPreviousPageNumber

(

)

Must return the previous page number

Is allowed to return null to indicate that there is no previous page, e.g. when being on the first page

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 31 of file SimplePagination.php.

References TYPO3\CMS\Core\Pagination\SimplePagination\getFirstPageNumber().

getStartRecordNumber()

TYPO3\CMS\Core\Pagination\SimplePagination::getStartRecordNumber

(

)

Must return the human-readable index of the first paginated item

Example: given a set of 10 total items, 5 items per page and the current page being 2, the start record number is 6:

Page 1: Records 1-5 Page 2: Records 6-10

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 65 of file SimplePagination.php.

Member Data Documentation

$paginator

PaginatorInterface TYPO3\CMS\Core\Pagination\SimplePagination::$paginator

protected

Definition at line 24 of file SimplePagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SimplePagination\__construct().