ILIAS  Release_4_2_x_branch Revision 61807
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilTableGUI Class Reference

Class ilTableGUI. More...

+ Inheritance diagram for ilTableGUI:
+ Collaboration diagram for ilTableGUI:

Public Member Functions

 ilTableGUI ($a_data=0, $a_global_tpl=true)
 Constructor.
 setTemplate (&$a_tpl)
 set template public
getTemplateObject ()
 setData ($a_data)
 set table data public
 getData ()
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public
 setHeaderNames ($a_header_names)
 set table header names public
 getColumnCount ()
 Returns the column count based on the number of the header row columns public.
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public
 setColumnWidth ($a_column_width)
 set table column widths public
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width public
 setMaxCount ($a_max_count)
 set max.
 setLimit ($a_limit=0, $a_default_limit=0)
 set max.
 getLimit ()
 Get limit.
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public
 setOffset ($a_offset)
 set dataset offset public
 getOffset ()
 Get offset.
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public
 getOrderColumn ()
 Get order column.
 setOrderDirection ($a_order_direction)
 set order direction public
 getOrderDirection ()
 Get order direction.
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction public
 enable ($a_module_name)
 enables particular modules of table
 disable ($a_module_name)
 diesables particular modules of table
 sortData ()
 render ()
 render table public
 renderHeader ()
 setOrderLink ($key, $order_dir)
 setStyle ($a_element, $a_style)
 getStyle ($a_element)
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds).
 getBase ()
 Get Base script name (deprecated, only use this for workarounds).
 getFormName ()
 setFormName ($a_name="cmd")
 getSelectAllCheckbox ()
 setSelectAllCheckbox ($a_select_all_checkbox)
 clearActionButtons ()
 addActionButton ($btn_name, $btn_value)

Data Fields

 $title
 $icon
 $icon_alt
 $help_page
 $help_icon
 $help_icon_alt
 $header_names
 $header_vars
 $linkbar_vars
 $data
 $column_count
 $column_width
 $max_count
 $limit
 $max_limit = false
 $offset
 $order_column
 $order_direction
 $footer_style
 $footer_previous
 $footer_next
 $lang_support = true
 $global_tpl
 $form_name
 $select_all_checkbox
 $action_buttons
 $prefix
 $base = ""
 $enabled
 $styles

Detailed Description

Class ilTableGUI.

HTML table component

Author
Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e
Version
Id:
class.ilTableGUI.php 23354 2010-03-24 13:25:09Z akill

Definition at line 18 of file class.ilTableGUI.php.

Member Function Documentation

ilTableGUI::addActionButton (   $btn_name,
  $btn_value 
)

Definition at line 850 of file class.ilTableGUI.php.

{
array_push($this->action_buttons,
array(
"name" => $btn_name,
"value" => $btn_value
)
);
}
ilTableGUI::clearActionButtons ( )

Definition at line 838 of file class.ilTableGUI.php.

{
$this->action_buttons = array();
}
ilTableGUI::disable (   $a_module_name)

diesables particular modules of table

DEPRECATED for Table2GUI: Use setEnable<Section>() of Table2GUI instead

public

Parameters
stringmodule name

Definition at line 442 of file class.ilTableGUI.php.

Referenced by ilPresentationListTableGUI\__construct(), ilUploadDirFilesTableGUI\__construct(), ilAccessKeyTableGUI\__construct(), ilLanguageTableGUI\__construct(), ilObjectTranslationTableGUI\__construct(), ilExcDeliveredFilesTableGUI\__construct(), ilBenchmarkTableGUI\__construct(), ilSkillSelfEvalSkillTableGUI\__construct(), ilPasteStyleCharacteristicTableGUI\__construct(), ilConfirmationTableGUI\__construct(), ilClientListTableGUI\__construct(), ilSetupLanguageTableGUI\__construct(), ilRepDependenciesTableGUI\__construct(), ilCustomUserFieldSettingsTableGUI\__construct(), ilStyleTableGUI\__construct(), ilUserFieldSettingsTableGUI\__construct(), ilSelfEvaluationSimpleTableGUI\__construct(), ilSkillAssignMaterialsTableGUI\__construct(), ilObjectRoleTemplateOptionsTableGUI\__construct(), ilQuestionBrowserTableGUI\__construct(), ilObjectRoleTemplatePermissionTableGUI\__construct(), ilObjectRolePermissionTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilSurveyMaterialsTableGUI\__construct(), ilSurveyInvitedUsersTableGUI\__construct(), ilAssessmentFolderLogTableGUI\__construct(), ilTestAggregatedResultsTableGUI\__construct(), ilTestAverageReachedPointsTableGUI\__construct(), ilCourseObjectiveQuestionsTableGUI\__construct(), ilSurveyResultsCumulatedTableGUI\__construct(), ilCalendarCategoryTableGUI\__construct(), assFileUploadFileTableGUI\__construct(), ilGroupEditParticipantsTableGUI\__construct(), ilQuestionPoolPrintViewTableGUI\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilSurveyResultsUserTableGUI\__construct(), ilSurveyPhrasesTableGUI\__construct(), ilSurveySavePhraseTableGUI\__construct(), ilLuceneAdvancedSearchActivationTableGUI\__construct(), ilListOfQuestionsTableGUI\__construct(), ilSurveyCodesTableGUI\__construct(), ilSubscriberTableGUI\__construct(), ilTestExportTableGUI\__construct(), ilSCORM2004ExportTableGUI\__construct(), ilSurveyQuestionPoolExportTableGUI\__construct(), ilSurveyCodesMailTableGUI\__construct(), ilSurveyMaintenanceTableGUI\__construct(), ilSurveyExportTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilTestQuestionsTableGUI\__construct(), ilSessionParticipantsTableGUI\__construct(), ilECSCommunityTableGUI\__construct(), ilCourseObjectiveQuestionAssignmentTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilRoleTableGUI\init(), ilAuthLoginPageEditorTableGUI\initTable(), ilShopPersonalSettingsTopicsTableGUI\parseRecords(), and ilShopTopicsTableGUI\parseRecords().

