.
* ---------------------------------------------------------------------
*/
if (!defined('GLPI_ROOT')) {
die("Sorry. You can't access this file directly");
}
/// HTMLTable class
/// Create a smart HTML table. The table allows cells to depend on other ones. As such, it is
/// possible to have rowspan for cells that are "father" of other ones. If a "father" has several
/// sons, then, it "rowspans" on all.
/// The table integrates the notion of group of rows (HTMLTableGroup). For instance, for
/// Computer_Device, each group represents a kind of device (network card, graphique card,
/// processor, memory, ...).
/// There is HTMLTableSuperHeader that defines global headers for all groups. Each group can cut
/// these HTMLTableSuperHeader as many HTMLTableSubHeader as necessary. There is an automatic
/// organisation of the headers between groups.
///
/// The (strict) order of definition of the table is:
/// * Define all HTMLTableSuperHeader that are used by each group: HTMLTableMain::addHeader()
/// * Define one HTMLTableGroup: HTMLTableMain::createGroup()
/// * Define all HTMLTableSubHeader depending of previously defined HTMLTableSuperHeader
/// for the given group: HTMLTableGroup::addHeader()
/// * Create all HTMLTableRow for the given group: HTMLTableGroup::createRow()
/// * Create all HTMLTableCell for the given row : HTMLTableRow::addCell()
/// and so on for each group.
/// When done, call HTMLTableMain::display() to render the table.
///
/// A column that don't have any content is collapse
///
/// For further explaination, refer to NetworkPort and all its dependencies (NetworkName, IPAddress,
/// IPNetwork, ...) or Computer_Device and each kind of device.
/// @since 0.84
class HTMLTableMain extends HTMLTableBase {
private $groups = [];
private $itemtypes = [];
function __construct() {
parent::__construct(true);
}
/**
* We can define a global name for the table : this will print as header that colspan all columns
*
* @param string $name the name to print inside the header
*
* @return void
**/
function setTitle($name) {
$this->title = $name;
}
function tryAddHeader() {
if (count($this->groups) > 0) {
throw new Exception('Implementation error: must define all headers before any subgroups');
}
}
/**
* @param $name string The name of the group, to be able to retrieve the group
* later with HTMLTableMain::getHeaderByName()
* @param $content (@see HTMLTableEntity::content)
* The title of the group : display before the group itself
*
* TODO : study to be sure that the order is the one we have defined ...
*
* @return boolean|HTMLTableGroup
**/
function createGroup($name, $content) {
if (!empty($name)) {
if (!isset($this->groups[$name])) {
$this->groups[$name] = new HTMLTableGroup($this, $name, $content);
}
}
return $this->getGroup($name);
}
/**
* @param $itemtype
* @param $title
**/
function addItemType($itemtype, $title) {
$this->itemtypes[$itemtype] = $title;
}
/**
* Retrieve a group by its name
*
* @param $group_name (string) the group name
*
* @return boolean|HTMLTableGroup
**/
function getGroup($group_name) {
if (isset($this->groups[$group_name])) {
return $this->groups[$group_name];
}
return false;
}
/**
* Display the super headers, for the global table, or the groups
**/
function displaySuperHeader() {
echo "\t\t\n";
foreach ($this->getHeaderOrder() as $header_name) {
$header = $this->getSuperHeaderByName($header_name);
echo "\t\t\t";
$header->displayTableHeader(true);
echo "\n";
}
echo "\t\t
\n";
}
/**
* get the total number of rows (ie.: the sum of each group number of rows)
*
* Beware that a row is counted only if it is not empty (ie.: at least one addCell)
*
* @return integer the total number of rows
**/
function getNumberOfRows() {
$numberOfRow = 0;
foreach ($this->groups as $group) {
$numberOfRow += $group->getNumberOfRows();
}
return $numberOfRow;
}
/**
* Display the table itself
*
* @param $params array of possible options:
* 'html_id' the global HTML ID of the table
* 'display_thead' display the header before the first group
* 'display_tfoot' display the header at the end of the table
* 'display_header_for_each_group' display the header of each group
* 'display_header_on_foot_for_each_group' repeat group header on foot of group
* 'display_super_for_each_group' display the super header befor each group
* 'display_title_for_each_group' display the title of each group
*
* @return void
**/
function display(array $params) {
$p['html_id'] = '';
$p['display_thead'] = true;
$p['display_tfoot'] = true;
foreach ($params as $key => $val) {
$p[$key] = $val;
}
foreach ($this->groups as $group) {
$group->prepareDisplay();
}
$totalNumberOfRow = $this->getNumberOfRows();
$totalNumberOfColumn = 0;
foreach ($this->getHeaders() as $header) {
$colspan = $header['']->getColSpan();
$totalNumberOfColumn += $colspan;
}
foreach ($this->itemtypes as $itemtype => $title) {
Session::initNavigateListItems($itemtype, $title);
}
echo "\n\n";
$open_thead = ((!empty($this->title)) || ($p['display_thead']));
if ($open_thead) {
echo "\t\n";
}
if (!empty($this->title)) {
echo "\t\t| ".$this->title.
" |
|---|
\n";
}
if ($totalNumberOfRow == 0) {
if ($open_thead) {
echo "\t\n";
}
echo "\t\t".
"| " . __('None') ." |
\n";
} else {
if ($p['display_thead']) {
$this->displaySuperHeader();
}
if ($open_thead) {
echo "\t\n";
}
if ($p['display_tfoot']) {
echo "\t\n";
$this->displaySuperHeader();
echo "\t\n";
}
foreach ($this->groups as $group) {
$group->displayGroup($totalNumberOfColumn, $p);
}
}
echo "
\n";
}
}