Inheritance diagram for ilForumTopicTableGUI:

Collaboration diagram for ilForumTopicTableGUI:

Public Member Functions
	populate ()

	initMergeThreadsTable ()

	numericOrdering ($column)
	Currently not used because of external segmentation and sorting. More...

	setMapper (ilForum $mapper)

	getMapper ()

	setRefId ($ref_id)

	getRefId ()

	setOverviewSetting ($overview_setting)

	getOverviewSetting ()

	setIsModerator ($is_moderator)

	getIsModerator ()

	setTopicData ($topicData)

	getTopicData ()

	setSelectedThread (ilForumTopic $thread_obj)

	getSelectedThread ()

Public Member Functions inherited from ilTable2GUI
	__construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
	Constructor. More...

	setOpenFormTag ($a_val)
	Set open form tag. More...

	getOpenFormTag ()
	Get open form tag. More...

	setCloseFormTag ($a_val)
	Set close form tag. More...

	getCloseFormTag ()
	Get close form tag. More...

	determineLimit ()
	Determine the limit. More...

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()
	Determine selected columns. More...

	isColumnSelected ($a_col)
	Is given column selected? More...

	getSelectedColumns ()
	Get selected columns. More...

&	executeCommand ()
	Execute command. More...

	resetOffset ($a_in_determination=false)
	Reset offset. More...

	initFilter ()
	Init filter. More...

	getParentObject ()
	Get parent object. More...

	getParentCmd ()
	Get parent command. More...

	setTopAnchor ($a_val)
	Set top anchor. More...

	getTopAnchor ()
	Get top anchor. More...

	setNoEntriesText ($a_text)
	Set text for an empty table. More...

	getNoEntriesText ()
	Get text for an empty table. More...

	setIsDataTable ($a_val)
	Set is data table. More...

	getIsDataTable ()
	Get is data table. More...

	setEnableTitle ($a_enabletitle)
	Set Enable Title. More...

	getEnableTitle ()
	Get Enable Title. More...

	setEnableHeader ($a_enableheader)
	Set Enable Header. More...

	getEnableHeader ()
	Get Enable Header. More...

	setEnableNumInfo ($a_val)
	Set enable num info. More...

	getEnableNumInfo ()
	Get enable num info. More...

	setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
	Set title and title icon. More...

	setDescription ($a_val)
	Set description. More...

	getDescription ()
	Get description. More...

	setOrderField ($a_order_field)
	set order column More...

	getOrderField ()

	setData ($a_data)

	getData ()

	dataExists ()

	setPrefix ($a_prefix)

	getPrefix ()

	addFilterItem ($a_input_item, $a_optional=false)
	Add filter item. More...

	addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=NULL)
	Add filter by standard type. More...

	getFilterItems ($a_optionals=false)
	Get filter items. More...

	getFilterItemByPostVar ($a_post_var)

	setFilterCols ($a_val)
	Set filter columns. More...

	getFilterCols ()
	Get filter columns. More...

	setDisableFilterHiding ($a_val=true)
	Set disable filter hiding. More...

	getDisableFilterHiding ()
	Get disable filter hiding. More...

	isFilterSelected ($a_col)
	Is given filter selected? More...

	getSelectedFilters ()
	Get selected filters. More...

	determineSelectedFilters ()
	Determine selected filters. More...

	setCustomPreviousNext ($a_prev_link, $a_next_link)
	Set custom previous/next links. More...

	setFormAction ($a_form_action)
	Set Form action parameter. More...

	getFormAction ()
	Get Form action parameter. More...

	setFormName ($a_formname)
	Set Form name. More...

	getFormName ()
	Get Form name. More...

	setId ($a_val)
	Set id. More...

	getId ()
	Get element id. More...

	setDisplayAsBlock ($a_val)
	Set display as block. More...

	getDisplayAsBlock ()
	Get display as block. More...

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

	setSelectAllCheckbox ($a_select_all_checkbox)
	Set the name of the checkbox that should be toggled with a select all button. More...

	setExternalSorting ($a_val)
	Set external sorting. More...

	getExternalSorting ()
	Get external sorting. More...

	setFilterCommand ($a_val)
	Set filter command. More...

	getFilterCommand ()
	Get filter command. More...

	setResetCommand ($a_val)
	Set reset filter command. More...

	getResetCommand ()
	Get reset filter command. More...

	setExternalSegmentation ($a_val)
	Set external segmentation. More...

	getExternalSegmentation ()
	Get external segmentation. More...

	setRowTemplate ($a_template, $a_template_dir="")
	Set row template. More...

	setDefaultOrderField ($a_defaultorderfield)
	Set Default order field. More...

	getDefaultOrderField ()
	Get Default order field. More...

	setDefaultOrderDirection ($a_defaultorderdirection)
	Set Default order direction. More...

	getDefaultOrderDirection ()
	Get Default order direction. More...

	clearCommandButtons ()

	addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="")
	Add Command button. More...

	addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button. More...

	addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
	Add Selection List + Command button for selected items. More...

	setCloseCommand ($a_link)
	Add command for closing table. More...

	addMultiCommand ($a_cmd, $a_text)
	Add Command button. More...

	addHiddenInput ($a_name, $a_value)
	Add Hidden Input field. More...

	addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
	Add Header Command (Link) (Image needed for now) More...

	setTopCommands ($a_val)
	Set top commands (display command buttons on top of table, too) More...

	getTopCommands ()
	Get top commands (display command buttons on top of table, too) More...

	addColumn ($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
	Add a column to the header. More...

	getNavParameter ()

	setOrderLink ($sort_field, $order_dir)

	fillHeader ()

	determineOffsetAndOrder ($a_omit_offset=false)
	Determine offset and order. More...

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering ($a_field)
	Should this field be sorted numeric? More...

	render ()
	render table public More...

	writeFilterToSession ()
	Write filter values to session. More...

	resetFilter ()
	Reset filter. More...

	fillFooter ()
	Fill footer row. More...

	getLinkbar ($a_num)
	Get previous/next linkbar. More...

	fillHiddenRow ()

	fillActionRow ()
	Fill Action Row. More...

	setHeaderHTML ($html)
	set header html More...

	storeProperty ($type, $value)
	Store table property. More...

	loadProperty ($type)
	Load table property. More...

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext ($id)
	Set context. More...

	getContext ()
	Get context. More...

	setShowRowsSelector ($a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()
	Get rows-per-page selector state. More...

	setShowTemplates ($a_value)
	Toggle templates. More...

	getShowTemplates ()
	Get template state. More...

	restoreTemplate ($a_name)
	Restore state from template. More...

	saveTemplate ($a_name)
	Save current state as template. More...

	deleteTemplate ($a_name)
	Delete template. More...

	getLimit ()
	Get limit. More...

	getOffset ()
	Get offset. More...

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode ($a_value=false)
	Toogle print mode. More...

	getPrintMode ()
	Get print mode. More...

	getExportMode ()
	Was export activated? More...

	exportData ($format, $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand ($a_value)
	Enable actions for all entries in current result. More...

	setRowSelectorLabel ($row_selector_label)

	getRowSelectorLabel ()

Public Member Functions inherited from ilTableGUI
	ilTableGUI ($a_data=0, $a_global_tpl=true)
	Constructor. More...

	setTemplate (&$a_tpl)
	set template public More...

&	getTemplateObject ()

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

	getData ()

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

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

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

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

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

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

	setOneColumnWidth ($a_column_width, $a_column_number)
	set one table column width 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) public More...

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

	getOffset ()
	Get offset. More...

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

	getOrderColumn ()
	Get order column. More...

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

	getOrderDirection ()
	Get order direction. More...

	setFooter ($a_style, $a_previous=0, $a_next=0)
	set order direction 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 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
	$position = 1

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
	$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 Member Functions
	formatCellValue ($cell, $value)

Protected Member Functions inherited from ilTable2GUI
	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	fillRow ($a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilFormPropertyGUI $a_item)
	Get current filter value. More...

	SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
	Set current filter value. More...

	fillMetaExcel ($worksheet, &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel ($worksheet, &$a_row)
	Excel Version of Fill Row. More...

	fillRowExcel ($a_worksheet, &$a_row, $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV ($a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV ($a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV ($a_csv, $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
	$mapper

	$is_moderator = false

	$ref_id = 0

	$overview_setting = ''

	$topicData = array()

	$ctrl

	$merge_thread_obj = NULL

Protected Attributes inherited from ilTable2GUI
	$close_command = ""

	$top_anchor = "il_table_top"

	$filters = array()

	$optional_filters = array()

	$filter_cmd = 'applyFilter'

	$reset_cmd = 'resetFilter'

	$filter_cols = 5

	$ext_sort = false

	$ext_seg = false

	$context = ""

	$mi_sel_buttons = null

	$disable_filter_hiding = false

	$selected_filter = false

	$top_commands = true

	$selectable_columns = array()

	$selected_column = array()

	$show_templates = false

	$show_rows_selector = false

	$nav_determined = false

	$limit_determined = false

	$filters_determined = false

	$columns_determined = false

	$open_form_tag = true

	$close_form_tag = true

	$export_formats

	$export_mode

	$print_mode

	$enable_command_for_all

	$row_selector_label

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

Detailed Description

Class ilForumTopicTableGUI.

Author: Nadia Ahmad nahma.nosp@m.d@da.nosp@m.tabay.nosp@m..de; Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version: $Id$

Definition at line 16 of file class.ilForumTopicTableGUI.php.

Member Function Documentation

◆ formatCellValue()

ilForumTopicTableGUI::formatCellValue	(	$cell,
		$value
	)

protected

Currently not used because of external segmentation and sorting and formatting in fillRow
Parameters

string $cell

mixed $value

Returns
mixed

Definition at line 356 of file class.ilForumTopicTableGUI.php.

         {
                 return $value;
         }

◆ getIsModerator()

ilForumTopicTableGUI::getIsModerator ( )

Returns: bool

Definition at line 492 of file class.ilForumTopicTableGUI.php.

References $is_moderator.

Referenced by initMergeThreadsTable(), numericOrdering(), and populate().

         {
                 return $this->is_moderator;
         }

Here is the caller graph for this function:

◆ getMapper()

ilForumTopicTableGUI::getMapper ( )

Returns: ilForum

Definition at line 438 of file class.ilForumTopicTableGUI.php.

References $mapper.

Referenced by numericOrdering().

         {
                 return $this->mapper;
         }

Here is the caller graph for this function:

◆ getOverviewSetting()

ilForumTopicTableGUI::getOverviewSetting ( )

Returns: string

Definition at line 474 of file class.ilForumTopicTableGUI.php.

References $overview_setting.

Referenced by initMergeThreadsTable().

         {
                 return $this->overview_setting;
         }

Here is the caller graph for this function:

◆ getRefId()

ilForumTopicTableGUI::getRefId ( )

Returns: int

Definition at line 456 of file class.ilForumTopicTableGUI.php.

References $ref_id.

Referenced by numericOrdering().

         {
                 return $this->ref_id;
         }

Here is the caller graph for this function:

◆ getSelectedThread()

ilForumTopicTableGUI::getSelectedThread ( )

Returns: ilForumTopic

Definition at line 526 of file class.ilForumTopicTableGUI.php.

References $merge_thread_obj.

Referenced by initMergeThreadsTable(), and numericOrdering().

         {
                 return $this->merge_thread_obj;
         }

Here is the caller graph for this function:

◆ getTopicData()

ilForumTopicTableGUI::getTopicData ( )

Returns: array

Definition at line 510 of file class.ilForumTopicTableGUI.php.

References $topicData.

         {
                 return $this->topicData;
         }

◆ initMergeThreadsTable()

ilForumTopicTableGUI::initMergeThreadsTable ( )

Definition at line 178 of file class.ilForumTopicTableGUI.php.

Referenced by populate().

         {
                 // Columns
                 $this->addColumn('', 'check', '1px', true);
                 $this->addColumn($this->lng->txt('forums_thread'), 'th_title');
                 $this->addColumn($this->lng->txt('forums_created_by'), 'author');
                 $this->addColumn($this->lng->txt('forums_articles'), 'num_posts');
                 $this->addColumn($this->lng->txt('visits'), 'num_visit');
                 $this->addColumn($this->lng->txt('forums_last_post'), 'lp_date');
         
                 // Disable sorting
                 $this->disable('sort');
 
                 // Default Form Action
                 $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), 'confirmMergeThreads'));
 
                 // Row template
                 $this->setRowTemplate('tpl.forums_threads_table.html', 'Modules/Forum');
 
                 ilUtil::sendInfo($this->lng->txt('please_choose_target'));
                 
                 $this->setTitle(sprintf($this->lng->txt('frm_selected_merge_src'), $this->getSelectedThread()->getSubject()));
                 
                 $this->addCommandButton('confirmMergeThreads',$this->lng->txt('merge'));
                 $this->addCommandButton('showThreads', $this->lng->txt('cancel'));
                 $this->setShowRowsSelector(true);
                 $this->setRowSelectorLabel($this->lng->txt('number_of_threads'));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numericOrdering()

ilForumTopicTableGUI::numericOrdering ( $column )

Currently not used because of external segmentation and sorting.

Parameters

string $column

Returns: bool

Definition at line 366 of file class.ilForumTopicTableGUI.php.

References ilTableGUI\$data, ilTable2GUI\determineOffsetAndOrder(), getIsModerator(), ilTable2GUI\getLimit(), getMapper(), ilTable2GUI\getOffset(), getRefId(), getSelectedThread(), ilTable2GUI\resetOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

         {
                 return false;
         }

Here is the call graph for this function:

◆ populate()

ilForumTopicTableGUI::populate ( )

Definition at line 98 of file class.ilForumTopicTableGUI.php.

References $ilUser, ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), getIsModerator(), initMergeThreadsTable(), ilTable2GUI\setFormAction(), ilTable2GUI\setRowSelectorLabel(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowRowsSelector().

         {
                 if($this->parent_cmd == 'mergeThreads')
                 {
                         $this->initMergeThreadsTable();
                 }
                 else
                 {
                         $this->initTopicsOverviewTable();
                 }
         }

Here is the call graph for this function:

◆ setIsModerator()

ilForumTopicTableGUI::setIsModerator ( $is_moderator )

Parameters

bool $is_moderator

Returns: ilForumTopicTableGUI

Definition at line 483 of file class.ilForumTopicTableGUI.php.

References $is_moderator.

         {
                 $this->is_moderator = $is_moderator;
                 return $this;
         }

◆ setMapper()

ilForumTopicTableGUI::setMapper ( ilForum $mapper )

Parameters

ilForum $mapper

Returns: ilForumTopicTableGUI

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

References $mapper.

         {
                 $this->mapper = $mapper;
                 return $this;
         }

◆ setOverviewSetting()

ilForumTopicTableGUI::setOverviewSetting ( $overview_setting )

Parameters

string $overview_setting

Returns: ilForumTopicTableGUI

Definition at line 465 of file class.ilForumTopicTableGUI.php.

References $overview_setting.

         {
                 $this->overview_setting = $overview_setting;
                 return $this;
         }

◆ setRefId()

ilForumTopicTableGUI::setRefId ( $ref_id )

Parameters

int $ref_id

Returns: ilForumTopicTableGUI

Definition at line 447 of file class.ilForumTopicTableGUI.php.

References $ref_id.

         {
                 $this->ref_id = $ref_id;
                 return $this;
         }

◆ setSelectedThread()

ilForumTopicTableGUI::setSelectedThread ( ilForumTopic $thread_obj )

Parameters

ilForumTopic $thread_obj

Definition at line 518 of file class.ilForumTopicTableGUI.php.

         {
                 $this->merge_thread_obj = $thread_obj;
         }

◆ setTopicData()

ilForumTopicTableGUI::setTopicData ( $topicData )

Parameters

array $topicData

Returns: ilForumTopicTableGUI

Definition at line 501 of file class.ilForumTopicTableGUI.php.

References $topicData.

         {
                 $this->topicData = $topicData;
                 return $this;
         }

Field Documentation

◆ $ctrl

ilForumTopicTableGUI::$ctrl

protected

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

◆ $is_moderator

ilForumTopicTableGUI::$is_moderator = false

protected

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

Referenced by getIsModerator(), and setIsModerator().

◆ $mapper

ilForumTopicTableGUI::$mapper

protected

Definition at line 21 of file class.ilForumTopicTableGUI.php.

Referenced by getMapper(), and setMapper().

◆ $merge_thread_obj

ilForumTopicTableGUI::$merge_thread_obj = NULL

protected

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

Referenced by getSelectedThread().

◆ $overview_setting

ilForumTopicTableGUI::$overview_setting = ''

protected

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

Referenced by getOverviewSetting(), and setOverviewSetting().

◆ $position

ilForumTopicTableGUI::$position = 1

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

◆ $ref_id

ilForumTopicTableGUI::$ref_id = 0

protected

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

Referenced by getRefId(), and setRefId().

◆ $topicData

ilForumTopicTableGUI::$topicData = array()

protected

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

Referenced by getTopicData(), and setTopicData().

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

Modules/Forum/classes/class.ilForumTopicTableGUI.php

string	$cell
mixed	$value

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ formatCellValue()

◆ getIsModerator()

◆ getMapper()

◆ getOverviewSetting()

◆ getRefId()

◆ getSelectedThread()

◆ getTopicData()

◆ initMergeThreadsTable()

◆ numericOrdering()

◆ populate()

◆ setIsModerator()

◆ setMapper()

◆ setOverviewSetting()

◆ setRefId()

◆ setSelectedThread()

◆ setTopicData()

Field Documentation

◆ $ctrl

◆ $is_moderator

◆ $mapper

◆ $merge_thread_obj

◆ $overview_setting

◆ $position

◆ $ref_id

◆ $topicData