{
if (!in_array($a_module_name,array_keys($this->enabled)))
{
return false;
}
$this->enabled[$a_module_name] = false;
}

+ Here is the caller graph for this function:

ilTableGUI::enable (   $a_module_name)

enables particular modules of table

DEPRECATED for Table2GUI: Use setEnable...<Section>() of Table2GUI instead

public

Parameters
stringmodule name

Definition at line 424 of file class.ilTableGUI.php.

Referenced by iliLinkConfirmationTableGUI\__construct(), iliLinkMembersTableGUI\__construct(), ilObjectCustomUserFieldsTableGUI\__construct(), ilForumStatisticsTableGUI\__construct(), ilRepositoryUserResultTableGUI\__construct(), ilConsultationHoursTableGUI\__construct(), ilQuestionBrowserTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilEvaluationAllTableGUI\__construct(), ilSurveyMaterialsTableGUI\__construct(), ilRepositoryObjectResultTableGUI\__construct(), ilSurveyInvitedUsersTableGUI\__construct(), ilTestAverageReachedPointsTableGUI\__construct(), ilTestInviteGroupsTableGUI\__construct(), ilTestInviteRolesTableGUI\__construct(), ilTestInviteUsersTableGUI\__construct(), ilAssessmentFolderLogAdministrationTableGUI\__construct(), ilAssessmentFolderLogTableGUI\__construct(), ilTestAggregatedResultsTableGUI\__construct(), ilCourseObjectiveQuestionsTableGUI\__construct(), assFileUploadFileTableGUI\__construct(), ilSurveyResultsCumulatedTableGUI\__construct(), ilCalendarCategoryTableGUI\__construct(), ilCalendarManageTableGUI\__construct(), ilTestFixedParticipantsTableGUI\__construct(), ilTestHistoryTableGUI\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilTestParticipantsTableGUI\__construct(), ilTestQuestionBrowserTableGUI\__construct(), ilSurveyResultsUserTableGUI\__construct(), ilQuestionPoolPrintViewTableGUI\__construct(), ilSurveyPhrasesTableGUI\__construct(), ilSurveySavePhraseTableGUI\__construct(), ilGroupEditParticipantsTableGUI\__construct(), ilListOfQuestionsTableGUI\__construct(), ilTestExportTableGUI\__construct(), ilSurveyCodesMailTableGUI\__construct(), ilSurveyMaintenanceTableGUI\__construct(), ilSCORM2004ExportTableGUI\__construct(), ilSurveyExportTableGUI\__construct(), ilSurveyQuestionPoolExportTableGUI\__construct(), ilSurveyQuestionsTableGUI\__construct(), ilSubscriberTableGUI\__construct(), ilSurveyCodesTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilSurveyQuestionblockbrowserTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilCalendarChangedAppointmentsTableGUI\__construct(), ilSurveyQuestionbrowserTableGUI\__construct(), ilTestQuestionsTableGUI\__construct(), ilSessionParticipantsTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilAuthLoginPageEditorTableGUI\initTable(), ilSCORMTrackingUsersTableGUI\initTable(), ilConditionHandlerTableGUI\initTable(), and ilLPCollectionSettingsTableGUI\initTable().

{
if (!in_array($a_module_name,array_keys($this->enabled)))
{
return false;
}
$this->enabled[$a_module_name] = true;
}

+ Here is the caller graph for this function:

ilTableGUI::getBase ( )

Get Base script name (deprecated, only use this for workarounds).

Returns
string Base script name (deprecated, only use this for workarounds)

Definition at line 788 of file class.ilTableGUI.php.

References $base.

Referenced by render().

{
return $this->base;
}

+ Here is the caller graph for this function:

ilTableGUI::getColumnCount ( )

Returns the column count based on the number of the header row columns public.

Returns
int Number of columns

Definition at line 212 of file class.ilTableGUI.php.

References $column_count.

Referenced by ilTable2GUI\fillFooter(), and render().

{
}

+ Here is the caller graph for this function:

ilTableGUI::getData ( )

Reimplemented in ilTable2GUI.

Definition at line 145 of file class.ilTableGUI.php.

References $data.

{
return $this->data;
}
ilTableGUI::getFormName ( )

Reimplemented in ilTable2GUI.

Definition at line 798 of file class.ilTableGUI.php.

References $form_name.

Referenced by render().

{
}

+ Here is the caller graph for this function:

ilTableGUI::getLimit ( )

Get limit.

Reimplemented in ilTable2GUI.

Definition at line 299 of file class.ilTableGUI.php.

References $limit.

{
return $this->limit;
}
ilTableGUI::getOffset ( )

Get offset.

Reimplemented in ilTable2GUI.

Definition at line 328 of file class.ilTableGUI.php.

References $offset.

{
return $this->offset;
}
ilTableGUI::getOrderColumn ( )

Get order column.

Definition at line 369 of file class.ilTableGUI.php.

References $order_column.

{
}
ilTableGUI::getSelectAllCheckbox ( )

Reimplemented in ilTable2GUI.

Definition at line 818 of file class.ilTableGUI.php.

References $select_all_checkbox.

