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 public
	disable ($a_module_name)
	diesables particular modules of table public
	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 17010 2008-07-23 08:37:46Z mjansen

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

Member Function Documentation

ilTableGUI::addActionButton	(		$btn_name,
			$btn_value
	)

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

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

ilTableGUI::clearActionButtons

(

)

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

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

ilTableGUI::disable

(

$a_module_name

)

diesables particular modules of table public

Parameters

string

module name

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

Referenced by ilCourseObjectiveQuestionsTableGUI\__construct(), ilCalendarCategoryTableGUI\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilGroupEditParticipantsTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilSubscriberTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilCourseObjectiveMaterialAssignmentTableGUI\__construct(), ilECSCommunityTableGUI\__construct(), ilCourseObjectiveQuestionAssignmentTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), 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 public

Parameters

string

module name

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

Referenced by ilCourseObjectiveQuestionsTableGUI\__construct(), ilCalendarCategoryTableGUI\__construct(), ilGroupEditParticipantsTableGUI\__construct(), ilCalendarAppointmentsTableGUI\__construct(), ilCalendarChangedAppointmentsTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilSubscriberTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), and ilSessionParticipantsTableGUI\init().

        {
                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 801 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 231 of file class.ilTableGUI.php.

References $column_count.

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

        {
                return $this->column_count;
        }

Here is the caller graph for this function:

ilTableGUI::getData

(

)

Reimplemented in ilTable2GUI.

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

References $data.

        {
                return $this->data;
        }

ilTableGUI::getFormName

(

)

Reimplemented in ilTable2GUI.

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

References $form_name.

Referenced by render().

        {
                return $this->form_name;
        }

Here is the caller graph for this function:

ilTableGUI::getLimit

(

)

Get limit.

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

References $limit.

Referenced by ilTable2GUI\getHTML(), and ilTable2GUI\getLinkbar().

        {
                return $this->limit;
        }

Here is the caller graph for this function:

ilTableGUI::getOffset

(

)

Get offset.

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

References $offset.

Referenced by ilTable2GUI\getHTML(), and ilTable2GUI\getLinkbar().

        {
                return $this->offset;
        }

Here is the caller graph for this function:

ilTableGUI::getOrderColumn

(

)

Get order column.

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

References $order_column.

        {
                return $this->order_column;
        }

ilTableGUI::getOrderDirection

(

)

Get order direction.

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

References $order_direction.

Referenced by ilTable2GUI\getHTML(), and ilTable2GUI\getLinkbar().

        {
                return $this->order_direction;
        }

Here is the caller graph for this function:

ilTableGUI::getSelectAllCheckbox

(

)

Reimplemented in ilTable2GUI.

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

References $select_all_checkbox.

Referenced by render().

        {
                return $this->select_all_checkbox;
        }

Here is the caller graph for this function:

ilTableGUI::getStyle

(

$a_element

)

Definition at line 781 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 146 of file class.ilTableGUI.php.

References $tpl.

        {
                return $this->tpl;
        }

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

Constructor.

Parameters

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

Definition at line 106 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.

Definition at line 479 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)
                        {
                                $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"])
                {
                        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 705 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_base

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

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

        {
                $this->base = $a_base;
        }

ilTableGUI::setColumnWidth

(

$a_column_width

)

set table column widths public

Parameters

array

column widths

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

        {
                $this->column_width = $a_column_width;
        }

ilTableGUI::setData

(

$a_data

)

set table data public

Parameters

array

table data

Reimplemented in ilTable2GUI.

Definition at line 156 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

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

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

Referenced by 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 821 of file class.ilTableGUI.php.

        {
                $this->form_name = $a_name;
        }

ilTableGUI::setHeaderNames

(

$a_header_names

)

set table header names public

Parameters

array

table header names

Definition at line 220 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

array	table header vars
array	additional link params

Definition at line 242 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

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

Definition at line 203 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

integer	limit
integer	default limit

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

Referenced by ilCourseObjectiveQuestionsTableGUI\__construct(), ilTable2GUI\__construct(), ilCalendarCategoryTableGUI\__construct(), ilCourseObjectivesTableGUI\__construct(), ilCourseObjectiveMaterialAssignmentTableGUI\__construct(), ilCourseObjectiveQuestionAssignmentTableGUI\__construct(), ilComponentsTableGUI\ilComponentsTableGUI(), ilPluginsTableGUI\ilPluginsTableGUI(), and ilWikiSearchResultsTableGUI\ilWikiSearchResultsTableGUI().

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

Parameters

integer

max_count

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

References $max_count.

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

        {
                $this->max_count = $a_max_count;

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

Here is the caller graph for this function:

ilTableGUI::setOffset

(

$a_offset

)

set dataset offset public

Parameters

integer

offset

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

Referenced by ilTable2GUI\getHTML().

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

string	column width
integer	column number

Definition at line 277 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

string	order column
string	default column

Definition at line 358 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

string

order direction

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

Referenced by ilTable2GUI\getHTML().

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

string

prefix

Reimplemented in ilTable2GUI.

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

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

ilTableGUI::setSelectAllCheckbox

(

$a_select_all_checkbox

)

Reimplemented in ilTable2GUI.

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

        {
                $this->select_all_checkbox = $a_select_all_checkbox;
        }

ilTableGUI::setStyle	(		$a_element,
			$a_style
	)

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

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

ilTableGUI::setTemplate

(

&

$a_tpl

)

set template public

Parameters

object

template object

Definition at line 141 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

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

Reimplemented in ilTable2GUI.

Definition at line 176 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 466 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 71 of file class.ilTableGUI.php.

ilTableGUI::$base = ""

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

Referenced by getBase(), and render().

ilTableGUI::$column_count

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

Referenced by getColumnCount().

ilTableGUI::$column_width

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

ilTableGUI::$data

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

Referenced by ilImageMapTableGUI\__construct(), ilCalendarCategoryTableGUI\buildPath(), ilCourseObjectivesTableGUI\fillRow(), getData(), ilTable2GUI\getHTML(), ilCalendarSharedListTableGUI\parse(), ilCalendarInboxSharedTableGUI\parse(), ilAdvancedMDRecordExportFilesTableGUI\parseFiles(), and ilSubscriberTableGUI\readSubscriberData().

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

ilTableGUI::$footer_next

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

ilTableGUI::$footer_previous

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

ilTableGUI::$footer_style

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

ilTableGUI::$form_name

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

Referenced by getFormName().

ilTableGUI::$global_tpl

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

ilTableGUI::$header_names

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

ilTableGUI::$header_vars

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

ilTableGUI::$help_icon

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

Referenced by setHelp().

ilTableGUI::$help_icon_alt

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

ilTableGUI::$help_page

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

ilTableGUI::$icon

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

Referenced by setTitle().

ilTableGUI::$icon_alt

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

ilTableGUI::$lang_support = true

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

Referenced by renderHeader().

ilTableGUI::$limit

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

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

ilTableGUI::$linkbar_vars

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

ilTableGUI::$max_count

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

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

ilTableGUI::$max_limit = false

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

ilTableGUI::$offset

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

Referenced by getOffset().

ilTableGUI::$order_column

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

Referenced by getOrderColumn().

ilTableGUI::$order_direction

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

Referenced by getOrderDirection().

ilTableGUI::$prefix

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

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

ilTableGUI::$select_all_checkbox

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

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

ilTableGUI::$styles

Initial value:

 array(
                                                        "table"         => "fullwidth"
                                                )

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

ilTableGUI::$title

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

Referenced by ilCourseEditParticipantsTableGUI\__construct(), ilWikiSearchResultsTableGUI\fillRow(), ilAdvancedMDRecordExportFilesTableGUI\fillRow(), ilWikiRecentChangesTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), and ilCourseObjectivesTableGUI\fillRow().

---

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

• Services/Table/classes/class.ilTableGUI.php