Référence de la classe JHtmlGrid

Liste de tous les membres

Fonctions membres publiques statiques
static	boolean ($i, $value, $taskOn=null, $taskOff=null)
static	sort ($title, $order, $direction= 'asc', $selected=0, $task=null, $new_direction= 'asc')
static	id ($rowNum, $recId, $checkedOut=false, $name= 'cid')
static	access (&$row, $i, $archived=null)
static	checkedOut (&$row, $i, $identifier= 'id')
static	published ($value, $i, $img1= 'tick.png', $img0= 'publish_x.png', $prefix= '')
static	state ($filter_state= '*', $published= 'Published', $unpublished= 'Unpublished', $archived=null, $trashed=null)
static	order ($rows, $image= 'filesave.png', $task= 'saveorder')
static	behavior ()

Fonctions membres protégées statiques
static	_checkedOut (&$row, $overlib=1)

---

Documentation des fonctions membres

static JHtmlGrid::_checkedOut ( &  $row,   $overlib = 1  )

staticprotected

Method to create a checked out icon with optional overlib in a grid.

Paramètres:

object	&$row	The row object
boolean	$overlib	True if an overlib with checkout information should be created.

Renvoie:

string HTMl for the icon and overlib

Depuis:

11.1

static JHtmlGrid::access ( &  $row,   $i,   $archived = null  )

static

Deprecated method to change access level in a grid

Paramètres:

integer	&$row	Row id
integer	$i	Row index
boolean	$archived	True if the item is archived

Renvoie:

string

Obsolète:

12.1

Note:

This method is incompatible with JAccess

Depuis:

11.1

static JHtmlGrid::behavior ( )

static

Method to build the behavior script and add it to the document head.

Renvoie:

void

Depuis:

11.1

static JHtmlGrid::boolean (   $i,   $value,   $taskOn = null,   $taskOff = null  )

static

Display a boolean setting widget.

Paramètres:

integer	$i	The row index.
integer	$value	The value of the boolean field.
string	$taskOn	Task to turn the boolean setting on.
string	$taskOff	Task to turn the boolean setting off.

Renvoie:

string The boolean setting widget.

Depuis:

11.1

Références $html, $i, $task, $title, JText\_(), et task.

Voici le graphe d'appel pour cette fonction :

static JHtmlGrid::checkedOut ( &  $row,   $i,   $identifier = 'id'  )

static

Displays a checked out icon.

Paramètres:

object	&$row	A data object (must contain checkedout as a property).
integer	$i	The index of the row.
string	$identifier	The property name of the primary key or index of the row.

Renvoie:

string

Depuis:

11.1

static JHtmlGrid::id (   $rowNum,   $recId,   $checkedOut = false,   $name = 'cid'  )

static

Method to create a checkbox for a grid row.

Paramètres:

integer	$rowNum	The row index
integer	$recId	The record id
boolean	$checkedOut	True if item is checke out
string	$name	The name of the form element

Renvoie:

mixed String of html with a checkbox if item is not checked out, null if checked out.

static JHtmlGrid::order (   $rows,   $image = 'filesave.png',   $task = 'saveorder'  )

static

Method to create an icon for saving a new ordering in a grid

Paramètres:

array	$rows	The array of rows of rows
string	$image	The image
string	$task	The task to use, defaults to save order

Renvoie:

string

Depuis:

11.1

static JHtmlGrid::published (   $value,   $i,   $img1 = 'tick.png',   $img0 = 'publish_x.png',   $prefix = ''  )

static

Method to create a clickable icon to change the state of an item

Paramètres:

mixed	$value	Either the scalar value or an object (for backward compatibility, deprecated)
integer	$i	The index
string	$img1	Image for a positive or on value
string	$img0	Image for the empty or off value
string	$prefix	An optional prefix for the task

Renvoie:

string

Depuis:

11.1

static JHtmlGrid::sort (   $title,   $order,   $direction = 'asc',   $selected = 0,   $task = null,   $new_direction = 'asc'  )

static

Method to sort a column in a grid

Paramètres:

string	$title	The link title
string	$order	The order field for the column
string	$direction	The current direction
string	$selected	The selected ordering
string	$task	An optional task override
string	$new_direction	An optional direction for the new column

Renvoie:

string

Depuis:

11.1

static JHtmlGrid::state (   $filter_state = '*',   $published = 'Published',   $unpublished = 'Unpublished',   $archived = null,   $trashed = null  )

static

Method to create a select list of states for filtering By default the filter shows only published and unpublished items

Paramètres:

string	$filter_state	The initial filter state
string	$published	The JText string for published
string	$unpublished	The JText string for Unpublished
string	$archived	The JText string for Archived
string	$trashed	The JText string for Trashed

Renvoie:

string

Depuis:

11.1

---

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

• html/grid.php