TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator Class Reference

Inheritance diagram for TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator:

Public Member Functions
	__construct (array $items, int $currentPageNumber=1, int $totalAmount=0, 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 $itemsPerPage, int $offset)
	getTotalAmountOfItems ()
	getAmountOfItemsOnCurrentPage ()
‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Pagination\AbstractPaginator
	hasItemsOnCurrentPage ()
	updateInternalState ()
	setItemsPerPage (int $itemsPerPage)
	setCurrentPageNumber (int $currentPageNumber)

Protected Attributes
array	$items = []
int	$totalAmount = 0
‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Pagination\AbstractPaginator
int	$numberOfPages = 1
int	$keyOfFirstPaginatedItem = 0
int	$keyOfLastPaginatedItem = 0

Detailed Description

Stub pagination that contains only an already limited result set ("slice") and not all available results.

Definition at line 27 of file SlicePaginator.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::__construct	(	array	$items,
		int	$currentPageNumber = 1,
		int	$totalAmount = 0,
		int	$itemsPerPage = 10
	)

Definition at line 32 of file SlicePaginator.php.

References TYPO3\CMS\Core\Pagination\AbstractPaginator\$currentPageNumber, TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\$items, TYPO3\CMS\Core\Pagination\AbstractPaginator\$itemsPerPage, TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\$totalAmount, 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\IndexedSearch\Pagination\SlicePaginator::getAmountOfItemsOnCurrentPage ( )

protected

Must return the amount of paginated items on the current page

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

Definition at line 56 of file SlicePaginator.php.

getPaginatedItems()

TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::getPaginatedItems

(

)

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

Implements TYPO3\CMS\Core\Pagination\PaginatorInterface.

Definition at line 61 of file SlicePaginator.php.

References TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\$items.

getTotalAmountOfItems()

TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::getTotalAmountOfItems ( )

protected

Must return the total amount of all unpaginated items

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

Definition at line 51 of file SlicePaginator.php.

References TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\$totalAmount.

updatePaginatedItems()

TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::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 46 of file SlicePaginator.php.

Member Data Documentation

$items

array TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::$items = []

protected

Definition at line 29 of file SlicePaginator.php.

Referenced by TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\__construct(), and TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\getPaginatedItems().

$totalAmount

int TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator::$totalAmount = 0

protected

Definition at line 30 of file SlicePaginator.php.

Referenced by TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\__construct(), and TYPO3\CMS\IndexedSearch\Pagination\SlicePaginator\getTotalAmountOfItems().