API Joomla 1.5.26
Documentation des API du CMS Joomla en version 1.5

Référence de la classe JPagination

Graphe d'héritage de JPagination:
Graphe de collaboration de JPagination:

Liste de tous les membres

Fonctions membres publiques

Attributs publics


Documentation des constructeurs et destructeur

JPagination::__construct ( total,
limitstart,
limit 
)

Constructor

Paramètres:
intThe total number of items
intThe offset of the item to start at
intThe number of items to display per page

Références $total.


Documentation des fonctions membres

JPagination::_buildDataObject ( )

Create and return the pagination data object

public

Renvoie:
object Pagination data object
Depuis:
1.5

Références $data, $i, JRoute::_(), et JText::_().

Voici le graphe d'appel pour cette fonction :

JPagination::_item_active ( &$  item)

Références $item, et $mainframe.

JPagination::_item_inactive ( &$  item)

Références $mainframe.

JPagination::_list_footer ( list)
JPagination::_list_render ( list)

Références $list.

JPagination::getData ( )

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

public

Renvoie:
object Pagination data object
Depuis:
1.5

Références $data.

JPagination::getLimitBox ( )

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

public

Renvoie:
string The html for the limit # input box
Depuis:
1.0

Références $i, $mainframe, JText::_(), et JHTML::_().

Voici le graphe d'appel pour cette fonction :

JPagination::getListFooter ( )

Return the pagination footer

public

Renvoie:
string Pagination footer
Depuis:
1.0

Références $list, $mainframe, et pagination_list_footer().

Voici le graphe d'appel pour cette fonction :

JPagination::getPagesCounter ( )

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

public

Renvoie:
string Pagination pages counter string
Depuis:
1.5

Références JText::sprintf().

Voici le graphe d'appel pour cette fonction :

JPagination::getPagesLinks ( )

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

public

Renvoie:
string Pagination page list string
Depuis:
1.0

Références $data, $i, $lang, $list, $mainframe, JFactory::getLanguage(), pagination_item_active(), pagination_item_inactive(), et pagination_list_render().

Voici le graphe d'appel pour cette fonction :

JPagination::getResultsCounter ( )

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

public

Renvoie:
string Pagination result set counter string
Depuis:
1.5

Références JText::sprintf().

Voici le graphe d'appel pour cette fonction :

JPagination::getRowOffset ( index)

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

public

Paramètres:
int$indexThe row index
Renvoie:
int Rationalised offset for a row with a given index
Depuis:
1.5
JPagination::orderDownIcon ( i,
n,
condition = true,
task = 'orderdown',
alt = 'Move Down',
enabled = true 
)

Return the icon to move an item DOWN

public

Paramètres:
int$iThe row index
int$nThe number of items in the list
boolean$conditionTrue to show the icon
string$taskThe task to fire
string$altThe image alternate text string
Renvoie:
string Either the icon to move an item down or a space
Depuis:
1.0
JPagination::orderUpIcon ( i,
condition = true,
task = 'orderup',
alt = 'Move Up',
enabled = true 
)

Return the icon to move an item UP

public

Paramètres:
int$iThe row index
boolean$conditionTrue to show the icon
string$taskThe task to fire
string$altThe image alternate text string
Renvoie:
string Either the icon to move an item up or a space
Depuis:
1.0

Références $i, et JText::_().

Voici le graphe d'appel pour cette fonction :


Documentation des données membres

JPagination::$_viewall = false
JPagination::$limit = null
JPagination::$limitstart = null
JPagination::$total = null

La documentation de cette classe a été générée à partir du fichier suivant :