Docs for class JPagination

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JPagination

Description

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

since: 1.5
author: Louis Landry <[email protected]>

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

 JObject   (Subpackage Base)

 JPagination   (Subpackage HTML)

Variable Summary

int $limit

int $limitstart

int $total

string $_link

boolean $_viewall

Method Summary

JPagination __construct ( $total, $limitstart, $limit, [ $link = null])

object Pagination getData ()

string getLimitBox ([ $link = null])

string getListFooter ()

string getPagesCounter ()

string getPagesLinks ([ $link = null])

string getResultsCounter ()

int getRowOffset (int $index)

string orderDownIcon (int $i, int $n, [boolean $condition = true], [string $task = 'orderdown'], [string $alt = 'Move Down'], [ $enabled = true])

string orderDownIcon2 (int $id, int $order, [boolean $condition = true], [string $task = 'orderdown'], [string $alt = '#'])

string orderUpIcon (int $i, [boolean $condition = true], [string $task = 'orderup'], [string $alt = 'Move Up'], [ $enabled = true])

string orderUpIcon2 (int $id, int $order, [boolean $condition = true], [string $task = 'orderup'], [string $alt = '#'])

object Pagination _buildDataObject ([ $base = null])

void _item_active ( &$item)

void _item_inactive ( &$item)

void _list_footer ( $list)

void _list_render ( $list)

Variables

int $limit = null (line 43)

Number of rows to display per page

access: public

int $limitstart = null (line 35)

The record number to start dislpaying from

access: public

int $total = null (line 51)

Total number of rows

access: public

string $_link = null (line 59)

Base URL for pagination output

access: protected

boolean $_viewall = false (line 67)

View all flag

access: protected

Methods

Constructor __construct (line 72)

Constructor

JPagination __construct ( $total, $limitstart, $limit, [ $link = null])

$total
$limitstart
$limit
$link

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

getData (line 159)

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 338)

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 ([ $link = null])

$link

getListFooter (line 309)

Return the pagination footer

return: Pagination footer
since: 1.0
access: public

string getListFooter ()

getPagesCounter (line 175)

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 223)

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 ([ $link = null])

$link

getResultsCounter (line 192)

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 148)

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 409)

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

orderDownIcon2 (line 474)

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 orderDownIcon2 (int $id, int $order, [boolean $condition = true], [string $task = 'orderdown'], [string $alt = '#'])

int $id: The row index
int $order: The ordering value for the item
boolean $condition: [Does Not Appear To Be Used]
string $task: The task to fire
string $alt: The image alternate text string

orderUpIcon (line 378)

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

orderUpIcon2 (line 440)

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 orderUpIcon2 (int $id, int $order, [boolean $condition = true], [string $task = 'orderup'], [string $alt = '#'])

int $id: The row index
int $order: The ordering value for the item
boolean $condition: [Does Not Appear To Be Used]
string $task: The task to fire
string $alt: The image alternate text string

_buildDataObject (line 582)

Create and return the pagination data object

return: data object
since: 1.5
access: public

object Pagination _buildDataObject ([ $base = null])

$base

_item_active (line 555)

void _item_active ( &$item)

&$item

_item_inactive (line 565)

void _item_inactive ( &$item)

&$item

_list_footer (line 496)

void _list_footer ( $list)

$list

_list_render (line 518)

void _list_render ( $list)

$list

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()

Documentation generated on Mon, 05 Mar 2007 21:12:54 +0000 by phpDocumentor 1.3.1