Docs For Class JPagination

Description

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

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

Located in /utilities/presentation/pagination.php (line 26)

JObject
   |
   --JPagination

Variable Summary

int $limit

int $limitstart

int $total

Method Summary

JPagination __construct (mixed $total, mixed $limitstart, mixed $limit)

string getLimitBox ([mixed $link = null])

string getListFooter ()

string getPagesCounter ()

string getPagesLinks ([mixed $link = null])

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

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'])

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

int rowNumber (int $index)

boolean setTemplateVars (object &$tmpl, [string $name = 'admin-list-footer'])

void writeLeafsCounter ()

void writeLimitBox ([mixed $link = null])

void writePagesCounter ()

void writePagesLinks ([mixed $link = null])

Variables

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

Methods

Constructor __construct (line 55)

Constructor

JPagination __construct (mixed $total, mixed $limitstart, mixed $limit)

Redefinition of:

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

getLimitBox (line 118)

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

getListFooter (line 277)

Return the pagination footer

return: Pagination footer
since: 1.0
access: public

string getListFooter ()

getPagesCounter (line 149)

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

return: Pagination counter string
since: 1.0
access: public

string getPagesCounter ()

getPagesLinks (line 180)

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

orderDownIcon (line 335)

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'])

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

orderDownIcon2 (line 398)

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

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'])

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

orderUpIcon2 (line 358)

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

rowNumber (line 297)

Return the row number

return: Row number for given index
since: 1.0
access: public

int rowNumber (int $index)

int $index: The row index

setTemplateVars (line 87)

Sets the vars for the page navigation template

return: True if successful
since: 1.1
access: public

boolean setTemplateVars (object &$tmpl, [string $name = 'admin-list-footer'])

object $tmpl: PatTemplate Object to add the pagination footer template to
string $name: Name of the pagination footer template to add

writeLeafsCounter (line 102)

Writes the html for the leafs counter, eg, Page 1 of x

access: public

void writeLeafsCounter ()

writeLimitBox (line 432)

Writes the dropdown select list for number of rows to show per page Use: print JPagination :: getLimitBox();

deprecated: as of 1.1

void writeLimitBox ([mixed $link = null])

writePagesCounter (line 442)

Writes the counter string Use: print $pagination->getLimitBox();

deprecated: as of 1.1

void writePagesCounter ()

writePagesLinks (line 452)

Writes the page list string Use: print $pagination->getPagesLinks();

deprecated: as of 1.1

void writePagesLinks ([mixed $link = null])

Inherited Methods

Inherited From JObject

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