TYPO3\CMS\Extbase\Pagination\QueryResultPaginator Class Reference

Inheritance diagram for TYPO3\CMS\Extbase\Pagination\QueryResultPaginator:

Public Member Functions
	__construct (private readonly QueryResultInterface $queryResult, int $currentPageNumber=1, int $itemsPerPage=10)
	getPaginatedItems ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Pagination\AbstractPaginator
	withItemsPerPage (int $itemsPerPage)
	withCurrentPageNumber (int $currentPageNumber)
	getNumberOfPages ()
	getCurrentPageNumber ()
	getKeyOfFirstPaginatedItem ()
	getKeyOfLastPaginatedItem ()

Protected Member Functions
	updatePaginatedItems (int $limit, int $offset)
	getTotalAmountOfItems ()
	getAmountOfItemsOnCurrentPage ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Pagination\AbstractPaginator
	hasItemsOnCurrentPage ()
	updateInternalState ()
	setItemsPerPage (int $itemsPerPage)
	setCurrentPageNumber (int $currentPageNumber)

Private Attributes
QueryResultInterface	$paginatedQueryResult

Additional Inherited Members
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Pagination\AbstractPaginator
int	$numberOfPages = 1
int	$keyOfFirstPaginatedItem = 0
int	$keyOfLastPaginatedItem = 0

Detailed Description

Definition at line 23 of file QueryResultPaginator.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::__construct	(	private readonly QueryResultInterface	$queryResult,
		int	$currentPageNumber = 1,
		int	$itemsPerPage = 10
	)

Definition at line 27 of file QueryResultPaginator.php.

References TYPO3\CMS\Core\Pagination\AbstractPaginator\$currentPageNumber, TYPO3\CMS\Core\Pagination\AbstractPaginator\$itemsPerPage, TYPO3\CMS\Core\Pagination\AbstractPaginator\setCurrentPageNumber(), TYPO3\CMS\Core\Pagination\AbstractPaginator\setItemsPerPage(), and TYPO3\CMS\Core\Pagination\AbstractPaginator\updateInternalState().

Member Function Documentation

getAmountOfItemsOnCurrentPage()

TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::getAmountOfItemsOnCurrentPage ( )

protected

Must return the amount of paginated items on the current page

Reimplemented from TYPO3\CMS\Core\Pagination\AbstractPaginator.

Definition at line 57 of file QueryResultPaginator.php.

getPaginatedItems()

TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::getPaginatedItems

(

)

Returns an iterable, sub set of the original set of items

Implements TYPO3\CMS\Core\Pagination\PaginatorInterface.

Definition at line 38 of file QueryResultPaginator.php.

References TYPO3\CMS\Extbase\Pagination\QueryResultPaginator\$paginatedQueryResult.

getTotalAmountOfItems()

TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::getTotalAmountOfItems ( )

protected

Must return the total amount of all unpaginated items

Reimplemented from TYPO3\CMS\Core\Pagination\AbstractPaginator.

Definition at line 52 of file QueryResultPaginator.php.

updatePaginatedItems()

TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::updatePaginatedItems ( int  $itemsPerPage, int  $offset  )

protected

Must update the paginated items, i.e. the subset of all items, limited and defined by the given amount of items per page and offset

Reimplemented from TYPO3\CMS\Core\Pagination\AbstractPaginator.

Definition at line 43 of file QueryResultPaginator.php.

Member Data Documentation

$paginatedQueryResult

QueryResultInterface TYPO3\CMS\Extbase\Pagination\QueryResultPaginator::$paginatedQueryResult

private

Definition at line 25 of file QueryResultPaginator.php.

Referenced by TYPO3\CMS\Extbase\Pagination\QueryResultPaginator\getPaginatedItems().