Inheritance diagram for ilTableGUI:

Collaboration diagram for ilTableGUI:

Public Member Functions
	__construct ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate ($a_tpl)
	set template @access public More...

&	getTemplateObject ()

	setData ($a_data)
	set table data @access public More...

	getData ()

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	set table title @access public More...

	setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
	set table help page @access public More...

	setHeaderNames ($a_header_names)
	set table header names @access public More...

	getColumnCount ()
	Returns the column count based on the number of the header row columns @access public. More...

	setHeaderVars ($a_header_vars, $a_header_params=0)
	set table header vars @access public More...

	setColumnWidth ($a_column_width)
	set table column widths @access public More...

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width @access public More...

	setMaxCount ($a_max_count)
	set max. More...

	setLimit ($a_limit=0, $a_default_limit=0)
	set max. More...

	getLimit ()
	Get limit. More...

	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) @access public More...

	setOffset ($a_offset)
	set dataset offset @access public More...

	getOffset ()
	Get offset. More...

	setOrderColumn ($a_order_column=0, $a_default_column=0)
	set order column @access public More...

	getOrderColumn ()
	Get order column. More...

	setOrderDirection ($a_order_direction)
	set order direction @access public More...

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction @access public More...

	enable ($a_module_name)
	enables particular modules of table More...

	disable ($a_module_name)
	diesables particular modules of table More...

	sortData ()

	render ()
	render table @access public More...

	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). More...

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

	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

Protected Attributes
	$tpl

	$lng

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$

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

Constructor & Destructor Documentation

◆ __construct()

ilTableGUI::__construct	(	$a_data = `0`,
		$a_global_tpl = `true`
	)

Constructor.

Parameters

array	content data (optional)
boolean	use global template (default) @access public

Reimplemented in ilExportSelectionTableGUI, ilRoleTableGUI, ilCourseObjectiveQuestionsTableGUI, ilCourseObjectivesTableGUI, ilCategoryAssignRoleTableGUI, ilTermQuickListTableGUI, ilItemGroupItemsTableGUI, ilPollAnswerTableGUI, ilPollUserTableGUI, ilSessionMaterialsTableGUI, ilSurveyCodesEditTableGUI, ilSurveyCodesTableGUI, ilSurveyInvitedUsersTableGUI, ilSurveySavePhraseTableGUI, ilAssessmentFolderLogTableGUI, ilListOfQuestionsTableGUI, ilParticipantsTestResultsTableGUI, ilTestAggregatedResultsTableGUI, ilTestAverageReachedPointsTableGUI, ilTestHistoryTableGUI, ilTestInviteGroupsTableGUI, ilTestInviteRolesTableGUI, ilTestInviteUsersTableGUI, ilTestParticipantsTableGUI, ilTimingOverviewTableGUI, ilWebResourceEditableLinkTableGUI, ilImportantPagesTableGUI, ilAccessPermissionsStatusTableGUI, ilAvailableRolesStatusTableGUI, ilRoleAdoptPermissionTableGUI, ilRoleSelectionTableGUI, ilAccessKeyTableGUI, ilCalendarChangedAppointmentsTableGUI, ilCalendarInboxSharedTableGUI, ilClipboardTableGUI, ilPageMultiLangTableGUI, ilPageLayoutTableGUI, ilObjectConsumerTableGUI, ilMailAttachmentTableGUI, ilMobMultiSrtConfirmationTable2GUI, ilMultiSrtConfirmationTable2GUI, ilObjectCustomUserFieldsTableGUI, ilObjClipboardTableGUI, ilRendererTableGUI, ilRegistrationCodesTableGUI, ilTrashTableGUI, ilPersonalSkillTableGUI, ilSelfEvaluationTableGUI, ilPasteStyleCharacteristicTableGUI, ilSystemStylesTableGUI, ilLPObjectStatisticsAdminTableGUI, ilAccountCodesTableGUI, ilRoleAssignmentTableGUI, ilUserFieldSettingsTableGUI, ilECSCategoryMappingTableGUI, ilForumStatisticsTableGUI, ilSCORM2004TrackingTableGUI, ilFoundUsersTableGUI, ilSpecialUsersTableGUI, ilResultsByQuestionTableGUI, ilAuthLoginPageEditorTableGUI, ilComponentsTableGUI, ilPluginsOverviewTableGUI, ilPageHistoryTableGUI, ilDidacticTemplateSettingsTableGUI, ilLogComponentTableGUI, ilSCGroupTableGUI, ilSCTreeDuplicatesTableGUI, ilECSServerTableGUI, ilCourseInfoFileTableGUI, ilSessionFileTableGUI, ilAdvancedMDRecordExportFilesTableGUI, ilShibbolethRoleAssignmentTableGUI, ilLDAPRoleAssignmentTableGUI, ilMDCopyrightUsageTableGUI, ilLuceneAdvancedSearchActivationTableGUI, ilECSImportedContentTableGUI, ilECSReleasedContentTableGUI, ilCourseEditParticipantsTableGUI, ilGroupEditParticipantsTableGUI, ilChatroomSmiliesTableGUI, ilTestPassOverviewTableGUI, ilOrgUnitTypeTableGUI, ilCalendarSharedListTableGUI, ilCalendarSharedRoleListTableGUI, ilCalendarSharedUserListTableGUI, and ilTestPassManualScoringOverviewTableGUI.

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

    {
        global $DIC;
 
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
 
        $this->global_tpl = $a_global_tpl;
        $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);
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ addActionButton()

