TYPO3\CMS\Core\Pagination\SlidingWindowPagination Class Reference

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

Public Member Functions
	__construct (PaginatorInterface $paginator, int $maximumNumberOfLinks=0)
	getPreviousPageNumber ()
	getNextPageNumber ()
	getFirstPageNumber ()
	getLastPageNumber ()
	getStartRecordNumber ()
	getEndRecordNumber ()
	getAllPageNumbers ()
	getDisplayRangeStart ()
	getDisplayRangeEnd ()
	getHasLessPages ()
	getHasMorePages ()
	getMaximumNumberOfLinks ()
	getPaginator ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Pagination\PaginationInterface
	__construct (PaginatorInterface $paginator)

Protected Member Functions
	calculateDisplayRange ()

Protected Attributes
int	$displayRangeStart = 0
int	$displayRangeEnd = 0
bool	$hasLessPages = false
bool	$hasMorePages = false
int	$maximumNumberOfLinks = 0
PaginatorInterface	$paginator

Detailed Description

Definition at line 20 of file SlidingWindowPagination.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::__construct	(	PaginatorInterface	$paginator,
		int	$maximumNumberOfLinks = 0
	)

Definition at line 29 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$maximumNumberOfLinks, TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$paginator, and TYPO3\CMS\Core\Pagination\SlidingWindowPagination\calculateDisplayRange().

Member Function Documentation

calculateDisplayRange()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::calculateDisplayRange ( )

protected

Definition at line 121 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$maximumNumberOfLinks.

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

getAllPageNumbers()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getAllPageNumbers

(

)

Must return a list of all page numbers.

Returns

‪int[]

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 86 of file SlidingWindowPagination.php.

getDisplayRangeEnd()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getDisplayRangeEnd

(

)

Definition at line 96 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$displayRangeEnd.

getDisplayRangeStart()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getDisplayRangeStart

(

)

Definition at line 91 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$displayRangeStart.

getEndRecordNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::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 77 of file SlidingWindowPagination.php.

getFirstPageNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getFirstPageNumber

(

)

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

Implements TYPO3\CMS\Core\Pagination\PaginationInterface.

Definition at line 58 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getPreviousPageNumber().

getHasLessPages()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getHasLessPages

(

)

Definition at line 101 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$hasLessPages.

getHasMorePages()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getHasMorePages

(

)

Definition at line 106 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$hasMorePages.

getLastPageNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::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 63 of file SlidingWindowPagination.php.

getMaximumNumberOfLinks()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getMaximumNumberOfLinks

(

)

Definition at line 111 of file SlidingWindowPagination.php.

References TYPO3\CMS\Core\Pagination\SlidingWindowPagination\$maximumNumberOfLinks.

getNextPageNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::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 51 of file SlidingWindowPagination.php.

getPaginator()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::getPaginator

(

)

Definition at line 116 of file SlidingWindowPagination.php.

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

getPreviousPageNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::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 40 of file SlidingWindowPagination.php.

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

getStartRecordNumber()

TYPO3\CMS\Core\Pagination\SlidingWindowPagination::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 68 of file SlidingWindowPagination.php.

Member Data Documentation

$displayRangeEnd

int TYPO3\CMS\Core\Pagination\SlidingWindowPagination::$displayRangeEnd = 0

protected

Definition at line 23 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getDisplayRangeEnd().

$displayRangeStart

int TYPO3\CMS\Core\Pagination\SlidingWindowPagination::$displayRangeStart = 0

protected

Definition at line 22 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getDisplayRangeStart().

$hasLessPages

bool TYPO3\CMS\Core\Pagination\SlidingWindowPagination::$hasLessPages = false

protected

Definition at line 24 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getHasLessPages().

$hasMorePages

bool TYPO3\CMS\Core\Pagination\SlidingWindowPagination::$hasMorePages = false

protected

Definition at line 25 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getHasMorePages().

$maximumNumberOfLinks

int TYPO3\CMS\Core\Pagination\SlidingWindowPagination::$maximumNumberOfLinks = 0

protected

Definition at line 26 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\__construct(), TYPO3\CMS\Core\Pagination\SlidingWindowPagination\calculateDisplayRange(), and TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getMaximumNumberOfLinks().

$paginator

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

protected

Definition at line 27 of file SlidingWindowPagination.php.

Referenced by TYPO3\CMS\Core\Pagination\SlidingWindowPagination\__construct(), and TYPO3\CMS\Core\Pagination\SlidingWindowPagination\getPaginator().