API16:JPagination

This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

The JPagination class supports pagination of lists of items across multiple pages. It can be used in both the front-end and back-end, although there are slight differences in behaviour. The HTML output can be overridden using a template layout override.

Defined in

libraries/joomla/html/pagination.php

Methods

Method name	Description
__construct	Constructor.
setAdditionalUrlParam	Method to set an additional URL parameter to be added to all pagination class generated links.
getAdditionalUrlParam	Method to get an additional URL parameter to be added to all pagination class generated links if it exists.
getRowOffset	Return the rationalised offset for a row with a given index.
getData	Return the pagination data object, only creating it if it doesn't already exist.
getPagesCounter	Create and return the pagination pages counter string, ie. Page 2 of 4.
getResultsCounter	Create and return the pagination result set counter string, ie. Results 1-10 of 42
getPagesLinks	Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
getListFooter	Return the pagination footer.
getLimitBox	Creates a dropdown box for selecting how many records to show per page.
orderUpIcon	Return the icon to move an item UP.
orderDownIcon	Return the icon to move an item DOWN.