Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés
Référence de la classe JGrid

Liste de tous les membres

Fonctions membres publiques

 __construct ($options=array())
 __toString ()
 setTableOptions ($options=array(), $replace=false)
 getTableOptions ()
 addColumn ($name)
 getColumns ()
 deleteColumn ($name)
 setColumns ($columns)
 addRow ($options=array(), $special=false)
 getRowOptions ()
 setRowOptions ($options)
 getActiveRow ()
 setActiveRow ($id)
 setRowCell ($name, $content, $option=array(), $replace=true)
 getRow ($id=false)
 getRows ($special=false)
 deleteRow ($id)
 toString ()

Fonctions membres protégées

 renderArea ($ids, $area= 'tbody', $cell= 'td')
 renderAttributes ($attributes)

Attributs protégés

 $columns = array()
 $activeRow = 0
 $rows = array()
 $specialRows = array('header' => array(), 'footer' => array())
 $options

Description détaillée

Définition à la ligne 21 du fichier grid.php.

Documentation des constructeurs et destructeur

JGrid::__construct (   $options = array())

Constructor for a JGrid object

Paramètres:
array$optionsAssociative array of attributes for the table-tag
Depuis:
11.3

Définition à la ligne 65 du fichier grid.php.

{
$this->setTableOptions($options, true);
}

Documentation des fonctions membres

JGrid::__toString ( )

Magic function to render this object as a table.

Renvoie:
string
Depuis:
11.3

Définition à la ligne 77 du fichier grid.php.

{
return $this->toString();
}
JGrid::addColumn (   $name)

Add new column name to process

Paramètres:
string$nameInternal column name
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 126 du fichier grid.php.

{
$this->columns[] = $name;
return $this;
}
JGrid::addRow (   $options = array(),
  $special = false 
)

Adds a row to the table and sets the currently active row to the new row

Paramètres:
array$optionsAssociative array of attributes for the row
int$special1 for a new row in the header, 2 for a new row in the footer
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 194 du fichier grid.php.

{
$this->rows[]['_row'] = $options;
$this->activeRow = count($this->rows) - 1;
if ($special)
{
if ($special === 1)
{
$this->specialRows['header'][] = $this->activeRow;
}
else
{
$this->specialRows['footer'][] = $this->activeRow;
}
}
return $this;
}
JGrid::deleteColumn (   $name)

Delete column by name

Paramètres:
string$nameName of the column to be deleted
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 154 du fichier grid.php.

{
$index = array_search($name, $this->columns);
if ($index !== false)
{
unset($this->columns[$index]);
$this->columns = array_values($this->columns);
}
return $this;
}
JGrid::deleteRow (   $id)

Delete a row from the object

Paramètres:
int$idID of the row to be deleted
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 359 du fichier grid.php.

{
unset($this->rows[$id]);
if (in_array($id, $this->specialRows['header']))
{
unset($this->specialRows['header'][array_search($id, $this->specialRows['header'])]);
}
if (in_array($id, $this->specialRows['footer']))
{
unset($this->specialRows['footer'][array_search($id, $this->specialRows['footer'])]);
}
if ($this->activeRow == $id)
{
end($this->rows);
$this->activeRow = key($this->rows);
}
return $this;
}
JGrid::getActiveRow ( )

Get the currently active row ID

Renvoie:
int ID of the currently active row
Depuis:
11.3

Définition à la ligne 248 du fichier grid.php.

{
return $this->activeRow;
}
JGrid::getColumns ( )

Returns the list of internal columns

Renvoie:
array List of internal columns
Depuis:
11.3

Définition à la ligne 140 du fichier grid.php.

{
return $this->columns;
}
JGrid::getRow (   $id = false)

Get all data for a row

Paramètres:
int$idID of the row to return
Renvoie:
array Array of columns of a table row
Depuis:
11.3

Définition à la ligne 308 du fichier grid.php.

{
if ($id === false)
{
$id = $this->activeRow;
}
if (isset($this->rows[(int) $id]))
{
return $this->rows[(int) $id];
}
else
{
return false;
}
}
JGrid::getRowOptions ( )

Method to get the attributes of the currently active row

Renvoie:
array Associative array of attributes
Depuis:
11.3

Définition à la ligne 220 du fichier grid.php.

{
return $this->rows[$this->activeRow]['_row'];
}
JGrid::getRows (   $special = false)

Get the IDs of all rows in the table

Paramètres:
int$specialfalse for the standard rows, 1 for the header rows, 2 for the footer rows
Renvoie:
array Array of IDs
Depuis:
11.3

Définition à la ligne 334 du fichier grid.php.

{
if ($special)
{
if ($special === 1)
{
return $this->specialRows['header'];
}
else
{
return $this->specialRows['footer'];
}
}
return array_diff(array_keys($this->rows), array_merge($this->specialRows['header'], $this->specialRows['footer']));
}
JGrid::getTableOptions ( )

