Joomla CMS  2.5.24 (avec JPlatform 11.4 inclus)
Documentation des API du CMS Joomla en version 2.5 et du framework Joomla Platform intégré
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
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&$rowThe row object
boolean$overlibTrue 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&$rowRow id
integer$iRow index
boolean$archivedTrue 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$iThe row index.
integer$valueThe value of the boolean field.
string$taskOnTask to turn the boolean setting on.
string$taskOffTask 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&$rowA data object (must contain checkedout as a property).
integer$iThe index of the row.
string$identifierThe 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$rowNumThe row index
integer$recIdThe record id
boolean$checkedOutTrue if item is checke out
string$nameThe 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$rowsThe array of rows of rows
string$imageThe image
string$taskThe 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$valueEither the scalar value or an object (for backward compatibility, deprecated)
integer$iThe index
string$img1Image for a positive or on value
string$img0Image for the empty or off value
string$prefixAn 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$titleThe link title
string$orderThe order field for the column
string$directionThe current direction
string$selectedThe selected ordering
string$taskAn optional task override
string$new_directionAn 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_stateThe initial filter state
string$publishedThe JText string for published
string$unpublishedThe JText string for Unpublished
string$archivedThe JText string for Archived
string$trashedThe JText string for Trashed
Renvoie:
string
Depuis:
11.1

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