\JPagination
Pagination Class. Provides a common interface for content pagination for the Joomla! CMS.
Synopsis
class JPagination
{
- // members
- public $limitstart;
- public $limit;
- public $total;
- public $prefix;
- public $pagesStart;
- public $pagesStop;
- public $pagesCurrent;
- public $pagesTotal;
- protected $viewall;
- protected $additionalUrlParams;
- // methods
- public void __construct()
- public mixed setAdditionalUrlParam()
- public mixed getAdditionalUrlParam()
- public integer getRowOffset()
- public getData()
- public string getPagesCounter()
- public string getResultsCounter()
- public string getPagesLinks()
- public string getListFooter()
- public string getLimitBox()
- public string orderUpIcon()
- public string orderDownIcon()
- protected string _list_footer()
- protected string _list_render()
- protected string _item_active()
- protected string _item_inactive()
- protected _buildDataObject()
- public void set()
- public mixed get()
Tasks
Tasks
| Line | Task |
|---|---|
| 705 | remove code: $page = $page == 0 ? '' : $page; |
Members
protected
- $additionalUrlParams
—
array
Additional URL parameters to be added to the pagination URLs generated by the class. These may be useful for filters and extra values when dealing with lists and GET requests. - $viewall — boolean
public
- $limit — integer
- $limitstart — integer
- $pagesCurrent — integer
- $pagesStart — integer
- $pagesStop — integer
- $pagesTotal — integer
- $prefix — integer
- $total — integer
Methods
protected
- _buildDataObject() — Create and return the pagination data object.
- _item_active() — Method to create an active pagination link to the item
- _item_inactive() — Method to create an inactive pagination string
- _list_render() — Create the html for a list footer
public
- __construct() — Constructor.
- get() — Returns a property of the object or the default value if the property is not set.
- getAdditionalUrlParam() — Method to get an additional URL parameter (if it exists) to be added to all pagination class generated links.
- getData() — Return the pagination data object, only creating it if it doesn't already exist.
- getLimitBox() — Creates a dropdown box for selecting how many records to show per page.
- getPagesCounter() — Create and return the pagination pages counter string, ie. Page 2 of 4.
- getPagesLinks() — Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x.
- getResultsCounter() — Create and return the pagination result set counter string, e.g. Results 1-10 of 42
- getRowOffset() — Return the rationalised offset for a row with a given index.
- orderDownIcon() — Return the icon to move an item DOWN.
- orderUpIcon() — Return the icon to move an item UP.
- set() — Modifies a property of the object, creating it if it does not already exist.
- setAdditionalUrlParam() — Method to set an additional URL parameter to be added to all pagination class generated links.