Get the Attributes of the current table

Renvoie:
array Associative array of attributes
Depuis:
11.3

Définition à la ligne 112 du fichier grid.php.

{
return $this->options;
}
JGrid::renderArea (   $ids,
  $area = 'tbody',
  $cell = 'td' 
)
protected

Render an area of the table

Paramètres:
array$idsIDs of the rows to render
string$areaName of the area to render. Valid: tbody, tfoot, thead
string$cellName of the cell to render. Valid: td, th
Renvoie:
string The rendered table area
Depuis:
11.3

Définition à la ligne 425 du fichier grid.php.

{
$output = array();
$output[] = '<' . $area . ">\n";
foreach ($ids as $id)
{
$output[] = "\t<tr" . $this->renderAttributes($this->rows[$id]['_row']) . ">\n";
foreach ($this->getColumns() as $name)
{
if (isset($this->rows[$id][$name]))
{
$column = $this->rows[$id][$name];
$output[] = "\t\t<" . $cell . $this->renderAttributes($column->options) . '>' . $column->content . '</' . $cell . ">\n";
}
}
$output[] = "\t</tr>\n";
}
$output[] = '</' . $area . '>';
return implode('', $output);
}
JGrid::renderAttributes (   $attributes)
protected

Renders an HTML attribute from an associative array

Paramètres:
array$attributesAssociative array of attributes
Renvoie:
string The HTML attribute string
Depuis:
11.3

Définition à la ligne 457 du fichier grid.php.

{
if (count((array) $attributes) == 0)
{
return '';
}
$return = array();
foreach ($attributes as $key => $option)
{
$return[] = $key . '="' . $option . '"';
}
return ' ' . implode(' ', $return);
}
JGrid::setActiveRow (   $id)

Set the currently active row

Paramètres:
int$idID of the row to be set to current
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 262 du fichier grid.php.

{
$this->activeRow = (int) $id;
return $this;
}
JGrid::setColumns (   $columns)

Method to set a whole range of columns at once This can be used to re-order the columns, too

Paramètres:
array$columnsList of internal column names
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 176 du fichier grid.php.

{
$this->columns = array_values($columns);
return $this;
}
JGrid::setRowCell (   $name,
  $content,
  $option = array(),
  $replace = true 
)

Set cell content for a specific column for the currently active row

Paramètres:
string$nameName of the column
string$contentContent for the cell
array$optionAssociative array of attributes for the td-element
bool$replaceIf false, the content is appended to the current content of the cell
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 281 du fichier grid.php.

{
if ($replace || !isset($this->rows[$this->activeRow][$name]))
{
$cell = new stdClass;
$cell->options = $option;
$cell->content = $content;
$this->rows[$this->activeRow][$name] = $cell;
}
else
{
$this->rows[$this->activeRow][$name]->content .= $content;
$this->rows[$this->activeRow][$name]->options = $option;
}
return $this;
}
JGrid::setRowOptions (   $options)

Method to set the attributes of the currently active row

Paramètres:
array$optionsAssociative array of attributes
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 234 du fichier grid.php.

{
$this->rows[$this->activeRow]['_row'] = $options;
return $this;
}
JGrid::setTableOptions (   $options = array(),
  $replace = false 
)

Method to set the attributes for a table-tag

Paramètres:
array$optionsAssociative array of attributes for the table-tag
bool$replaceReplace possibly existing attributes
Renvoie:
JGrid This object for chaining
Depuis:
11.3

Définition à la ligne 92 du fichier grid.php.

{
if ($replace)
{
$this->options = $options;
}
else
{
$this->options = array_merge($this->options, $options);
}
return $this;
}
JGrid::toString ( )

Render the HTML table

Renvoie:
string The rendered HTML table
Depuis:
11.3

Définition à la ligne 389 du fichier grid.php.

{
$output = array();
$output[] = '<table' . $this->renderAttributes($this->getTableOptions()) . '>';
if (count($this->specialRows['header']))
{
$output[] = $this->renderArea($this->specialRows['header'], 'thead', 'th');
}
if (count($this->specialRows['footer']))
{
$output[] = $this->renderArea($this->specialRows['footer'], 'tfoot');
}
$ids = array_diff(array_keys($this->rows), array_merge($this->specialRows['header'], $this->specialRows['footer']));
if (count($ids))
{
$output[] = $this->renderArea($ids);
}
$output[] = '</table>';
return implode('', $output);
}

Documentation des données membres

JGrid::$activeRow = 0
protected

Définition à la ligne 35 du fichier grid.php.

JGrid::$columns = array()
protected

Définition à la ligne 28 du fichier grid.php.

JGrid::$options
protected

Définition à la ligne 56 du fichier grid.php.

JGrid::$rows = array()
protected

Définition à la ligne 42 du fichier grid.php.

JGrid::$specialRows = array('header' => array(), 'footer' => array())
protected

Définition à la ligne 49 du fichier grid.php.

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