Referenced by render().

+ Here is the caller graph for this function:

ilTableGUI::getStyle (   $a_element)

Definition at line 768 of file class.ilTableGUI.php.

Referenced by render(), and ilTable2GUI\render().

{
return $this->styles[$a_element];
}

+ Here is the caller graph for this function:

& ilTableGUI::getTemplateObject ( )

Definition at line 127 of file class.ilTableGUI.php.

References $tpl.

{
return $this->tpl;
}
ilTableGUI::ilTableGUI (   $a_data = 0,
  $a_global_tpl = true 
)

Constructor.

Parameters
arraycontent data (optional)
booleanuse global template (default) public

Definition at line 87 of file class.ilTableGUI.php.

References $lng, $tpl, and setData().

{
global $ilias, $tpl, $lng;
$this->global_tpl = $a_global_tpl;
$this->ilias =& $ilias;
$this->header_vars = array();
$this->header_params = array();
$this->enabled["form"] = true;
$this->action_buttons = array();
if ($this->global_tpl)
{
$this->tpl =& $tpl;
}
else
{
$this->tpl = new ilTemplate("tpl.table.html", true, true, "Services/Table");
}
$this->lng =& $lng;
if (!$this->lng)
{
$this->lang_support = false;
}
$this->setData($a_data);
}

+ Here is the call graph for this function:

ilTableGUI::render ( )

render table public

Reimplemented in ilTable2GUI, and ilMediaPoolTableGUI.

Definition at line 466 of file class.ilTableGUI.php.

References $_SESSION, $base, $limit, $max_count, getBase(), getColumnCount(), getFormName(), ilUtil\getImagePath(), getSelectAllCheckbox(), getStyle(), ilUtil\Linkbar(), renderHeader(), setMaxCount(), sortData(), and ilUtil\switchColor().