ilTableGUI::addActionButton	(	$btn_name,
		$btn_value
	)

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

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

◆ clearActionButtons()

ilTableGUI::clearActionButtons ( )

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

    {
        $this->action_buttons = array();
    }

◆ disable()

ilTableGUI::disable ( $a_module_name )

diesables particular modules of table

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

@access public

Parameters

string module name

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

    {
        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:

◆ enable()

ilTableGUI::enable ( $a_module_name )

enables particular modules of table

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

@access public

Parameters

string module name

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

    {
        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:

◆ getBase()

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 732 of file class.ilTableGUI.php.

    {
        return $this->base;
    }

References $base.

Referenced by render().

Here is the caller graph for this function:

◆ getColumnCount()

ilTableGUI::getColumnCount ( )

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

Returns: int Number of columns

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

    {
        return $this->column_count;
    }

References $column_count.

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

Here is the caller graph for this function:

◆ getData()

ilTableGUI::getData ( )

Reimplemented in ilTable2GUI.

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

    {
        return $this->data;
    }

References $data.

◆ getFormName()

ilTableGUI::getFormName ( )

Reimplemented in ilTable2GUI.

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

    {
        return $this->form_name;
    }

References $form_name.

Referenced by render().

Here is the caller graph for this function:

◆ getLimit()

ilTableGUI::getLimit ( )

Get limit.

Reimplemented in ilTable2GUI.

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

    {
        return $this->limit;
    }

References $limit.

◆ getOffset()

ilTableGUI::getOffset ( )

Get offset.

Reimplemented in ilTable2GUI.

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

    {
        return $this->offset;
    }

References $offset.

◆ getOrderColumn()

ilTableGUI::getOrderColumn ( )

Get order column.

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

    {
        return $this->order_column;
    }

References $order_column.

◆ getOrderDirection()

ilTableGUI::getOrderDirection ( )

Get order direction.

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

    {
        return $this->order_direction;
    }

References $order_direction.

Here is the caller graph for this function:

◆ getSelectAllCheckbox()

ilTableGUI::getSelectAllCheckbox ( )

Reimplemented in ilTable2GUI.

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

    {
        return $this->select_all_checkbox;
    }

References $select_all_checkbox.

Referenced by render().

Here is the caller graph for this function:

◆ getStyle()

ilTableGUI::getStyle ( $a_element )

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

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

Referenced by ilDclTableListTableGUI\__construct(), ilDclFieldListTableGUI\__construct(), ilDclTableViewTableGUI\__construct(), and ilTable2GUI\render().

Here is the caller graph for this function:

◆ getTemplateObject()

& ilTableGUI::getTemplateObject ( )

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

    {
        return $this->tpl;
    }

References $tpl.

◆ render()

ilTableGUI::render ( )

render table @access public

Reimplemented in ilExerciseSubmissionTableGUI, ilMediaPoolTableGUI, arIndexTableGUI, ilBuddySystemRelationsTableGUI, and ilTable2GUI.

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

    {
        if ($this->enabled['table']) {
            $this->tpl->setVariable("CSS_TABLE", "table table-striped" /* $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) {
                $end = $this->max_count;
            }
            
            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) {
                $end = $this->max_count;
            }
            
            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"] && is_array($this->action_buttons)) {
            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.svg"));
            $this->tpl->setVariable("ALT_ARROW", $this->lng->txt("arrow_downright.svg"));
            $this->tpl->setVariable("COLUMN_COUNT", $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();
        }
    }

References $_SERVER, $_SESSION, $base, $end, $key, $limit, $max_count, PHPMailer\PHPMailer\$params, $start, data, getBase(), getColumnCount(), getFormName(), ilUtil\getImagePath(), getSelectAllCheckbox(), ilUtil\Linkbar(), renderHeader(), setMaxCount(), sortData(), and ilUtil\switchColor().

Here is the call graph for this function:

◆ renderHeader()

ilTableGUI::renderHeader ( )

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

    {
        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->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();
    }

References $key, $lang_support, and setOrderLink().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBase()

ilTableGUI::setBase ( $a_base )

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

Parameters

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

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

    {
        $this->base = $a_base;
    }

References base().

Here is the call graph for this function:

◆ setColumnWidth()

ilTableGUI::setColumnWidth ( $a_column_width )

set table column widths @access public

Parameters

array column widths

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

    {
        $this->column_width = $a_column_width;
    }

◆ setData()

ilTableGUI::setData ( $a_data )

set table data @access public

Parameters

array table data

Reimplemented in ilTable2GUI.

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

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

References data.

Referenced by __construct().

Here is the caller graph for this function:

◆ setFooter()

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

set order direction @access public

Parameters

string	css format for links
string	value of previous link
string	value of next link

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

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

Referenced by ilTable2GUI\getHTML().

Here is the caller graph for this function:

◆ setFormName()

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

Reimplemented in ilTable2GUI.

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

    {
        $this->form_name = $a_name;
    }

◆ setHeaderNames()

ilTableGUI::setHeaderNames ( $a_header_names )

set table header names @access public

Parameters

array table header names

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

    {
        $this->header_names = $a_header_names;
        $this->column_count = count($this->header_names);
    }

◆ setHeaderVars()

ilTableGUI::setHeaderVars	(	$a_header_vars,
		$a_header_params = `0`
	)

set table header vars @access public

Parameters

array	table header vars
array	additional link params

Definition at line 227 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 . "&";
            }
        }
    }

References $key.

◆ setHelp()

ilTableGUI::setHelp	(	$a_help_page,
		$a_help_icon,
		$a_help_icon_alt = `0`
	)

set table help page @access public

Parameters

string	help page file name
string	file name of help icon
string	alternative text for help icon

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

    {
        $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;
        }
    }

References $help_icon.

◆ setLimit()

ilTableGUI::setLimit	(	$a_limit = `0`,
		$a_default_limit = `0`
	)

set max.

datasets displayed per page @access public

Parameters

integer	limit
integer	default limit

Reimplemented in ilTable2GUI.

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

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

◆ setMaxCount()

ilTableGUI::setMaxCount ( $a_max_count )

set max.

count of database query you don't need to set max count if using integrated content rendering feature if max_limit is true, no limit is given -> set limit to max_count @access public

Parameters

integer max_count

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

    {
        $this->max_count = $a_max_count;
 
        if ($this->max_limit) {
            $this->limit = $this->max_count;
        }
    }

References $max_count.

Here is the caller graph for this function:

◆ setOffset()

ilTableGUI::setOffset ( $a_offset )

set dataset offset @access public

Parameters

integer offset

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

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

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

Here is the caller graph for this function:

◆ setOneColumnWidth()

ilTableGUI::setOneColumnWidth	(	$a_column_width,
		$a_column_number
	)

set one table column width @access public

Parameters

string	column width
integer	column number

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

    {
        $this->column_width[$a_column_number] = $a_column_width;
    }

◆ setOrderColumn()

ilTableGUI::setOrderColumn	(	$a_order_column = `0`,
		$a_default_column = `0`
	)

set order column @access public

Parameters

string	order column
string	default column

Definition at line 337 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;
        }
    }

Referenced by ilLTIProviderReleasedObjectsTableGUI\init(), ilObjectTableGUI\init(), and ilUserClipboardTableGUI\init().

Here is the caller graph for this function:

◆ setOrderDirection()

ilTableGUI::setOrderDirection ( $a_order_direction )

set order direction @access public

Parameters

string order direction

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

    {
        if (strtolower($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";
        }
    }

Referenced by ilTable2GUI\determineOffsetAndOrder(), and ilCalendarManageTableGUI\resetToDefaults().

Here is the caller graph for this function:

◆ setOrderLink()

ilTableGUI::setOrderLink	(	$key,
		$order_dir
	)

Reimplemented in ilTable2GUI.

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

    {
        $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);
    }

References $_SERVER, and $key.

Referenced by renderHeader().

Here is the caller graph for this function:

◆ setPrefix()

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) @access public

Parameters

string prefix

Reimplemented in ilTable2GUI.

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

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

◆ setSelectAllCheckbox()

ilTableGUI::setSelectAllCheckbox ( $a_select_all_checkbox )

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

    {
        $this->select_all_checkbox = $a_select_all_checkbox;
    }

◆ setStyle()

ilTableGUI::setStyle	(	$a_element,
		$a_style
	)

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

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

Here is the caller graph for this function:

◆ setTemplate()

ilTableGUI::setTemplate ( $a_tpl )

set template @access public

Parameters

object template object

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

    {
        $this->tpl = $a_tpl;
    }

◆ setTitle()

ilTableGUI::setTitle	(	$a_title,
		$a_icon = `0`,
		$a_icon_alt = `0`
	)

set table title @access public

Parameters

string	table title
string	file name of title icon
string	alternative text for title icon

Reimplemented in ilTable2GUI.

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

    {
        $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;
    }

References $icon.

◆ sortData()

ilTableGUI::sortData ( )

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

    {
        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);
    }

References data, and ilUtil\sortArray().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $action_buttons

ilTableGUI::$action_buttons

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

◆ $base

ilTableGUI::$base = ""

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

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

◆ $column_count

ilTableGUI::$column_count

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

Referenced by getColumnCount().

◆ $column_width

ilTableGUI::$column_width

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

Referenced by ilObjectRolePermissionTableGUI\initColumns().

◆ $data

ilTableGUI::$data

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

◆ $enabled

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 68 of file class.ilTableGUI.php.

◆ $footer_next

ilTableGUI::$footer_next

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

◆ $footer_previous

ilTableGUI::$footer_previous

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

◆ $footer_style

ilTableGUI::$footer_style

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

◆ $form_name

ilTableGUI::$form_name

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

Referenced by getFormName().

◆ $global_tpl

ilTableGUI::$global_tpl

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

◆ $header_names

ilTableGUI::$header_names

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

◆ $header_vars

ilTableGUI::$header_vars

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

◆ $help_icon

ilTableGUI::$help_icon

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

Referenced by setHelp().

◆ $help_icon_alt

ilTableGUI::$help_icon_alt

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

◆ $help_page

ilTableGUI::$help_page

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

◆ $icon

ilTableGUI::$icon

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

Referenced by ilTrMatrixTableGUI\__construct(), ilLPObjectStatisticsLPTableGUI\__construct(), ilMDCopyrightUsageTableGUI\fillRow(), ilSearchResultTableGUI\fillRow(), ilSkillCatTableGUI\fillRow(), ilStudyProgrammeTypeTableGUI\fillRow(), ilLPObjectStatisticsLPTableGUI\getDetailItems(), ilContainerStartObjectsContentTableGUI\getItems(), ilTrMatrixTableGUI\getSelectableColumns(), and setTitle().

◆ $icon_alt

ilTableGUI::$icon_alt

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

Referenced by ilWorkspaceShareTableGUI\fillRow().

◆ $lang_support

ilTableGUI::$lang_support = true

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

Referenced by renderHeader().

◆ $limit

ilTableGUI::$limit

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

Referenced by ilTable2GUI\determineLimit(), ilStudyProgrammeMembersTableGUI\fetchData(), ilTable2GUI\fillFooter(), ilTable2GUI\getAllCommandLimit(), ilBookingObjectsTableGUI\getItems(), ilRegistrationCodesTableGUI\getItems(), ilTrSummaryTableGUI\getItemsPercentages(), getLimit(), and render().

◆ $linkbar_vars

ilTableGUI::$linkbar_vars

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

◆ $lng

ilTableGUI::$lng

protected

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

◆ $max_count

ilTableGUI::$max_count

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

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

◆ $max_limit

ilTableGUI::$max_limit = false

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

◆ $offset

ilTableGUI::$offset

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

Referenced by ilStudyProgrammeMembersTableGUI\fetchData(), getOffset(), and ilBiblFieldFilterTableGUI\parseData().

◆ $order_column

ilTableGUI::$order_column

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

Referenced by getOrderColumn().

◆ $order_direction

ilTableGUI::$order_direction

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

Referenced by ilStudyProgrammeMembersTableGUI\fetchData(), and getOrderDirection().

◆ $prefix

ilTableGUI::$prefix

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

Referenced by ilSubscriberTableGUI\fillRow(), ilWaitingListTableGUI\fillRow(), ilTable2GUI\getPrefix(), and ilTrSummaryTableGUI\getSelectableColumns().

◆ $select_all_checkbox

ilTableGUI::$select_all_checkbox

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

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

◆ $styles

ilTableGUI::$styles

Initial value:

= array(
                            "table" => "fullwidth"
                        )

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

◆ $title

ilTableGUI::$title

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

◆ $tpl

ilTableGUI::$tpl

protected

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

Referenced by __construct(), and getTemplateObject().

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

Services/Table/classes/class.ilTableGUI.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addActionButton()

◆ clearActionButtons()

◆ disable()

◆ enable()

◆ getBase()

◆ getColumnCount()

◆ getData()

◆ getFormName()

◆ getLimit()

◆ getOffset()

◆ getOrderColumn()

◆ getOrderDirection()

◆ getSelectAllCheckbox()

◆ getStyle()

◆ getTemplateObject()

◆ render()

◆ renderHeader()

◆ setBase()

◆ setColumnWidth()

◆ setData()

◆ setFooter()

◆ setFormName()

◆ setHeaderNames()

◆ setHeaderVars()

◆ setHelp()

◆ setLimit()

◆ setMaxCount()

◆ setOffset()

◆ setOneColumnWidth()

◆ setOrderColumn()

◆ setOrderDirection()

◆ setOrderLink()

◆ setPrefix()

◆ setSelectAllCheckbox()

◆ setStyle()

◆ setTemplate()

◆ setTitle()

◆ sortData()

Field Documentation

◆ $action_buttons

◆ $base

◆ $column_count

◆ $column_width

◆ $data

◆ $enabled

◆ $footer_next

◆ $footer_previous

◆ $footer_style

◆ $form_name

◆ $global_tpl

◆ $header_names

◆ $header_vars

◆ $help_icon

◆ $help_icon_alt

◆ $help_page

◆ $icon

◆ $icon_alt

◆ $lang_support

◆ $limit

◆ $linkbar_vars

◆ $lng

◆ $max_count

◆ $max_limit

◆ $offset

◆ $order_column

◆ $order_direction

◆ $prefix

◆ $select_all_checkbox

◆ $styles

◆ $title

◆ $tpl