Support Joomla!

Packages

Package: Joomla-Framework

License

Content on this site is copyright © 2005 - 2008 Open Source Matters Inc and can be used in accordance with the Joomla! Electronic Documentation License. Some parts of this website may be subject to other licenses.

Class JPagination

Description
Description | Variables (details) | Methods (details)

Pagination Class. Provides a common interface for content pagination for the Joomla! Framework

  • since: 1.5

Located in /joomla/html/pagination.php (line 26) 

Class JObject   (Subpackage Base)

Class JPagination   (Subpackage HTML)
Variable Summary
Description | Variables (details) | Methods (details)
Variable int $limit
Variable int $limitstart
Variable int $total
Variable boolean $_viewall
Method Summary
Description | Variables (details) | Methods (details)
Constructor JPagination __construct (int $total, int $limitstart, int $limit)
Method object Pagination getData ()
Method string getLimitBox ()
Method string getListFooter ()
Method string getPagesCounter ()
Method string getPagesLinks ()
Method string getResultsCounter ()
Method int getRowOffset (int $index)
Method string orderDownIcon (int $i, int $n, [boolean $condition = true], [string $task = 'orderdown'], [string $alt = 'Move Down'], [ $enabled = true])
Method string orderUpIcon (int $i, [boolean $condition = true], [string $task = 'orderup'], [string $alt = 'Move Up'], [ $enabled = true])
Method object Pagination _buildDataObject ()
Method void _item_active ( &$item)
Method void _item_inactive ( &$item)
Method void _list_footer ( $list)
Method void _list_render ( $list)
Variables
Description | Variables (details) | Methods (details)
int $limit = null (line 42)

Number of rows to display per page

  • access: public
int $limitstart = null (line 34)

The record number to start dislpaying from

  • access: public
int $total = null (line 50)

Total number of rows

  • access: public
boolean $_viewall = false (line 58)

View all flag

  • access: protected

Inherited Variables

Inherited from JObject

Variable JObject::$_errors
Methods
Description | Variables (details) Methods (details)
Constructor __construct (line 67)

Constructor

JPagination __construct (int $total, int $limitstart, int $limit)
  • int $total: The total number of items
  • int $limitstart: The offset of the item to start at
  • int $limit: The number of items to display per page
Redefinition of:
JObject::__construct()
Class constructor, overridden in descendant classes.
getData (line 130)

Return the pagination data object, only creating it if it doesn't already exist

  • return: data object
  • since: 1.5
  • access: public
object Pagination getData ()
getLimitBox (line 316)

Creates a dropdown box for selecting how many records to show per page

  • return: The html for the limit # input box
  • since: 1.0
  • access: public
string getLimitBox ()
getListFooter (line 286)

Return the pagination footer

  • return: Pagination footer
  • since: 1.0
  • access: public
string getListFooter ()
getPagesCounter (line 146)

Create and return the pagination pages counter string, ie. Page 2 of 4

  • return: Pagination pages counter string
  • since: 1.5
  • access: public
string getPagesCounter ()
getPagesLinks (line 194)

Create and return the pagination page list string, ie. Previous, Next, 1 2 3 ... x

  • return: Pagination page list string
  • since: 1.0
  • access: public
string getPagesLinks ()
getResultsCounter (line 163)

Create and return the pagination result set counter string, ie. Results 1-10 of 42

  • return: Pagination result set counter string
  • since: 1.5
  • access: public
string getResultsCounter ()
getRowOffset (line 118)

Return the rationalised offset for a row with a given index.

  • return: Rationalised offset for a row with a given index
  • since: 1.5
  • access: public
int getRowOffset (int $index)
  • int $index: The row index
orderDownIcon (line 384)

Return the icon to move an item DOWN

  • return: Either the icon to move an item down or a space
  • since: 1.0
  • access: public
string orderDownIcon (int $i, int $n, [boolean $condition = true], [string $task = 'orderdown'], [string $alt = 'Move Down'], [ $enabled = true])
  • int $i: The row index
  • int $n: The number of items in the list
  • boolean $condition: True to show the icon
  • string $task: The task to fire
  • string $alt: The image alternate text string
  • $enabled
orderUpIcon (line 353)

Return the icon to move an item UP

  • return: Either the icon to move an item up or a space
  • since: 1.0
  • access: public
string orderUpIcon (int $i, [boolean $condition = true], [string $task = 'orderup'], [string $alt = 'Move Up'], [ $enabled = true])
  • int $i: The row index
  • boolean $condition: True to show the icon
  • string $task: The task to fire
  • string $alt: The image alternate text string
  • $enabled
_buildDataObject (line 470)

Create and return the pagination data object

  • return: data object
  • since: 1.5
  • access: public
object Pagination _buildDataObject ()
_item_active (line 439)
void _item_active ( &$item)
  • &$item
_item_inactive (line 453)
void _item_inactive ( &$item)
  • &$item
_list_footer (line 403)
void _list_footer ( $list)
  • $list
_list_render (line 418)
void _list_render ( $list)
  • $list

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::getPublicProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
Documentation generated on Mon, 22 Sep 2008 12:11:21 +0100 by phpDocumentor 1.3.1