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
	__construct ($total, $limitstart, $limit, $prefix= '')
	setAdditionalUrlParam ($key, $value)
	getAdditionalUrlParam ($key)
	getRowOffset ($index)
	getData ()
	getPagesCounter ()
	getResultsCounter ()
	getPagesLinks ()
	getListFooter ()
	getLimitBox ()
	orderUpIcon ($i, $condition=true, $task= 'orderup', $alt= 'JLIB_HTML_MOVE_UP', $enabled=true, $checkbox= 'cb')
	orderDownIcon ($i, $n, $condition=true, $task= 'orderdown', $alt= 'JLIB_HTML_MOVE_DOWN', $enabled=true, $checkbox= 'cb')
Fonctions membres publiques inherited from JObject
	__construct ($properties=null)
	__toString ()
	def ($property, $default=null)
	get ($property, $default=null)
	getProperties ($public=true)
	getError ($i=null, $toString=true)
	getErrors ()
	set ($property, $value=null)
	setProperties ($properties)
	setError ($error)
	toString ()

Attributs publics
	$limitstart = null
	$limit = null
	$total = null
	$prefix = null

Fonctions membres protégées
	_list_footer ($list)
	_list_render ($list)
	_item_active (&$item)
	_item_inactive (&$item)
	_buildDataObject ()

Attributs protégés
	$_viewall = false
	$_additionalUrlParams = array()
Attributs protégés inherited from JObject
	$_errors = array()

---

Documentation des constructeurs et destructeur

JPagination::__construct	(		$total,
			$limitstart,
			$limit,
			$prefix = ''
	)

Constructor.

Paramètres:

integer	$total	The total number of items.
integer	$limitstart	The offset of the item to start at.
integer	$limit	The number of items to display per page.
string	$prefix	The prefix used for request variables.

Depuis:

11.1

Références $limit, et $total.

---

Documentation des fonctions membres

JPagination::_buildDataObject ( )

protected

Create and return the pagination data object.

Renvoie:

object Pagination data object.

Depuis:

11.1

Références $data, $i, $key, $limit, $params, JRoute\_(), et JText\_().

Voici le graphe d'appel pour cette fonction :

JPagination::_item_active ( &  $item )

protected

Method to create an active pagination link to the item

Paramètres:

JPaginationObject

&$item

The object with which to make an active link.

Renvoie:

string HTML link

Depuis:

11.1

Références $app, $item, et JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

JPagination::_item_inactive ( &  $item )

protected

Method to create an inactive pagination string

Paramètres:

object

&$item

The item to be processed

Renvoie:

string

Depuis:

11.1

Références $app, $item, et JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

JPagination::_list_footer (   $list )

protected

Create the HTML for a list footer

Paramètres:

array

$list

Pagination list data structure.

Renvoie:

string HTML for a list footer

Depuis:

11.1

Références $html, $list, et JText\_().

Voici le graphe d'appel pour cette fonction :

JPagination::_list_render (   $list )

protected

Create the html for a list footer

Paramètres:

array

$list

Pagination list data structure.

Renvoie:

string HTML for a list start, previous, next,end

Depuis:

11.1

Références $html, et $list.

JPagination::getAdditionalUrlParam

(

$key

)

Method to get an additional URL parameter (if it exists) to be added to all pagination class generated links.

Paramètres:

string

$key

The name of the URL parameter for which to get the value.

Renvoie:

mixed The value if it exists or null if it does not.

Depuis:

11.1

Références $key, et null.

JPagination::getData

(

)

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

Renvoie:

object Pagination data object.

Depuis:

11.1

Références $data.

JPagination::getLimitBox

(

)

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

Renvoie:

string The HTML for the limit # input box.

Depuis:

11.1

Références $app, $html, $i, $limit, JHtml\_(), JText\_(), et JFactory\getApplication().

Voici le graphe d'appel pour cette fonction :

JPagination::getListFooter

(

)

Return the pagination footer.

Renvoie:

string Pagination footer.

Depuis:

11.1

Références $app, $limit, $list, $total, JFactory\getApplication(), JPATH_THEMES, 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.

Renvoie:

string Pagination pages counter string.

Depuis:

11.1

Références $html, null, et 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.

Renvoie:

string Pagination page list string.

Depuis:

11.1

Références $app, $data, $i, $list, JFactory\getApplication(), JPATH_THEMES, null, 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, e.g. Results 1-10 of 42

Renvoie:

string Pagination result set counter string.

Depuis:

11.1

Références $html, $limit, $total, JText\_(), null, et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JPagination::getRowOffset

(

$index

)

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

Paramètres:

integer

$index

The row index

Renvoie:

integer Rationalised offset for a row with a given index.

Depuis:

11.1

JPagination::orderDownIcon	(		$i,
			$n,
			$condition = true,
			$task = 'orderdown',
			$alt = 'JLIB_HTML_MOVE_DOWN',
			$enabled = true,
			$checkbox = 'cb'
	)

Return the icon to move an item DOWN.

Paramètres:

integer	$i	The row index.
integer	$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 alternative text string.
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.

Renvoie:

string Either the icon to move an item down or a space.

Depuis:

11.1

Références $enabled, $i, $task, et JHtml\_().

Voici le graphe d'appel pour cette fonction :

JPagination::orderUpIcon	(		$i,
			$condition = true,
			$task = 'orderup',
			$alt = 'JLIB_HTML_MOVE_UP',
			$enabled = true,
			$checkbox = 'cb'
	)

Return the icon to move an item UP.

Paramètres:

integer	$i	The row index.
boolean	$condition	True to show the icon.
string	$task	The task to fire.
string	$alt	The image alternative text string.
boolean	$enabled	An optional setting for access control on the action.
string	$checkbox	An optional prefix for checkboxes.

Renvoie:

string Either the icon to move an item up or a space.

Depuis:

11.1

Références $enabled, $i, $task, et JHtml\_().

Voici le graphe d'appel pour cette fonction :

JPagination::setAdditionalUrlParam	(		$key,
			$value
	)

Method to set an additional URL parameter to be added to all pagination class generated links.

Paramètres:

string	$key	The name of the URL parameter for which to set a value.
mixed	$value	The value to set for the URL parameter.

Renvoie:

mixed The old value for the parameter.

Depuis:

11.1

Références $key, et null.

---

Documentation des données membres

JPagination::$_additionalUrlParams = array()

protected

JPagination::$_viewall = false

protected

JPagination::$limit = null

JPagination::$limitstart = null

JPagination::$prefix = null

JPagination::$total = null

---

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

• libraries/joomla/html/pagination.php