{
if($this->enabled['table'])
{
$this->tpl->setVariable("CSS_TABLE",$this->getStyle("table"));
}
// table title icon
if ($this->enabled["icon"] && $this->enabled["title"])
{
$this->tpl->setCurrentBlock("tbl_header_title_icon");
$this->tpl->setVariable("TBL_TITLE_IMG",ilUtil::getImagePath($this->icon));
$this->tpl->setVariable("TBL_TITLE_IMG_ALT",$this->icon_alt);
$this->tpl->parseCurrentBlock();
}
// table title help
if ($this->enabled["help"] && $this->enabled["title"])
{
$this->tpl->setCurrentBlock("tbl_header_title_help");
$this->tpl->setVariable("TBL_HELP_IMG",ilUtil::getImagePath($this->help_icon));
$this->tpl->setVariable("TBL_HELP_LINK",$this->help_page);
$this->tpl->setVariable("TBL_HELP_IMG_ALT",$this->help_icon_alt);
$this->tpl->parseCurrentBlock();
}
// hits per page selector
if ($this->enabled["hits"] && $this->enabled["title"])
{
$this->tpl->setCurrentBlock("tbl_header_hits_page");
$this->tpl->setVariable("LIMIT",$_SESSION["tbl_limit"]);
$this->tpl->setVariable("HITS_PER_PAGE",$this->lng->txt("hits_per_page"));
$this->tpl->parseCurrentBlock();
}
// table title
if ($this->enabled["title"])
{
$this->tpl->setCurrentBlock("tbl_header_title");
$this->tpl->setVariable("COLUMN_COUNT",$this->column_count);
$this->tpl->setVariable("TBL_TITLE",$this->title);
$this->tpl->parseCurrentBlock();
}
// table header
if ($this->enabled["header"])
{
$this->renderHeader();
}
// table data
// the table content may be skipped to use an individual template blockfile
// To do so don't set $this->data and parse your table content by yourself
// The template block name for the blockfile MUST be 'TBL_CONTENT'
if ($this->enabled["content"] && is_array($this->data))
{
if($this->enabled['auto_sort'])
{
$this->setMaxCount(count($this->data));
$this->sortData();
}
$count = 0;
foreach ($this->data as $tbl_content_row)
{
foreach ($tbl_content_row as $key => $tbl_content_cell)
{
if (is_array($tbl_content_cell))
{
$this->tpl->setCurrentBlock("tbl_cell_subtitle");
$this->tpl->setVariable("TBL_CELL_SUBTITLE",$tbl_content_cell[1]);
$this->tpl->parseCurrentBlock();
$tbl_content_cell = "<b>".$tbl_content_cell[0]."</b>";
}
$this->tpl->setCurrentBlock("tbl_content_cell");
$this->tpl->setVariable("TBL_CONTENT_CELL",$tbl_content_cell);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("tbl_content_row");
$rowcolor = ilUtil::switchColor($count,"tblrow1","tblrow2");
$this->tpl->setVariable("ROWCOLOR", $rowcolor);
$this->tpl->parseCurrentBlock();
$count++;
}
}
// select all checkbox
if ($this->enabled["select_all"])
{
if ((strlen($this->getFormName())) && (strlen($this->getSelectAllCheckbox())))
{
$this->tpl->setVariable('SELECT_PREFIX',$this->prefix);
$this->tpl->setVariable("SELECT_ALL_TXT_SELECT_ALL", $this->lng->txt("select_all"));
$this->tpl->setVariable("SELECT_ALL_CHECKBOX_NAME", $this->getSelectAllCheckbox());
$this->tpl->setVariable("SELECT_ALL_FORM_NAME", $this->getFormName());
if (!($this->enabled["numinfo"] && $this->enabled["footer"]))
{
$this->tpl->setVariable("COLUMN_COUNT", $this->getColumnCount());
}
}
}
// table header numinfo
if ($this->enabled["numinfo_header"])
{
$start = $this->offset + 1; // compute num info
$end = $this->offset + $this->limit;
if ($end > $this->max_count or $this->limit == 0)
{
}
if ($this->lang_support)
{
$numinfo = "(".$this->lng->txt("dataset")." ".$start." - ".$end." ".strtolower($this->lng->txt("of"))." ".$this->max_count.")";
}
else
{
$numinfo = "(Dataset ".$start." - ".$end." of ".$this->max_count.")";
}
if ($this->max_count > 0)
{
//$numinfo = $this->lng->txt("no_datasets");
$this->tpl->setCurrentBlock("tbl_header_numinfo");
$this->tpl->setVariable("NUMINFO_HEADER", $numinfo);
$this->tpl->setVariable("COLUMN_COUNT_HEADER", $this->getColumnCount());
$this->tpl->parseCurrentBlock();
}
}
// table footer numinfo
if ($this->enabled["numinfo"] && $this->enabled["footer"])
{
$start = $this->offset + 1; // compute num info
$end = $this->offset + $this->limit;
if ($end > $this->max_count or $this->limit == 0)
{
}
if ($this->lang_support)
{
$numinfo = "(".$this->lng->txt("dataset")." ".$start." - ".$end." ".strtolower($this->lng->txt("of"))." ".$this->max_count.")";
}
else
{
$numinfo = "(Dataset ".$start." - ".$end." of ".$this->max_count.")";
}
if ($this->max_count > 0)
{
//$numinfo = $this->lng->txt("no_datasets");
$this->tpl->setCurrentBlock("tbl_footer_numinfo");
$this->tpl->setVariable("NUMINFO", $numinfo);
$this->tpl->parseCurrentBlock();
}
}
// table footer linkbar
if ($this->enabled["linkbar"] && $this->enabled["footer"] && $this->limit != 0
&& $this->max_count > 0)
{
$params = array(
$this->prefix."sort_by" => $this->header_vars[$this->order_column],
$this->prefix."sort_order" => $this->order_direction
);
$params = array_merge($this->header_params,$params);
$layout = array(
"link" => $this->footer_style,
"prev" => $this->footer_previous,
"next" => $this->footer_next,
);
$base = ($this->getBase() == "")
? basename($_SERVER["PHP_SELF"])
: $this->getBase();
$linkbar = ilUtil::Linkbar($base,$this->max_count,$this->limit,$this->offset,$params,$layout, $this->prefix);
$this->tpl->setCurrentBlock("tbl_footer_linkbar");
$this->tpl->setVariable("LINKBAR", $linkbar);
$this->tpl->parseCurrentBlock();
}
// table footer
if ($this->enabled["footer"] && $this->max_count > 0)
{
$this->tpl->setCurrentBlock("tbl_footer");
$this->tpl->setVariable("COLUMN_COUNT",$this->column_count);
$this->tpl->parseCurrentBlock();
}
// action buttons
if ($this->enabled["action"])
{
foreach ($this->action_buttons as $button)
{
$this->tpl->setCurrentBlock("tbl_action_btn");
$this->tpl->setVariable("BTN_NAME", $button["name"]);
$this->tpl->setVariable("BTN_VALUE", $button["value"]);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("tbl_action_row");
$this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.gif"));
$this->tpl->setVariable("ALT_ARROW", $this->lng->txt("arrow_downright.gif"));
$this->tpl->setVariable("COLUMN_COUNTS", $this->getColumnCount());
$this->tpl->parseCurrentBlock();
}
if ($this->enabled["form"])
{
$this->tpl->touchBlock("tbl_form_footer");
}
if($this->enabled['table'])
{
$this->tpl->touchBlock("tbl_table_end");
}
if (!$this->global_tpl)
{
return $this->tpl->get();
}
}

+ Here is the call graph for this function:

ilTableGUI::renderHeader ( )

Definition at line 692 of file class.ilTableGUI.php.

References $lang_support, ilUtil\getImagePath(), and setOrderLink().

Referenced by render().

{
foreach ($this->header_names as $key => $tbl_header_cell)
{
if (!$this->enabled["sort"])
{
$this->tpl->setCurrentBlock("tbl_header_no_link");
if ($this->column_width[$key])
{
$this->tpl->setVariable("TBL_COLUMN_WIDTH_NO_LINK"," width=\"".$this->column_width[$key]."\"");
}
$this->tpl->setVariable("TBL_HEADER_CELL_NO_LINK",$tbl_header_cell);
$this->tpl->parseCurrentBlock();
continue;
}
if (($key == $this->order_column) && ($this->order_direction != ""))
{
if (strcmp($this->header_vars[$key], "") != 0)
{
$this->tpl->setCurrentBlock("tbl_order_image");
$this->tpl->setVariable("IMG_ORDER_DIR",ilUtil::getImagePath($this->order_direction."_order.gif"));
$this->tpl->parseCurrentBlock();
}
}
$this->tpl->setCurrentBlock("tbl_header_cell");
$this->tpl->setVariable("TBL_HEADER_CELL",$tbl_header_cell);
// only set width if a value is given for that column
if ($this->column_width[$key])
{
$this->tpl->setVariable("TBL_COLUMN_WIDTH"," width=\"".$this->column_width[$key]."\"");
}
$lng_sort_column = ($this->lang_support) ? $this->lng->txt("sort_by_this_column") : "Sort by this column";
$this->tpl->setVariable("TBL_ORDER_ALT",$lng_sort_column);
$order_dir = "asc";
if ($key == $this->order_column)
{
$order_dir = $this->sort_order;
$lng_change_sort = ($this->lang_support) ? $this->lng->txt("change_sort_direction") : "Change sort direction";
$this->tpl->setVariable("TBL_ORDER_ALT",$lng_change_sort);
}
$this->setOrderLink($key, $order_dir);
$this->tpl->parseCurrentBlock();
}
$this->tpl->setCurrentBlock("tbl_header");
$this->tpl->parseCurrentBlock();
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

ilTableGUI::setBase (   $a_base)

Set Base script name (deprecated, only use this for workarounds).

Parameters
string$a_baseBase script name (deprecated, only use this for workarounds)

Definition at line 778 of file class.ilTableGUI.php.

{
$this->base = $a_base;
}
ilTableGUI::setColumnWidth (   $a_column_width)

set table column widths public

Parameters
arraycolumn widths

Definition at line 247 of file class.ilTableGUI.php.

{
$this->column_width = $a_column_width;
}
ilTableGUI::setData (   $a_data)

set table data public

Parameters
arraytable data

Reimplemented in ilTable2GUI.

Definition at line 137 of file class.ilTableGUI.php.

Referenced by ilTableGUI().

{
if (is_array($a_data))
{
$this->data = $a_data;
}
}

+ Here is the caller graph for this function:

ilTableGUI::setFooter (   $a_style,
  $a_previous = 0,
  $a_next = 0 
)

set order direction public

Parameters
stringcss format for links
stringvalue of previous link
stringvalue of next link

Definition at line 408 of file class.ilTableGUI.php.

Referenced by ilShoppingCartTableGUI\getCartHTML(), and ilTable2GUI\getHTML().

{
$this->footer_style = $a_style;
$this->footer_previous = ($a_previous) ? $a_previous : "<<<";
$this->footer_next = ($a_next) ? $a_next : ">>>";
}

+ Here is the caller graph for this function:

ilTableGUI::setFormName (   $a_name = "cmd")

Reimplemented in ilTable2GUI.

Definition at line 808 of file class.ilTableGUI.php.

{
$this->form_name = $a_name;
}
ilTableGUI::setHeaderNames (   $a_header_names)

set table header names public

Parameters
arraytable header names

Definition at line 201 of file class.ilTableGUI.php.

{
$this->header_names = $a_header_names;
$this->column_count = count($this->header_names);
}
ilTableGUI::setHeaderVars (   $a_header_vars,
  $a_header_params = 0 
)

set table header vars public

Parameters
arraytable header vars
arrayadditional link params

Definition at line 223 of file class.ilTableGUI.php.

{
$this->header_vars = $a_header_vars;
if ($a_header_params == 0 or !is_array($a_header_params))
{
$this->link_params = "";
}
else
{
$this->header_params = $a_header_params; // temp. solution for linkbar
foreach ($a_header_params as $key => $val)
{
$this->link_params .= $key."=".$val."&";
}
}
}
ilTableGUI::setHelp (   $a_help_page,
  $a_help_icon,
  $a_help_icon_alt = 0 
)

set table help page public

Parameters
stringhelp page file name
stringfile name of help icon
stringalternative text for help icon

Definition at line 184 of file class.ilTableGUI.php.

References $help_icon.

{
$this->help_page = $a_help_page;
$this->help_icon = $a_help_icon;
$this->help_icon_alt = $a_help_icon_alt;
if (!$this->help_icon_alt)
{
$this->help_icon_alt = $this->help_icon;
}
}
ilTableGUI::setLimit (   $a_limit = 0,
  $a_default_limit = 0 
)

set max.

datasets displayed per page public

Parameters
integerlimit
integerdefault limit

Definition at line 286 of file class.ilTableGUI.php.

Referenced by ilCourseGroupingAssignmentTableGUI\__construct(), iliLinkConfirmationTableGUI\__construct(), iliLinkMembersTableGUI\__construct(), ilObjWorkspaceFolderTableGUI\__construct(), ilScormSpecialPagesTableGUI\__construct(), ilBenchmarkTableGUI\__construct(), ilTrUserObjectsPropsTableGUI\__construct(), ilLanguageTableGUI\__construct(), ilObjectTranslationTableGUI\__construct(), ilClientListTableGUI\__construct(), ilImportantPagesTableGUI\__construct(), ilSearchResultTableGUI\__construct(), ilExcDeliveredFilesTableGUI\__construct(), ilSkillSelfEvalSkillTableGUI\__construct(), ilPasteStyleCharacteristicTableGUI\__construct(), ilUploadDirFilesTableGUI\__construct(), ilLPObjectsTableGUI\__construct(), ilLPObjectStatisticsTypesTableGUI\__construct(), ilAccessKeyTableGUI\__construct(), ilLPProgressTableGUI\__construct(), ilTrSummaryTableGUI\__construct(), ilLMPagesTableGUI\__construct(), ilPluginsOverviewTableGUI\__construct(), ilConfirmationTableGUI\__construct(), ilSetupLanguageTableGUI\__construct(), ilAssignmentsTableGUI\__construct(), ilPCIIMPopupTableGUI\__construct(), ilRepDependenciesTableGUI\__construct(), ilSkillLevelTableGUI\__construct(), ilStyleTableGUI\__construct(), ilUserFieldSettingsTableGUI\__construct(), ilCustomUserFieldSettingsTableGUI\__construct(), ilSelfEvaluationSimpleTableGUI\__construct(), ilSkillAssignMaterialsTableGUI\__construct(), ilBookingObjectsTableGUI\__construct(), ilTrMatrixTableGUI\__construct(), ilCourseParticipantsGroupsTableGUI\__construct(), ilObjectCopySelectionTableGUI\__construct(), ilRbacLogTableGUI\__construct(), ilSurveyQuestionTableGUI\__construct(), ilExportSelectionTableGUI\__construct(), ilObjectRoleTemplateOptionsTableGUI\__construct(), ilObjectRoleTemplatePermissionTableGUI\__construct(), ilWebResourceLinkTableGUI\__construct(), ilObjectRolePermissionTableGUI\__construct(), ilCourseObjectiveQuestionsTableGUI\__construct(), ilQuestionPoolPrintViewTableGUI\__construct(), ilLuceneAdvancedSearchActivationTableGUI\__construct(), ilListOfQuestionsTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilCourseObjectiveMaterialAssignmentTableGUI\__construct(), ilCourseObjectiveQuestionAssignmentTableGUI\__construct(), ilTable2GUI\determineLimit(), ilComponentsTableGUI\ilComponentsTableGUI(), ilPCFileListTableGUI\ilPCFileListTableGUI(), ilPCTabsTableGUI\ilPCTabsTableGUI(), ilPluginsTableGUI\ilPluginsTableGUI(), ilSubItemSelectionTableGUI\ilSubItemSelectionTableGUI(), ilWikiSearchResultsTableGUI\ilWikiSearchResultsTableGUI(), and ilLinkCheckerTableGUI\prepareHTML().

{
$this->limit = ($a_limit) ? $a_limit : $a_default_limit;
if ($this->limit == 0)
{
$this->max_limit = true;
}
}

+ Here is the caller graph for this function:

ilTableGUI::setOffset (   $a_offset)

set dataset offset public

Parameters
integeroffset

Definition at line 320 of file class.ilTableGUI.php.

Referenced by ilTable2GUI\determineOffsetAndOrder(), and ilTable2GUI\resetOffset().

{
$this->offset = ($a_offset) ? $a_offset : 0;
}

+ Here is the caller graph for this function:

ilTableGUI::setOneColumnWidth (   $a_column_width,
  $a_column_number 
)

set one table column width public

Parameters
stringcolumn width
integercolumn number

Definition at line 258 of file class.ilTableGUI.php.

{
$this->column_width[$a_column_number] = $a_column_width;
}
ilTableGUI::setOrderColumn (   $a_order_column = 0,
  $a_default_column = 0 
)

set order column public

Parameters
stringorder column
stringdefault column

Definition at line 339 of file class.ilTableGUI.php.

{
// set default sort column to first column
if (empty($a_order_column))
{
if (!empty($a_default_column))
{
$this->order_column = array_search($a_default_column,$this->header_vars);
}
else
{
$this->order_column = 0;
return;
}
}
else
{
$this->order_column = array_search($a_order_column,$this->header_vars);
}
if ($this->order_column === false)
{
// if not found, set default sort column to first column
$this->order_column = 0;
}
}
ilTableGUI::setOrderDirection (   $a_order_direction)

set order direction public

Parameters
stringorder direction

Definition at line 379 of file class.ilTableGUI.php.

Referenced by ilTable2GUI\determineOffsetAndOrder().

{
if ($a_order_direction == "desc")
{
$this->order_direction = "desc";
$this->sort_order = "asc";
}
else
{
$this->order_direction = "asc"; // set default sort order to "ASC"
$this->sort_order = "desc";
}
}

+ Here is the caller graph for this function:

ilTableGUI::setOrderLink (   $key,
  $order_dir 
)

Reimplemented in ilTable2GUI.

Definition at line 747 of file class.ilTableGUI.php.

Referenced by renderHeader().

{
$this->tpl->setVariable("TBL_ORDER_LINK",basename($_SERVER["PHP_SELF"])."?".$this->link_params.$this->prefix."sort_by=".$this->header_vars[$key]."&".$this->prefix."sort_order=".$order_dir."&".$this->prefix."offset=".$this->offset);
}

+ Here is the caller graph for this function:

ilTableGUI::setPrefix (   $a_prefix)

set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) public

Parameters
stringprefix

Reimplemented in ilTable2GUI.

Definition at line 310 of file class.ilTableGUI.php.

{
$this->prefix = ($a_prefix) ? $a_prefix : "";
}
ilTableGUI::setSelectAllCheckbox (   $a_select_all_checkbox)

Reimplemented in ilTable2GUI.

Definition at line 828 of file class.ilTableGUI.php.

{
$this->select_all_checkbox = $a_select_all_checkbox;
}
ilTableGUI::setStyle (   $a_element,
  $a_style 
)

Definition at line 758 of file class.ilTableGUI.php.

Referenced by ilQuestionBrowserTableGUI\__construct(), ilEvaluationAllTableGUI\__construct(), ilSurveyMaterialsTableGUI\__construct(), ilSurveyInvitedUsersTableGUI\__construct(), ilAssessmentFolderLogTableGUI\__construct(), ilAssessmentFolderLogAdministrationTableGUI\__construct(), ilTestAggregatedResultsTableGUI\__construct(), ilTestAverageReachedPointsTableGUI\__construct(), ilTestInviteGroupsTableGUI\__construct(), ilTestInviteRolesTableGUI\__construct(), ilTestInviteUsersTableGUI\__construct(), ilSurveyResultsCumulatedTableGUI\__construct(), assFileUploadFileTableGUI\__construct(), ilTestFixedParticipantsTableGUI\__construct(), ilQuestionPoolPrintViewTableGUI\__construct(), ilListOfQuestionsTableGUI\__construct(), ilSurveyPhrasesTableGUI\__construct(), ilTestQuestionBrowserTableGUI\__construct(), ilSurveyResultsUserTableGUI\__construct(), ilSurveySavePhraseTableGUI\__construct(), ilTestHistoryTableGUI\__construct(), ilTestParticipantsTableGUI\__construct(), ilSurveyCodesTableGUI\__construct(), ilSurveyCodesMailTableGUI\__construct(), ilSCORM2004ExportTableGUI\__construct(), ilSurveyExportTableGUI\__construct(), ilSurveyQuestionsTableGUI\__construct(), ilSurveyMaintenanceTableGUI\__construct(), ilTestExportTableGUI\__construct(), ilSurveyQuestionPoolExportTableGUI\__construct(), ilSurveyQuestionblockbrowserTableGUI\__construct(), ilSurveyQuestionbrowserTableGUI\__construct(), and ilTestQuestionsTableGUI\__construct().

{
$this->styles[$a_element] = $a_style;
}

+ Here is the caller graph for this function:

ilTableGUI::setTemplate ( $a_tpl)

set template public

Parameters
objecttemplate object

Definition at line 122 of file class.ilTableGUI.php.

{
$this->tpl =& $a_tpl;
}
ilTableGUI::setTitle (   $a_title,
  $a_icon = 0,
  $a_icon_alt = 0 
)

set table title public

Parameters
stringtable title
stringfile name of title icon
stringalternative text for title icon

Reimplemented in ilTable2GUI.

Definition at line 157 of file class.ilTableGUI.php.

References $icon.

{
$this->title = $a_title;
$this->icon = $a_icon;
$this->icon_alt = $a_icon_alt;
if (!$this->icon)
{
$this->enabled["icon"] = false;
return;
}
if (!$this->icon_alt)
{
$this->icon_alt = $this->icon;
}
$this->enabled["icon"] = true;
}
ilTableGUI::sortData ( )

Definition at line 453 of file class.ilTableGUI.php.

References ilUtil\sortArray().

Referenced by render().

{
if($this->enabled["sort"])
{
$this->data = ilUtil::sortArray($this->data,$this->order_column,$this->order_direction);
}
$this->data = array_slice($this->data,$this->offset,$this->limit);
}

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Field Documentation

ilTableGUI::$action_buttons

Definition at line 52 of file class.ilTableGUI.php.

ilTableGUI::$base = ""

Definition at line 55 of file class.ilTableGUI.php.

Referenced by ilLPTableBaseGUI\buildValueScale(), getBase(), and render().

ilTableGUI::$column_count

Definition at line 34 of file class.ilTableGUI.php.

Referenced by getColumnCount().

ilTableGUI::$column_width

Definition at line 35 of file class.ilTableGUI.php.

Referenced by ilObjectRolePermissionTableGUI\initColumns().

ilTableGUI::$data

Definition at line 32 of file class.ilTableGUI.php.

Referenced by ilCourseStartObjectsTableGUI\__construct(), ilImportantPagesTableGUI\__construct(), ilAccessKeyTableGUI\__construct(), ilAssignmentsTableGUI\__construct(), ilExGradesTableGUI\__construct(), ilExParticipantTableGUI\__construct(), ilCourseGroupingAssignmentTableGUI\__formatPath(), ilSurveySyncTableGUI\buildPath(), ilCalendarCategoryTableGUI\buildPath(), ilCalendarManageTableGUI\buildPath(), ilLPTableBaseGUI\buildPath(), ilMailFolderTableGUI\fetchTableData(), ilSurveyMaterialsTableGUI\fillRow(), ilTestAggregatedResultsTableGUI\fillRow(), ilObjectivesAlignmentTableGUI\fillRow(), ilSurveySavePhraseTableGUI\fillRow(), ilAssessmentFolderLogTableGUI\fillRow(), ilTestHistoryTableGUI\fillRow(), ilTestInviteGroupsTableGUI\fillRow(), ilTestInviteRolesTableGUI\fillRow(), ilSurveyInvitedUsersTableGUI\fillRow(), ilCourseObjectivesTableGUI\fillRow(), ilTestInviteUsersTableGUI\fillRow(), ilAssessmentFolderLogAdministrationTableGUI\fillRow(), ilListOfQuestionsTableGUI\fillRow(), ilTestAverageReachedPointsTableGUI\fillRow(), ilSurveyResultsUserTableGUI\fillRow(), ilSurveyPhrasesTableGUI\fillRow(), ilSCORM2004ExportTableGUI\fillRow(), ilSurveyQuestionPoolExportTableGUI\fillRow(), ilSurveyMaintenanceTableGUI\fillRow(), ilSurveyCodesTableGUI\fillRow(), ilSurveyExportTableGUI\fillRow(), ilSurveyQuestionblockbrowserTableGUI\fillRow(), ilTestParticipantsTableGUI\fillRow(), ilQuestionPoolPrintViewTableGUI\fillRow(), ilTestFixedParticipantsTableGUI\fillRow(), ilTestExportTableGUI\fillRow(), ilSurveyCodesMailTableGUI\fillRow(), ilTestQuestionsTableGUI\fillRow(), ilSurveyResultsCumulatedTableGUI\fillRow(), ilTestQuestionBrowserTableGUI\fillRow(), ilSurveyQuestionbrowserTableGUI\fillRow(), ilSurveyQuestionsTableGUI\fillRow(), ilEvaluationAllTableGUI\fillRow(), ilQuestionBrowserTableGUI\fillRow(), ilTrMatrixTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), ilTrObjectUsersPropsTableGUI\fillRow(), ilShoppingCartTableGUI\getCartHTML(), getData(), ilBenchmarkTableGUI\getDataByFirstTable(), ilLPTableBaseGUI\getExportMeta(), ilTable2GUI\getHTML(), ilTestVerificationTableGUI\getItems(), ilExerciseVerificationTableGUI\getItems(), ilBookingSchedulesTableGUI\getItems(), ilCourseGroupingAssignmentTableGUI\getItems(), ilCourseGroupingTableGUI\getItems(), ilPortfolioPageTableGUI\getItems(), ilLPObjectStatisticsAdminTableGUI\getItems(), ilBookingTypesTableGUI\getItems(), ilBookingObjectsTableGUI\getItems(), ilPortfolioTableGUI\getItems(), ilLPObjectsTableGUI\getItems(), ilRbacLogTableGUI\getItems(), ilLPObjectStatisticsTypesTableGUI\getItems(), ilLanguageTableGUI\getItems(), ilOrgUnitAssignmentTableGUI\getItems(), ilLPProgressTableGUI\getItems(), ilBookingReservationsTableGUI\getItems(), ilLPObjectStatisticsDailyTableGUI\getItems(), ilLPObjectStatisticsTableGUI\getItems(), ilTrMatrixTableGUI\getItems(), ilTrSummaryTableGUI\getItems(), ilTrSummaryTableGUI\getItemsPercentages(), ilTrSummaryTableGUI\getItemsPercentagesStatus(), ilCourseStartObjectsTableGUI\getPossibleObjects(), ilCopySelfAssQuestionTableGUI\getQuestions(), ilCourseStartObjectsTableGUI\getStartObjects(), ilWorkspaceAccessTableGUI\importData(), ilWorkspaceShareTableGUI\importData(), ilSurveyQuestionTableGUI\importData(), ilImageMapTableGUI\initActions(), ilPCIIMTriggerTableGUI\initActions(), ilSCORMTrackingItemsPerScoTableGUI\parse(), ilSCORMTrackingUsersTableGUI\parse(), ilDidacticTemplateSettingsTableGUI\parse(), ilSCORMTrackingItemsPerUserTableGUI\parse(), ilSCORMTrackingItemsScoTableGUI\parse(), ilOpenIdProviderTableGUI\parse(), ilSCORMTrackingItemPerUserTableGUI\parse(), ilCalendarSharedListTableGUI\parse(), ilConsultationHoursTableGUI\parse(), ilCalendarInboxSharedTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilLPCollectionSettingsTableGUI\parseCollection(), ilAdvancedMDRecordExportFilesTableGUI\parseFiles(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilLPCollectionSettingsTableGUI\parseScormCollection(), ilRepositoryUserResultTableGUI\parseUserIds(), ilSubscriberTableGUI\readSubscriberData(), ilTrSummaryTableGUI\renderPercentages(), and ilTable2GUI\restoreTemplate().

ilTableGUI::$enabled
Initial value:
array( "table" => true,
"title" => true,
"icon" => true,
"help" => false,
"content" => true,
"action" => false,
"header" => true,
"footer" => true,
"linkbar" => true,
"numinfo" => true,
"numinfo_header" => false,
"sort" => true,
"hits" => false,
"auto_sort" => true,
"select_all" => false
)

Definition at line 58 of file class.ilTableGUI.php.

ilTableGUI::$footer_next

Definition at line 46 of file class.ilTableGUI.php.

ilTableGUI::$footer_previous

Definition at line 45 of file class.ilTableGUI.php.

ilTableGUI::$footer_style

Definition at line 44 of file class.ilTableGUI.php.

ilTableGUI::$form_name

Definition at line 50 of file class.ilTableGUI.php.

Referenced by getFormName().

ilTableGUI::$global_tpl

Definition at line 49 of file class.ilTableGUI.php.

ilTableGUI::$header_names

Definition at line 28 of file class.ilTableGUI.php.

ilTableGUI::$header_vars

Definition at line 29 of file class.ilTableGUI.php.

ilTableGUI::$help_icon

Definition at line 25 of file class.ilTableGUI.php.

Referenced by setHelp().

ilTableGUI::$help_icon_alt

Definition at line 26 of file class.ilTableGUI.php.

ilTableGUI::$help_page

Definition at line 24 of file class.ilTableGUI.php.

ilTableGUI::$icon_alt

Definition at line 22 of file class.ilTableGUI.php.

Referenced by ilWorkspaceAccessTableGUI\importData().

ilTableGUI::$lang_support = true

Definition at line 48 of file class.ilTableGUI.php.

Referenced by renderHeader().

ilTableGUI::$linkbar_vars

Definition at line 30 of file class.ilTableGUI.php.

ilTableGUI::$max_count

Definition at line 37 of file class.ilTableGUI.php.

Referenced by ilTable2GUI\fillFooter(), render(), and setMaxCount().

ilTableGUI::$max_limit = false

Definition at line 39 of file class.ilTableGUI.php.

ilTableGUI::$offset

Definition at line 40 of file class.ilTableGUI.php.

Referenced by getOffset().

ilTableGUI::$order_column

Definition at line 41 of file class.ilTableGUI.php.

Referenced by getOrderColumn().

ilTableGUI::$order_direction

Definition at line 42 of file class.ilTableGUI.php.

Referenced by getOrderDirection().

ilTableGUI::$select_all_checkbox

Definition at line 51 of file class.ilTableGUI.php.

Referenced by getSelectAllCheckbox(), and ilTable2GUI\getSelectAllCheckbox().

ilTableGUI::$styles
Initial value:
array(
"table" => "fullwidth"
)

Definition at line 76 of file class.ilTableGUI.php.


The documentation for this class was generated from the following file: