This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilTableGUI:

Collaboration diagram for ilTableGUI:

Public Member Functions
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

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

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

	getLimit ()

	setPrefix (string $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) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Static Public Member Functions
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')

Data Fields
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Protected Attributes
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning HTML table component

Author: Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilTableGUI::__construct	(	array	$a_data = `[]`,
		bool	$a_global_tpl = `true`
	)

Parameters

array \| null	$a_data	content data (optional)
bool	$a_global_tpl	content data (optional)

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

      {
        global $DIC;
 
        $tpl = $DIC->ui()->mainTemplate();
        $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, ILIAS\Repository\lng(), and setData().

Here is the call graph for this function:

Member Function Documentation

◆ addActionButton()

ilTableGUI::addActionButton	(	string	$btn_name,
		string	$btn_value
	)

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

                                                                        : void
    {
        $this->action_buttons[] = array(
            "name" => $btn_name,
            "value" => $btn_value
        );
    }

◆ clearActionButtons()

ilTableGUI::clearActionButtons ( )

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

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

◆ disable()

ilTableGUI::disable ( string $a_module_name )

Deprecated:: Use setEnable<Section>() of Table2GUI instead

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

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

Here is the caller graph for this function:

◆ enable()

ilTableGUI::enable ( string $a_module_name )

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

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

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

Here is the caller graph for this function:

◆ getBase()

ilTableGUI::getBase ( )

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

                             : string
    {
        return $this->base;
    }

References $base.

◆ getColumnCount()

ilTableGUI::getColumnCount ( )

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

                                    : int
    {
        return $this->column_count;
    }

References $column_count.

◆ getData()

ilTableGUI::getData ( )

Reimplemented in ilTable2GUI.

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

                             : array
    {
        return $this->data;
    }

References $data.

◆ getFormName()

ilTableGUI::getFormName ( )

get the name of the parent form

Reimplemented in ilTable2GUI.

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

                                 : string
    {
        return $this->form_name;
    }

◆ getLimit()

ilTableGUI::getLimit ( )

Reimplemented in ilTable2GUI.

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

                              : int
    {
        return $this->limit;
    }

References $limit.

◆ getOffset()

ilTableGUI::getOffset ( )

Reimplemented in ilTable2GUI.

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

                               : int
    {
        return $this->offset;
    }

References $offset.

◆ getOrderColumn()

ilTableGUI::getOrderColumn ( )

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

                                    : string
    {
        return $this->order_column;
    }

◆ getOrderDirection()

ilTableGUI::getOrderDirection ( )

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

                                       : string
    {
        return $this->order_direction;
    }

Here is the caller graph for this function:

◆ getSelectAllCheckbox()

ilTableGUI::getSelectAllCheckbox ( )

get the name of the checkbox that should be toggled with a select all button

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

                                          : string
    {
        return $this->select_all_checkbox;
    }

◆ getStyle()

ilTableGUI::getStyle ( string $a_element )

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

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

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

Here is the caller graph for this function:

◆ getTemplateObject()

ilTableGUI::getTemplateObject ( )

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

                                       : ilTemplate
    {
        return $this->tpl;
    }

References $tpl.

◆ linkbar()

static ilTableGUI::linkbar	(	string	$AScript,
		int	$AHits,
		int	$ALimit,
		int	$AOffset,
		array	$AParams = `array()`,
		array	$ALayout = `array()`,
		string	$prefix = `''`
	)

static

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

     : string {
        $LinkBar = "";
        $params = "";
 
        $layout_link = "";
        $layout_prev = "&lt;&lt;";
        $layout_next = "&gt;&gt;";
 
        // layout options
        if ((is_array($ALayout) && (count($ALayout) > 0))) {
            if ($ALayout["link"]) {
                $layout_link = " class=\"" . $ALayout["link"] . "\"";
            }
 
            if ($ALayout["prev"]) {
                $layout_prev = $ALayout["prev"];
            }
 
            if ($ALayout["next"]) {
                $layout_next = $ALayout["next"];
            }
        }
 
        // show links, if hits greater limit
        // or offset > 0 (can be > 0 due to former setting)
        if ($AHits > $ALimit || $AOffset > 0) {
            if (!empty($AParams)) {
                foreach ($AParams as $key => $value) {
                    $params .= $key . "=" . $value . "&";
                }
            }
            // if ($params) $params = substr($params,0,-1);
            if (strpos($AScript, '&')) {
                $link = $AScript . "&" . $params . $prefix . "offset=";
            } else {
                $link = $AScript . "?" . $params . $prefix . "offset=";
            }
 
            // ?bergehe "zurck"-link, wenn offset 0 ist.
            if ($AOffset >= 1) {
                $prevoffset = $AOffset - $ALimit;
                if ($prevoffset < 0) {
                    $prevoffset = 0;
                }
                $LinkBar .= "<a" . $layout_link . " href=\"" . $link . $prevoffset . "\">" . $layout_prev . "&nbsp;</a>";
            }
 
            // Ben?tigte Seitenzahl kalkulieren
            $pages = intval($AHits / $ALimit);
 
            // Wenn ein Rest bleibt, addiere eine Seite
            if (($AHits % $ALimit)) {
                $pages++;
            }
 
            // Bei Offset = 0 keine Seitenzahlen anzeigen : DEAKTIVIERT
            //                  if ($AOffset != 0) {
 
            // ansonsten zeige Links zu den anderen Seiten an
            for ($i = 1 ;$i <= $pages ; $i++) {
                $newoffset = $ALimit * ($i - 1);
 
                if ($newoffset == $AOffset) {
                    $LinkBar .= "[" . $i . "] ";
                } else {
                    $LinkBar .= '<a ' . $layout_link . ' href="' .
                        $link . $newoffset . '">[' . $i . ']</a> ';
                }
            }
            //                  }
 
            // Checken, ob letze Seite erreicht ist
            // Wenn nicht, gebe einen "Weiter"-Link aus
            if (!(($AOffset / $ALimit) == ($pages - 1)) && ($pages != 1)) {
                $newoffset = $AOffset + $ALimit;
                $LinkBar .= "<a" . $layout_link . " href=\"" . $link . $newoffset . "\">&nbsp;" . $layout_next . "</a>";
            }
 
            return $LinkBar;
        }
        return "";
    }

◆ render()

ilTableGUI::render ( )

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

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

                            : string
    {
        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("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"]) {
            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");
                $this->tpl->setVariable("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 = $this->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.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();
        }
        return "";
    }

References $_SERVER, $base, ILIAS\LTI\ToolProvider\$key, $params, ilUtil\getImagePath(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ renderHeader()

ilTableGUI::renderHeader ( )

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

                                  : void
    {
        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 ILIAS\LTI\ToolProvider\$key, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ setBase()

ilTableGUI::setBase ( string $a_base )

Parameters

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

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

                                           : void
    {
        $this->base = $a_base;
    }

References ILIAS\UI\examples\Button\Bulky\base().

Here is the call graph for this function:

◆ setColumnWidth()

ilTableGUI::setColumnWidth ( array $a_column_width )

set table column widths

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

                                                         : void
    {
        $this->column_width = $a_column_width;
    }

◆ setData()

ilTableGUI::setData ( array $a_data )

Set table data.

Reimplemented in ilTable2GUI.

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

                                          : void
    {
        $this->data = $a_data;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setFooter()

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

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

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

Referenced by ilDclCreateViewTableGUI\getHTML(), ilDclEditViewTableGUI\getHTML(), ilDclFieldListTableGUI\getHTML(), ilDclTableListTableGUI\getHTML(), ilDclTableViewEditFieldsTableGUI\getHTML(), and ilDclTableViewTableGUI\getHTML().

Here is the caller graph for this function:

◆ setFormName()

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

Reimplemented in ilTable2GUI.

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

                                                       : void
    {
        $this->form_name = $a_name;
    }

◆ setHeaderNames()

ilTableGUI::setHeaderNames ( array $a_header_names )

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

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

◆ setHeaderVars()

ilTableGUI::setHeaderVars	(	array	$a_header_vars,
		array	$a_header_params = `[]`
	)

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

                                                                                    : void
    {
        $this->header_vars = $a_header_vars;
        $this->header_params = $a_header_params;
        $this->link_params = "";
        foreach ($a_header_params as $key => $val) {
            $this->link_params .= $key . "=" . $val . "&";
        }
    }

References ILIAS\LTI\ToolProvider\$key.

◆ setHelp()

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

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

                                                                                                   : void
    {
        $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	(	int	$a_limit = `0`,
		int	$a_default_limit = `0`
	)

set max.

datasets displayed per page

Reimplemented in ilTable2GUI.

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

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

◆ setMaxCount()

ilTableGUI::setMaxCount ( int $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

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

                                                 : void
    {
        $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 ( int $a_offset )

set dataset offset

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

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

Referenced by ilTable2GUI\resetOffset().

Here is the caller graph for this function:

◆ setOneColumnWidth()

ilTableGUI::setOneColumnWidth	(	string	$a_column_width,
		int	$a_column_number
	)

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

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

◆ setOrderColumn()

ilTableGUI::setOrderColumn	(	string	$a_order_column = `""`,
		string	$a_default_column = `""`
	)

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

     : void {
        // set default sort column to first column
        if (empty($a_order_column)) {
            if (!empty($a_default_column)) {
                $oc = array_search($a_default_column, $this->header_vars);
            } else {
                $oc = "";
            }
        } else {
            $oc = array_search($a_order_column, $this->header_vars);
        }
 
        $this->order_column = $oc ?: "";
    }

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

Here is the caller graph for this function:

◆ setOrderDirection()

ilTableGUI::setOrderDirection ( string $a_order_direction )

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

                                                                : void
    {
        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 ilCalendarManageTableGUI\resetToDefaults().

Here is the caller graph for this function:

◆ setOrderLink()

ilTableGUI::setOrderLink	(	string	$key,
		string	$order_dir
	)

Reimplemented in ilTable2GUI.

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

                                                                : void
    {
        $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 ILIAS\LTI\ToolProvider\$key.

◆ setPrefix()

ilTableGUI::setPrefix ( string $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)

Reimplemented in ilTable2GUI.

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

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

◆ setSelectAllCheckbox()

ilTableGUI::setSelectAllCheckbox ( string $a_select_all_checkbox )

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

                                                                       : void
    {
        $this->select_all_checkbox = $a_select_all_checkbox;
    }

◆ setStyle()

ilTableGUI::setStyle	(	string	$a_element,
		string	$a_style
	)

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

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

Here is the caller graph for this function:

◆ setTemplate()

ilTableGUI::setTemplate ( ilTemplate $a_tpl )

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

                                                  : void
    {
        $this->tpl = $a_tpl;
    }

◆ setTitle()

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

Parameters

string	$a_title	table title
string	$a_icon	file name of title icon
string	$a_icon_alt	alternative text for title icon

Reimplemented in ilTable2GUI.

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

                                                                                           : void
    {
        $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 339 of file class.ilTableGUI.php.

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

References ilArrayUtil\sortArray().

Here is the call graph for this function:

Field Documentation

◆ $action_buttons

array ilTableGUI::$action_buttons = []

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

◆ $base

string ilTableGUI::$base = ""

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

◆ $column_count

int ilTableGUI::$column_count = 0

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

Referenced by getColumnCount().

◆ $column_width

array ilTableGUI::$column_width = []

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

Referenced by ilObjectRolePermissionTableGUI\initColumns().

◆ $data

array ilTableGUI::$data = []

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

◆ $enabled

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

◆ $footer_next

string ilTableGUI::$footer_next = ""

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

◆ $footer_previous

string ilTableGUI::$footer_previous = ""

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

◆ $footer_style

string ilTableGUI::$footer_style = ""

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

◆ $form_name

string ilTableGUI::$form_name = ""

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

◆ $global_tpl

bool ilTableGUI::$global_tpl = false

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

◆ $header_names

array ilTableGUI::$header_names = []

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

◆ $header_params

array ilTableGUI::$header_params

protected

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

◆ $header_vars

array ilTableGUI::$header_vars = []

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

◆ $help_icon

string ilTableGUI::$help_icon = ""

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

Referenced by setHelp().

◆ $help_icon_alt

string ilTableGUI::$help_icon_alt = ""

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

◆ $help_page

string ilTableGUI::$help_page = ""

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

◆ $icon

string ilTableGUI::$icon = ""

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

◆ $icon_alt

string ilTableGUI::$icon_alt = ""

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

Referenced by ilWorkspaceShareTableGUI\fillRow().

◆ $lang_support

bool ilTableGUI::$lang_support = true

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

◆ $limit

int ilTableGUI::$limit = 0

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

Referenced by ilTable2GUI\determineLimit(), ilBookingObjectsTableGUI\getItems(), ilRegistrationCodesTableGUI\getItems(), getLimit(), and ilEmployeeTalkTableGUI\setTalkData().

◆ $link_params

string ilTableGUI::$link_params

protected

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

◆ $linkbar_vars

array ilTableGUI::$linkbar_vars = []

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

◆ $lng

ilLanguage ilTableGUI::$lng

protected

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

◆ $max_count

int ilTableGUI::$max_count = 0

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

Referenced by setMaxCount().

◆ $max_limit

bool ilTableGUI::$max_limit = false

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

◆ $offset

int ilTableGUI::$offset = 0

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

Referenced by getOffset(), ilBiblFieldFilterTableGUI\parseData(), and ilEmployeeTalkTableGUI\setTalkData().

◆ $order_column

string ilTableGUI::$order_column = ""

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

◆ $order_direction

string ilTableGUI::$order_direction = ""

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

◆ $prefix

string ilTableGUI::$prefix = ""

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

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

◆ $select_all_checkbox

string ilTableGUI::$select_all_checkbox = ""

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

◆ $sort_order

string ilTableGUI::$sort_order

protected

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

◆ $styles

array ilTableGUI::$styles

Initial value:

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

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

◆ $title

string ilTableGUI::$title = ""

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

◆ $tpl

ilTableGUI::$tpl

protected

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

Referenced by ilTestManScoringParticipantsBySelectedQuestionAndPassTableGUI\__construct(), __construct(), ilOrgUnitPermissionTableGUI\__construct(), ilObjectRolePermissionTableGUI\__construct(), ilBadgePersonalTableGUI\__construct(), ilPortfolioRoleAssignmentTableGUI\fillRow(), ilContainerFilterTableGUI\fillRow(), ilContSkillMemberTableGUI\fillRow(), ilDashObjectsTableGUI\fillRow(), ILIAS\Skill\Tree\SkillTreeTableGUI\fillRow(), ilRepositoryObjectSearchResultTableGUI\getRelevanceHTML(), ilRepositoryUserResultTableGUI\getRelevanceHTML(), getTemplateObject(), ilMarkSchemaTableGUI\initJS(), ilLPObjectStatisticsLPTableGUI\initLearningProgressDetailsLayer(), and ilDidacticTemplateSettingsTableGUI\parse().

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

Services/Table/classes/class.ilTableGUI.php

Public Member Functions

Static 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()

◆ linkbar()

◆ 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_params

◆ $header_vars

◆ $help_icon

◆ $help_icon_alt

◆ $help_page

◆ $icon

◆ $icon_alt

◆ $lang_support

◆ $limit

◆ $link_params

◆ $linkbar_vars

◆ $lng

◆ $max_count

◆ $max_limit

◆ $offset

◆ $order_column

◆ $order_direction

◆ $prefix

◆ $select_all_checkbox

◆ $sort_order