Inheritance diagram for ilTable2GUI:

Collaboration diagram for ilTable2GUI:

Public Member Functions
	__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)
	set table data @access public More...

	getData ()

	dataExists ()

	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

	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, $a_multipart=false)
	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, $a_caption=null)
	Set filter command. More...

	getFilterCommand ()
	Get filter command. More...

	setResetCommand ($a_val, $a_caption=null)
	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...

	setDefaultFilterVisiblity ($a_status)
	Set default filter visiblity. More...

	getDefaultFilterVisibility ()
	Get default filter visibility. More...

	clearCommandButtons ()

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

	addCommandButtonInstance (ilButtonBase $a_button)
	Add Command button instance. 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="", $a_tooltip_with_html=false)
	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 @access 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 ()

	setPreventDoubleSubmission ($a_val)
	Set prevent double submission. More...

	getPreventDoubleSubmission ()
	Get prevent double submission. More...

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

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

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

&	getTemplateObject ()

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

	getData ()

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

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

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

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

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

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

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

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

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

	getLimit ()
	Get limit. More...

	setPrefix ($a_prefix)
	set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...

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

	getOffset ()
	Get offset. More...

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

	getOrderColumn ()
	Get order column. More...

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

	getOrderDirection ()
	Get order direction. More...

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

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

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

	sortData ()

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

	renderHeader ()

	setOrderLink ($key, $order_dir)

	setStyle ($a_element, $a_style)

	getStyle ($a_element)

	setBase ($a_base)
	Set Base script name (deprecated, only use this for workarounds). More...

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

	getFormName ()

	setFormName ($a_name="cmd")

	getSelectAllCheckbox ()

	setSelectAllCheckbox ($a_select_all_checkbox)

	clearActionButtons ()

	addActionButton ($btn_name, $btn_value)

Static Public Member Functions
static	getAllCommandLimit ()
	Get maximum number of entries to enable actions for all. More...

Data Fields
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
	prepareOutput ()
	Anything that must be done before HTML is generated. More...

	isFilterVisible ()
	Check if filter is visible: manually shown (session, db) or default value set. More...

	isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
	Check if filter element is based on adv md. 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 (ilExcel $a_excel, &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, &$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
	$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 = true

	$rows_selector_off = 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

	$restore_filter

	$restore_filter_values

	$default_filter_visibility = false

	$sortable_fields = array()

	$prevent_double_submission = true

	$row_selector_label

Private Member Functions
	renderFilter ()
	Render Filter section. More...

Private Attributes
	$unique_id

	$headerHTML

Detailed Description

Class ilTable2GUI.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Sascha Hofmann shofm.nosp@m.ann@.nosp@m.datab.nosp@m.ay.d.nosp@m.e

Version

Id: class.ilTableGUI.php 12818 2006-12-10 13:14:43Z akill

Definition at line 15 of file class.ilTable2GUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilTable2GUI::__construct	(	$a_parent_obj,
		$a_parent_cmd = `""`,
		$a_template_context = `""`
	)

Constructor.

Reimplemented in ilSCTaskTableGUI, ilConsultationHoursTableGUI, ilLMGlossaryTableGUI, ilSCORMOfflineModeUsersTableGUI, ilSCORMTrackingItemPerUserTableGUI, ilSCORMTrackingItemsPerScoTableGUI, ilSCORMTrackingItemsPerUserTableGUI, ilSCORMTrackingItemsScoTableGUI, ilSCORMTrackingUsersTableGUI, ilObjectCopySearchResultTableGUI, ilCourseObjectiveMaterialAssignmentTableGUI, ilRepositoryObjectResultTableGUI, ilFeedbackConfirmationTable2GUI, SurveyMaterialsSourceTableGUI, ilExcCriteriaTableGUI, ilCalendarAppointmentsTableGUI, ilHelpTooltipTableGUI, ilCourseGroupingTableGUI, ilPCIIMPopupTableGUI, ilSkillLevelProfileAssignmentTableGUI, ilUserActionAdminTableGUI, ilConditionHandlerTableGUI, ilAssignmentsTableGUI, ilExcCriteriaCatalogueTableGUI, ilDclExportTableGUI, ilTestExportTableGUI, ilQuestionPoolExportTableGUI, ilExportTableGUI, ilPCFileListTableGUI, ilUploadDirFilesTableGUI, ilLanguageTableGUI, ilMemberExportFileTableGUI, ilObjectCopyProgressTableGUI, ilObjectTableGUI, ilUserClipboardTableGUI, ilLMBlockedUsersTableGUI, ilLMPagesTableGUI, ilLMQuestionListTableGUI, ilLMMenuItemsTableGUI, ilImageMapTableGUI, ilPCIIMOverlaysTableGUI, ilMobSubtitleTableGUI, ilCourseStartObjectsTableGUI, ilRoleDesktopItemsTableGUI, ilLanguageExtTableGUI, ilRatingCategoryTableGUI, ilCopySelfAssQuestionTableGUI, ilSearchResultTableGUI, ilSkillProfileLevelsTableGUI, ilSkillProfileUserTableGUI, ilBookingSchedulesTableGUI, ilObjectRolePermissionTableGUI, ilRbacLogTableGUI, ilAdminSubItemsTableGUI, ilRepositoryObjectSearchResultTableGUI, ilUserLPTableGUI, ilScormSpecialPagesTableGUI, ilWebResourceLinkTableGUI, ilStyleColorTableGUI, ilStyleImageTableGUI, ilStyleMediaQueryTableGUI, ilSurveySkillAssignmentTableGUI, ilSurveySkillTableGUI, ilPCTabsTableGUI, ilUserForTagTableGUI, ilTermListTableGUI, ilTermUsagesTableGUI, ilSettingsTemplateTableGUI, ilPortfolioTableGUI, ilConsultationHourBookingTableGUI, ilConsultationHourGroupTableGUI, ilBadgePersonalTableGUI, ilHelpMappingTableGUI, ilWikiPageTemplatesTableGUI, ilSurveyMaterialsTableGUI, ilSurveyQuestionsTableGUI, ilAssessmentFolderLogAdministrationTableGUI, ilFileVersionTableGUI, ilSCORM2004ExportTableGUI, ilSurveyMaintenanceTableGUI, ilSurveyPhrasesTableGUI, ilSurveyQuestionPoolExportTableGUI, assFileUploadFileTableGUI, ilSurveyResultsUserTableGUI, ilQuestionPoolPrintViewTableGUI, ilCourseParticipantsGroupsTableGUI, ilTrMatrixTableGUI, ilBadgeTypesTableGUI, ilBadgeImageTemplateTableGUI, ilObjectBadgeTableGUI, ilModulesTableGUI, ilNewItemGroupTableGUI, ilNewsForContextTableGUI, ilBannedUsersTableGUI, ilIndividualAssessmentMembersTableGUI, ilQuestionPoolImportVerificationTableGUI, ilLDAPServerTableGUI, ilLPTableBaseGUI, ilWikiContributorsTableGUI, ilWikiRecentChangesTableGUI, ilMDCopyrightTableGUI, ilTestDetailedEvaluationStatisticsTableGUI, ilMailingListsTableGUI, ilLDAPRoleMappingTableGUI, ilSessionParticipantsTableGUI, ilStudyProgrammeAcknowledgeCompletedCoursesTableGUI, ilMailSearchCoursesMembersTableGUI, ilMailSearchCoursesTableGUI, ilLOMemberTestResultTableGUI, and ilWorkflowEngineDefinitionsTableGUI.

Definition at line 89 of file class.ilTable2GUI.php.

        {
                global $lng;
 
                parent::__construct(0, false);
                $this->unique_id = md5(uniqid());
                $this->parent_obj = $a_parent_obj;
                $this->parent_cmd = $a_parent_cmd;
                $this->buttons = array();
                $this->header_commands = array();
                $this->multi = array();
                $this->hidden_inputs = array();
                $this->formname = "table_" . $this->unique_id;
                $this->tpl = new ilTemplate("tpl.table2.html", true, true, "Services/Table");
 
                $lng->loadLanguageModule('tbl');
 
                if(!$a_template_context)
                {
                        $a_template_context = $this->getId();
                }
                $this->setContext($a_template_context);
 
                // activate export mode
                if(isset($_GET[$this->prefix."_xpt"]))
                {
               $this->export_mode = (int)$_GET[$this->prefix."_xpt"];
                }
 
                // template handling
                if(isset($_GET[$this->prefix."_tpl"]))
        {
                        $this->restoreTemplate($_GET[$this->prefix."_tpl"]);
                }
 
                $this->determineLimit();
                $this->setIsDataTable(true);
                $this->setEnableNumInfo(true);
                $this->determineSelectedColumns();
        }

References $_GET, $lng, $unique_id, determineLimit(), determineSelectedColumns(), getId(), restoreTemplate(), setContext(), setEnableNumInfo(), and setIsDataTable().

Here is the call graph for this function:

Member Function Documentation

◆ addColumn()

ilTable2GUI::addColumn	(	$a_text,
		$a_sort_field = `""`,
		$a_width = `""`,
		$a_is_checkbox_action_column = `false`,
		$a_class = `""`,
		$a_tooltip = `""`,
		$a_tooltip_with_html = `false`
	)

final

Add a column to the header.

Parameters

string	Text
string	Sort field name (corresponds to data array field)
string	Width string

Definition at line 1328 of file class.ilTable2GUI.php.

        {
                $this->column[] = array(
                        "text" => $a_text,
                        "sort_field" => $a_sort_field,
                        "width" => $a_width,
                        "is_checkbox_action_column" => $a_is_checkbox_action_column,
                        "class" => $a_class,
                        "tooltip" => $a_tooltip,
                        "tooltip_html" => (bool)$a_tooltip_with_html
                        );
                if ($a_sort_field != "")
                {
                        $this->sortable_fields[] = $a_sort_field;
                }
                $this->column_count = count($this->column);
        }

Here is the caller graph for this function:

◆ addCommandButton()

ilTable2GUI::addCommandButton	(	$a_cmd,
		$a_text,
		$a_onclick = `''`,
		$a_id = `""`,
		$a_class = `null`
	)

Add Command button.

Parameters

string	Command
string	Text

Definition at line 1207 of file class.ilTable2GUI.php.

        {
                $this->buttons[] = array("cmd" => $a_cmd, "text" => $a_text, 'onclick' => $a_onclick,
                        "id" => $a_id, "class" => $a_class);
        }

Here is the caller graph for this function:

◆ addCommandButtonInstance()

ilTable2GUI::addCommandButtonInstance ( ilButtonBase $a_button )

Add Command button instance.

Parameters

ilButtonBase $a_button

Definition at line 1218 of file class.ilTable2GUI.php.

        {
                $this->buttons[] = $a_button;
        }

Referenced by ilSurveyCodesTableGUI\__construct(), ilAccountCodesTableGUI\__construct(), ilWikiExportOrderTableGUI\__construct(), ilListOfQuestionsTableGUI\init(), and assFileUploadFileTableGUI\initCommand().

Here is the caller graph for this function:

◆ addFilterItem()

ilTable2GUI::addFilterItem	(	$a_input_item,
		$a_optional = `false`
	)

final

Add filter item.

Filter items are property form inputs that implement the ilTableFilterItem interface

Definition at line 616 of file class.ilTable2GUI.php.

        {
                $a_input_item->setParent($this);
                if (!$a_optional)
                {
                        $this->filters[] = $a_input_item;
                }
                else
                {
                        $this->optional_filters[] = $a_input_item;
                }
                
                // restore filter values (from stored view)
                if($this->restore_filter)
                {                       
                        if(array_key_exists($a_input_item->getFieldId(), $this->restore_filter_values))
                        {
                                $this->setFilterValue($a_input_item, $this->restore_filter_values[$a_input_item->getFieldId()]);
                        }
                        else
                        {                               
                                $this->setFilterValue($a_input_item, null); // #14949
                        }
                }
        }

Here is the caller graph for this function:

◆ addFilterItemByMetaType()

ilTable2GUI::addFilterItemByMetaType	(	$id,
		$type = `self::FILTER_TEXT`,
		$a_optional = `false`,
		$caption = `NULL`
	)

Add filter by standard type.

Parameters

string	$id
int	$type
bool	$a_optional
string	$caption

Returns: object

Definition at line 651 of file class.ilTable2GUI.php.

        {
                global $lng;
 
                if(!$caption)
                {
                        $caption = $lng->txt($id);
                }
 
                include_once("./Services/Form/classes/class.ilPropertyFormGUI.php");
 
                switch($type)
                {
                        case self::FILTER_SELECT:
                                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                                $item = new ilSelectInputGUI($caption, $id);
                                break;
 
                        case self::FILTER_DATE:
                                include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                $item = new ilDateTimeInputGUI($caption, $id);                  
                                break;
 
                        case self::FILTER_TEXT:
                                include_once("./Services/Form/classes/class.ilTextInputGUI.php");
                                $item = new ilTextInputGUI($caption, $id);
                                $item->setMaxLength(64);
                                $item->setSize(20);
                                // $item->setSubmitFormOnEnter(true);
                                break;
 
                        case self::FILTER_LANGUAGE:
                                $lng->loadLanguageModule("meta");
                                include_once("./Services/Form/classes/class.ilSelectInputGUI.php");
                                $item = new ilSelectInputGUI($caption, $id);
                                $options = array("" => $lng->txt("trac_all"));
                                foreach ($lng->getInstalledLanguages() as $lang_key)
                                {
                                        $options[$lang_key] = $lng->txt("meta_l_".$lang_key);
                                }
                                $item->setOptions($options);
                                break;
 
                        case self::FILTER_NUMBER_RANGE:
                                include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                include_once("./Services/Form/classes/class.ilNumberInputGUI.php");
                                $item = new ilCombinationInputGUI($caption, $id);
                                $combi_item = new ilNumberInputGUI("", $id."_from");
                                $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                $combi_item = new ilNumberInputGUI("", $id."_to");
                                $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                $item->setMaxLength(7);
                                $item->setSize(20);
                                break;
 
                        case self::FILTER_DATE_RANGE:
                                include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                $item = new ilCombinationInputGUI($caption, $id);
                                $combi_item = new ilDateTimeInputGUI("", $id."_from");                          
                                $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                $combi_item = new ilDateTimeInputGUI("", $id."_to");
                                $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);                          
                                break;
                        
                        case self::FILTER_DATETIME_RANGE:
                                include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                include_once("./Services/Form/classes/class.ilDateTimeInputGUI.php");
                                $item = new ilCombinationInputGUI($caption, $id);
                                $combi_item = new ilDateTimeInputGUI("", $id."_from");
                                $combi_item->setShowTime(true);
                                $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                $combi_item = new ilDateTimeInputGUI("", $id."_to");
                                $combi_item->setShowTime(true);
                                $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);                          
                                break;
 
                        case self::FILTER_DURATION_RANGE:
                                $lng->loadLanguageModule("form");
                                include_once("./Services/Form/classes/class.ilCombinationInputGUI.php");
                                include_once("./Services/Form/classes/class.ilDurationInputGUI.php");
                                $item = new ilCombinationInputGUI($caption, $id);
                                $combi_item = new ilDurationInputGUI("", $id."_from");
                                $combi_item->setShowMonths(false);
                                $combi_item->setShowDays(true);
                                $combi_item->setShowSeconds(true);
                                $item->addCombinationItem("from", $combi_item, $lng->txt("from"));
                                $combi_item = new ilDurationInputGUI("", $id."_to");
                                $combi_item->setShowMonths(false);
                                $combi_item->setShowDays(true);
                                $combi_item->setShowSeconds(true);
                                $item->addCombinationItem("to", $combi_item, $lng->txt("to"));
                                $item->setComparisonMode(ilCombinationInputGUI::COMPARISON_ASCENDING);
                                break;
                        
                        default:
                                return false;
                }
 
                $this->addFilterItem($item, $a_optional);
            $item->readFromSession();
                return $item;
        }

References $lng, $options, addFilterItem(), ilCombinationInputGUI\COMPARISON_ASCENDING, FILTER_DATE, FILTER_DATE_RANGE, FILTER_DATETIME_RANGE, FILTER_DURATION_RANGE, FILTER_LANGUAGE, FILTER_NUMBER_RANGE, FILTER_SELECT, and FILTER_TEXT.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addHeaderCommand()

ilTable2GUI::addHeaderCommand	(	$a_href,
		$a_text,
		$a_target = `""`,
		$a_img = `""`
	)

Add Header Command (Link) (Image needed for now)

Parameters

string	href
string	text

Definition at line 1295 of file class.ilTable2GUI.php.

        {
                $this->header_commands[] = array("href" => $a_href, "text" => $a_text,
                        "target" => $a_target, "img" => $a_img);
        }

◆ addHiddenInput()

ilTable2GUI::addHiddenInput	(	$a_name,
		$a_value
	)

Add Hidden Input field.

Parameters

string	Name
string	Value

Definition at line 1284 of file class.ilTable2GUI.php.

        {
                $this->hidden_inputs[] = array("name" => $a_name, "value" => $a_value);
        }

Referenced by ilPasteStyleCharacteristicTableGUI\__construct(), addMultiItemSelectionButton(), ilTestQuestionBrowserTableGUI\handleParameters(), and arDeleteGUI\initCommandButtons().

Here is the caller graph for this function:

◆ addMultiCommand()

ilTable2GUI::addMultiCommand	(	$a_cmd,
		$a_text
	)

Add Command button.

Parameters

string	Command
string	Text

Definition at line 1273 of file class.ilTable2GUI.php.

        {
                $this->multi[] = array("cmd" => $a_cmd, "text" => $a_text);
        }

Here is the caller graph for this function:

◆ addMultiItemSelectionButton()

ilTable2GUI::addMultiItemSelectionButton	(	$a_sel_var,
		$a_options,
		$a_cmd,
		$a_text,
		$a_default_selection = `''`
	)

Add Selection List + Command button for selected items.

Parameters

string	selection input variable name
array	selection options ("value" => text")
string	command
string	button text

Definition at line 1248 of file class.ilTable2GUI.php.

        {
                $this->mi_sel_buttons[] = array("sel_var" => $a_sel_var, "options" => $a_options, "selected" => $a_default_selection, "cmd" => $a_cmd, "text" => $a_text);
                $this->addHiddenInput("cmd_sv[".$a_cmd."]", $a_sel_var);
        }

References addHiddenInput().

Referenced by ilCourseParticipantsGroupsTableGUI\__construct(), ilRepositoryUserResultTableGUI\initMultiCommands(), and arIndexTableGUI\initMultiItemActionsButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addSelectionButton()

ilTable2GUI::addSelectionButton	(	$a_sel_var,
		$a_options,
		$a_cmd,
		$a_text,
		$a_default_selection = `''`
	)

Add Selection List + Command button.

Parameters

string	selection input variable name
array	selection options ("value" => text")
string	command
string	button text

Deprecated:

Definition at line 1233 of file class.ilTable2GUI.php.

        {
echo "ilTabl2GUI->addSelectionButton() has been deprecated with 4.2. Please try to move the drop-down to ilToolbarGUI.";
//              $this->sel_buttons[] = array("sel_var" => $a_sel_var, "options" => $a_options, "selected" => $a_default_selection, "cmd" => $a_cmd, "text" => $a_text);
        }

◆ clearCommandButtons()

ilTable2GUI::clearCommandButtons ( )

Definition at line 1196 of file class.ilTable2GUI.php.

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

Referenced by ilObjectCustomUserFieldsTableGUI\parse().

Here is the caller graph for this function:

◆ dataExists()

ilTable2GUI::dataExists ( )

final

Definition at line 590 of file class.ilTable2GUI.php.

        {
                if (is_array($this->row_data))
                {
                        if (count($this->row_data) > 0)
                        {
                                return true;
                        }
                }
                return false;
        }

Referenced by exportData(), ilDclRecordListTableGUI\exportData(), fillActionRow(), fillFooter(), getHTML(), ilMultilingualismTableGUI\prepareOutput(), ilObjectTranslation2TableGUI\prepareOutput(), and ilObjectTranslationTableGUI\prepareOutput().

Here is the caller graph for this function:

◆ deleteTemplate()

ilTable2GUI::deleteTemplate ( $a_name )

Delete template.

Parameters

string $a_name

Returns: bool

Definition at line 3109 of file class.ilTable2GUI.php.

        {
                global $ilUser;
                
                $a_name = ilUtil::prepareFormOutput($a_name, true);
 
                if(trim($a_name) && $this->getContext() != "" && is_object($ilUser) && $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        include_once("./Services/Table/classes/class.ilTableTemplatesStorage.php");
                        $storage = new ilTableTemplatesStorage();
                        $storage->delete($this->getContext(), $ilUser->getId(), $a_name);
                        return true;
                }
                return false;
        }

References $ilUser, getContext(), and ilUtil\prepareFormOutput().

Referenced by fillFooter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineLimit()

ilTable2GUI::determineLimit ( )

Determine the limit.

Definition at line 173 of file class.ilTable2GUI.php.

        {
                global $ilUser;
 
                if ($this->limit_determined)
                {
                        return;
                }
 
                $limit = 0;
                if (isset($_GET[$this->prefix."_trows"]))
                {
                        $this->storeProperty("rows", $_GET[$this->prefix."_trows"]);
                        $limit = $_GET[$this->prefix."_trows"];
                        $this->resetOffset();
                }
 
                if ($limit == 0)
                {
                        $rows = $this->loadProperty("rows");
                        if ($rows > 0)
                        {
                                $limit = $rows;
                        }
                        else
                        {
                                if (is_object($ilUser))
                                {
                                        $limit = $ilUser->getPref("hits_per_page");
                                }
                                else
                                {
                                        $limit = 40;
                                }
                        }
                }
 
                $this->setLimit($limit);
                $this->limit_determined = true;
        }

References $_GET, $ilUser, ilTableGUI\$limit, loadProperty(), resetOffset(), setLimit(), and storeProperty().

Referenced by __construct(), ilStudyProgrammeIndividualPlanTableGUI\__construct(), ilStudyProgrammeMembersTableGUI\__construct(), getCurrentState(), and arIndexTableGUI\setOrderAndSegmentation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineOffsetAndOrder()

ilTable2GUI::determineOffsetAndOrder ( $a_omit_offset = false )

Determine offset and order.

Definition at line 1510 of file class.ilTable2GUI.php.

        {
                global $ilUser;
 
                if ($this->nav_determined)
                {
                        return true;
                }
 
                if ($_POST[$this->getNavParameter()."1"] != "")
                {
                        if ($_POST[$this->getNavParameter()."1"] != $_POST[$this->getNavParameter()])
                        {
                                $this->nav_value = $_POST[$this->getNavParameter()."1"];
                        }
                        else if ($_POST[$this->getNavParameter()."2"] != $_POST[$this->getNavParameter()])
                        {
                                $this->nav_value = $_POST[$this->getNavParameter()."2"];
                        }
                }
                elseif($_GET[$this->getNavParameter()])
                {
                        $this->nav_value = $_GET[$this->getNavParameter()];
                }
                elseif($_SESSION[$this->getNavParameter()] != "")
                {
                        $this->nav_value = $_SESSION[$this->getNavParameter()];
                }
                
                if ($this->nav_value == "" && $this->getId() != "" && $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        $order = $this->loadProperty("order");
                        if (in_array($order, $this->sortable_fields))
                        {
                                $direction = $this->loadProperty("direction");
                        }
                        else
                        {
                                $direction = $this->getDefaultOrderDirection();
                        }
                        // get order and direction from db
                        $this->nav_value =
                                $order.":".
                                $direction.":".
                                $this->loadProperty("offset");
                }
                $nav = explode(":", $this->nav_value);
                
                // $nav[0] is order by
                $this->setOrderField(($nav[0] != "") ? $nav[0] : $this->getDefaultOrderField());
                $this->setOrderDirection(($nav[1] != "") ? $nav[1] : $this->getDefaultOrderDirection());
 
                if (!$a_omit_offset)
                {
                        // #8904: offset must be discarded when no limit is given
                        if(!$this->getExternalSegmentation() && $this->limit_determined && $this->limit == 9999)
                        {
                                $this->resetOffset(true);
                        }
                        else if (!$this->getExternalSegmentation() && $nav[2] >= $this->max_count)
                        {
                                $this->resetOffset(true);
                        }
                        else
                        {
                                $this->setOffset($nav[2]);
                        }
                }
 
                if (!$a_omit_offset)
                {
                        $this->nav_determined = true;
                }
        }

References $_GET, $_POST, $_SESSION, $ilUser, getDefaultOrderDirection(), getDefaultOrderField(), getExternalSegmentation(), getId(), getNavParameter(), loadProperty(), resetOffset(), ilTableGUI\setOffset(), ilTableGUI\setOrderDirection(), and setOrderField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineSelectedColumns()

ilTable2GUI::determineSelectedColumns ( )

Determine selected columns.

Definition at line 227 of file class.ilTable2GUI.php.

        {
                if ($this->columns_determined)
                {
                        return;
                }
        
                $old_sel = $this->loadProperty("selfields");
                
                $stored = false;
                if ($old_sel != "")
                {
                        $sel_fields =
                                @unserialize($old_sel);
                        $stored = true;
                }
                if(!is_array($sel_fields))
                {
                        $stored = false;
                        $sel_fields = array();
                }
                
                $this->selected_columns = array();
                $set = false;
                foreach ($this->getSelectableColumns() as $k => $c)
                {
                        $this->selected_column[$k] = false;
                        
                        $new_column = ($sel_fields[$k] === NULL);
 
                        if ($_POST["tblfsh".$this->getId()])
                        {
                                $set = true;
                                if (is_array($_POST["tblfs".$this->getId()]) && in_array($k, $_POST["tblfs".$this->getId()]))
                                {
                                        $this->selected_column[$k] = true;
                                }
                        }
                        else if ($stored && !$new_column)       // take stored values
                        {
                                $this->selected_column[$k] = $sel_fields[$k]; 
                        }
                        else    // take default values
                        {
                                if ($new_column)
                                {
                                        $set = true;
                                }                       
                                if ($c["default"])
                                {
                                        $this->selected_column[$k] = true;
                                }                       
                        }
                }
                
                if ($old_sel != serialize($this->selected_column) && $set)
                {
                        $this->storeProperty("selfields", serialize($this->selected_column));
                }
 
                $this->columns_determined = true;
        }

References $_POST, getId(), getSelectableColumns(), loadProperty(), and storeProperty().

Referenced by __construct(), and getCurrentState().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ determineSelectedFilters()

ilTable2GUI::determineSelectedFilters ( )

Determine selected filters.

Parameters

return

Definition at line 865 of file class.ilTable2GUI.php.

        {
                if ($this->filters_determined)
                {
                        return;
                }
 
                $old_sel = $this->loadProperty("selfilters");
                $stored = false;
                if ($old_sel != "")
                {
                        $sel_filters =
                                @unserialize($old_sel);
                        $stored = true;
                }
                if(!is_array($sel_filters))
                {
                        $stored = false;
                        $sel_filters = array();
                }
 
                $this->selected_filter = array();
                $set = false;
                foreach ($this->getFilterItems(true) as $item)
                {
                        $k = $item->getPostVar();
                        
                        $this->selected_filter[$k] = false;
 
                        if ($_POST["tblfsf".$this->getId()])
                        {
                                $set = true;
                                if (is_array($_POST["tblff".$this->getId()]) && in_array($k, $_POST["tblff".$this->getId()]))
                                {
                                        $this->selected_filter[$k] = true;
                                }
                                else
                                {
                                        $item->setValue(NULL);
                                        $item->writeToSession();
                                }
                        }
                        else if ($stored)       // take stored values
                        {
                                $this->selected_filter[$k] = $sel_filters[$k];
                        }
                }
 
                if ($old_sel != serialize($this->selected_filter) && $set)
                {
                        $this->storeProperty("selfilters", serialize($this->selected_filter));
                }
 
                $this->filters_determined = true;
        }

References $_POST, getFilterItems(), getId(), loadProperty(), and storeProperty().

Referenced by ilLPTableBaseGUI\executeCommand(), getCurrentState(), ilTermsOfServiceTableGUI\populate(), and renderFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilTable2GUI::executeCommand ( )

Execute command.

Reimplemented in ilTestQuestionBrowserTableGUI, ilAssQuestionSkillUsagesTableGUI, and ilLPTableBaseGUI.

Definition at line 323 of file class.ilTable2GUI.php.

        {
                global $ilCtrl;
                
                $next_class = $ilCtrl->getNextClass($this);
                $cmd = $ilCtrl->getCmd();
                        
                switch($next_class)
                {
                        case 'ilformpropertydispatchgui':
                                include_once './Services/Form/classes/class.ilFormPropertyDispatchGUI.php';
                                $form_prop_dispatch = new ilFormPropertyDispatchGUI();
                                $this->initFilter();
                                $item = $this->getFilterItemByPostVar($_GET["postvar"]);
                                $form_prop_dispatch->setItem($item);
                                return $ilCtrl->forwardCommand($form_prop_dispatch);
                                break;
 
                }
                return false;
        }

References $_GET, $cmd, $ilCtrl, getFilterItemByPostVar(), and initFilter().

Here is the call graph for this function:

◆ exportData()

ilTable2GUI::exportData	(	$format,
		$send = `false`
	)

Export and optionally send current table data.

Parameters

int $format

Definition at line 3204 of file class.ilTable2GUI.php.

        {
                if($this->dataExists())
                {
                        // #9640: sort
                        if (!$this->getExternalSorting() && $this->enabled["sort"])
                        {                               
                                $this->determineOffsetAndOrder(true);
                                
                                $this->row_data = ilUtil::sortArray($this->row_data, $this->getOrderField(),
                                        $this->getOrderDirection(), $this->numericOrdering($this->getOrderField()));
                        }
                        
                        $filename = "export";
 
                        switch($format)
                        {
                                case self::EXPORT_EXCEL:
                                        include_once "./Services/Excel/classes/class.ilExcel.php";
                                        $excel = new ilExcel();                 
                                        $excel->addSheet($this->title 
                                                ? $this->title
                                                : $this->lng->txt("export"));           
                                        $row = 1;
                                        
                                        ob_start();
                                        $this->fillMetaExcel($excel, $row); // row must be increment in fillMetaExcel()! (optional method)
                                        
                                        // #14813
                                        $pre = $row;
                                        $this->fillHeaderExcel($excel, $row); // row should NOT be incremented in fillHeaderExcel()! (required method)
                                        if($pre == $row)
                                        {
                                                $row++; 
                                        }
                                        
                                        foreach($this->row_data as $set)
                                        {                                               
                                                $this->fillRowExcel($excel, $row, $set);
                                                $row++; // #14760
                                        }
                                        ob_end_clean();
 
                                        if($send)
                                        {
                                                $excel->sendToClient($filename);
                                        }
                                        else
                                        {
                                                $excel->writeToFile($filename);
                                        }
                                        break;
 
                                case self::EXPORT_CSV:
                                        include_once "./Services/Utilities/classes/class.ilCSVWriter.php";
                                    $csv = new ilCSVWriter();
                                        $csv->setSeparator(";");
 
                                        ob_start();
                                        $this->fillMetaCSV($csv);
                                        $this->fillHeaderCSV($csv);
                                        foreach($this->row_data as $set)
                                        {
                                                $this->fillRowCSV($csv, $set);
                                        }
                                        ob_end_clean();
 
                                        if($send)
                                        {
                                                $filename .= ".csv";
                                                header("Content-type: text/comma-separated-values");
                                                header("Content-Disposition: attachment; filename=\"".$filename."\"");
                                                header("Expires: 0");
                                                header("Cache-Control: must-revalidate, post-check=0,pre-check=0");
                                                header("Pragma: public");
                                                echo $csv->getCSVString();
 
                                        }
                                        else
                                        {
                                                file_put_contents($filename, $csv->getCSVString());
                                        }
                                        break;
                        }
                                   
                        if($send)
                        {
                                exit();
                        }
                }
        }

References $filename, $row, dataExists(), determineOffsetAndOrder(), exit, EXPORT_CSV, EXPORT_EXCEL, fillHeaderCSV(), fillHeaderExcel(), fillMetaCSV(), fillMetaExcel(), fillRowCSV(), fillRowExcel(), getExternalSorting(), ilTableGUI\getOrderDirection(), getOrderField(), numericOrdering(), and ilUtil\sortArray().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillActionRow()

ilTable2GUI::fillActionRow ( )

Fill Action Row.

Definition at line 2603 of file class.ilTable2GUI.php.

        {
                global $lng;
                
                // action row
                $action_row = false;
                $arrow = false;
                
                // add selection buttons
                if (count($this->sel_buttons) > 0)
                {
                        foreach ($this->sel_buttons as $button)
                        {
                                $this->tpl->setCurrentBlock("sel_button");
                                $this->tpl->setVariable("SBUTTON_SELECT", 
                                        ilUtil::formSelect($button["selected"], $button["sel_var"],
                                                $button["options"], false, true));
                                $this->tpl->setVariable("SBTN_NAME", $button["cmd"]);
                                $this->tpl->setVariable("SBTN_VALUE", $button["text"]);
                                $this->tpl->parseCurrentBlock();
                                
                                if ($this->getTopCommands())
                                {
                                        $this->tpl->setCurrentBlock("sel_top_button");
                                        $this->tpl->setVariable("SBUTTON_SELECT", 
                                                ilUtil::formSelect($button["selected"], $button["sel_var"],
                                                        $button["options"], false, true));
                                        $this->tpl->setVariable("SBTN_NAME", $button["cmd"]);
                                        $this->tpl->setVariable("SBTN_VALUE", $button["text"]);
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                        $buttons = true;
                        $action_row = true;
                }
                $this->sel_buttons[] = array("options" => $a_options, "cmd" => $a_cmd, "text" => $a_text);
                
                // add buttons
                if (count($this->buttons) > 0)
                {
                        foreach ($this->buttons as $button)
                        {
                                if(!is_array($button))
                                {
                                        if($button instanceof ilButtonBase)
                                        {       
                                                $this->tpl->setVariable('BUTTON_OBJ', $button->render());       
                                                
                                                // this will remove id - should be unique
                                                $button = clone $button;
                                                                                                                                                
                                                $this->tpl->setVariable('BUTTON_TOP_OBJ', $button->render());
                                        }
                                        continue;
                                }
                                
                                if (strlen($button['onclick']))
                                {
                                        $this->tpl->setCurrentBlock('cmdonclick');
                                        $this->tpl->setVariable('CMD_ONCLICK', $button['onclick']);
                                        $this->tpl->parseCurrentBlock();
                                }
                                $this->tpl->setCurrentBlock("plain_button");
                                if ($button["id"] != "")
                                {
                                        $this->tpl->setVariable("PBID", ' id="'.$button["id"].'" ');
                                }                               
                                if ($button["class"] != "")
                                {
                                        $this->tpl->setVariable("PBBT_CLASS", ' '.$button["class"]);
                                }
                                $this->tpl->setVariable("PBTN_NAME", $button["cmd"]);
                                $this->tpl->setVariable("PBTN_VALUE", $button["text"]);
                                $this->tpl->parseCurrentBlock();
                                
                                if ($this->getTopCommands())
                                {
                                        if (strlen($button['onclick']))
                                        {
                                                $this->tpl->setCurrentBlock('top_cmdonclick');
                                                $this->tpl->setVariable('CMD_ONCLICK', $button['onclick']);
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        $this->tpl->setCurrentBlock("plain_top_button");
                                        $this->tpl->setVariable("PBTN_NAME", $button["cmd"]);
                                        $this->tpl->setVariable("PBTN_VALUE", $button["text"]);
                                        if ($button["class"] != "")
                                        {
                                                $this->tpl->setVariable("PBBT_CLASS", ' '.$button["class"]);
                                        }
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                        
                        $buttons = true;
                        $action_row = true;
                }
                
                // multi selection
                if(count($this->mi_sel_buttons))
                {
                        foreach ($this->mi_sel_buttons as $button)
                        {
                                $this->tpl->setCurrentBlock("mi_sel_button");
                                $this->tpl->setVariable("MI_BUTTON_SELECT", 
                                        ilUtil::formSelect($button["selected"], $button["sel_var"],
                                                $button["options"], false, true));
                                $this->tpl->setVariable("MI_BTN_NAME", $button["cmd"]);
                                $this->tpl->setVariable("MI_BTN_VALUE", $button["text"]);
                                $this->tpl->parseCurrentBlock();
                                
                                if ($this->getTopCommands())
                                {
                                        $this->tpl->setCurrentBlock("mi_top_sel_button");
                                        $this->tpl->setVariable("MI_BUTTON_SELECT", 
                                                ilUtil::formSelect($button["selected"], $button["sel_var"]."_2",
                                                        $button["options"], false, true));
                                        $this->tpl->setVariable("MI_BTN_NAME", $button["cmd"]);
                                        $this->tpl->setVariable("MI_BTN_VALUE", $button["text"]);
                                        $this->tpl->parseCurrentBlock();
                                }
 
                        }
                        $arrow = true;
                        $action_row = true;
                }
                
                
                if (count($this->multi) > 1 && $this->dataExists())
                {
                        if($this->enable_command_for_all && $this->max_count <= self::getAllCommandLimit())
                        {
                                $this->tpl->setCurrentBlock("tbl_cmd_select_all");
                                $this->tpl->setVariable("TXT_SELECT_CMD_ALL", $lng->txt("all_objects"));
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        $this->tpl->setCurrentBlock("tbl_cmd_select");
                        $sel = array();
                        foreach ($this->multi as $mc)
                        {
                                $sel[$mc["cmd"]] = $mc["text"];
                        }
                        $this->tpl->setVariable("SELECT_CMDS",
                                ilUtil::formSelect("", "selected_cmd", $sel, false, true));
                        $this->tpl->setVariable("TXT_EXECUTE", $lng->txt("execute"));
                        $this->tpl->parseCurrentBlock();
                        $arrow = true;
                        $action_row = true;
                        
                        if ($this->getTopCommands())
                        {
                                if($this->enable_command_for_all && $this->max_count <= self::getAllCommandLimit())
                                {
                                        $this->tpl->setCurrentBlock("tbl_top_cmd_select_all");
                                        $this->tpl->setVariable("TXT_SELECT_CMD_ALL", $lng->txt("all_objects"));
                                        $this->tpl->parseCurrentBlock();
                                }
                                
                                $this->tpl->setCurrentBlock("tbl_top_cmd_select");
                                $sel = array();
                                foreach ($this->multi as $mc)
                                {
                                        $sel[$mc["cmd"]] = $mc["text"];
                                }
                                $this->tpl->setVariable("SELECT_CMDS",
                                        ilUtil::formSelect("", "selected_cmd2", $sel, false, true));
                                $this->tpl->setVariable("TXT_EXECUTE", $lng->txt("execute"));
                                $this->tpl->parseCurrentBlock();
                        }                       
                }
                elseif(count($this->multi) == 1  && $this->dataExists())
                {
                        $this->tpl->setCurrentBlock("tbl_single_cmd");
                        $sel = array();
                        foreach ($this->multi as $mc)
                        {
                                $cmd = $mc['cmd'];
                                $txt = $mc['text'];
                        }
                        $this->tpl->setVariable("TXT_SINGLE_CMD",$txt);
                        $this->tpl->setVariable("SINGLE_CMD",$cmd);
                        $this->tpl->parseCurrentBlock();
                        $arrow = true;
                        $action_row = true;
                        
                        if ($this->getTopCommands())
                        {
                                $this->tpl->setCurrentBlock("tbl_top_single_cmd");
                                $sel = array();
                                foreach ($this->multi as $mc)
                                {
                                        $cmd = $mc['cmd'];
                                        $txt = $mc['text'];
                                }
                                $this->tpl->setVariable("TXT_SINGLE_CMD",$txt);
                                $this->tpl->setVariable("SINGLE_CMD",$cmd);
                                $this->tpl->parseCurrentBlock();
                        }
                }
 
                if ($arrow)
                {
                        $this->tpl->setCurrentBlock("tbl_action_img_arrow");
                        $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_downright.svg"));
                        $this->tpl->setVariable("ALT_ARROW", $lng->txt("action"));
                        $this->tpl->parseCurrentBlock();
 
                        if ($this->getTopCommands())
                        {
                                $this->tpl->setCurrentBlock("tbl_top_action_img_arrow");
                                $this->tpl->setVariable("IMG_ARROW", ilUtil::getImagePath("arrow_upright.svg"));
                                $this->tpl->setVariable("ALT_ARROW", $lng->txt("action"));
                                $this->tpl->parseCurrentBlock();
                        }
                }
                
                if ($action_row)
                {
                        $this->tpl->setCurrentBlock("tbl_action_row");
                        $this->tpl->parseCurrentBlock();
                        if ($this->getTopCommands())
                        {
                                $this->tpl->setCurrentBlock("tbl_top_action_row");
                                $this->tpl->parseCurrentBlock();
                        }
                }
        }

References $cmd, $lng, $txt, dataExists(), ilUtil\formSelect(), ilUtil\getImagePath(), and getTopCommands().

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillFooter()

ilTable2GUI::fillFooter ( )

Fill footer row.

Definition at line 2152 of file class.ilTable2GUI.php.

        {
                global $lng, $ilCtrl, $ilUser;
 
                $footer = false;
                
                // select all checkbox
                if ((strlen($this->getFormName())) && (strlen($this->getSelectAllCheckbox())) && $this->dataExists())
                {
                        $this->tpl->setCurrentBlock("select_all_checkbox");
                        $this->tpl->setVariable("SELECT_ALL_TXT_SELECT_ALL", $lng->txt("select_all"));
                        $this->tpl->setVariable("SELECT_ALL_CHECKBOX_NAME", $this->getSelectAllCheckbox());
                        $this->tpl->setVariable("SELECT_ALL_FORM_NAME", $this->getFormName());
                        $this->tpl->setVariable("CHECKBOXNAME", "chb_select_all_" . $this->unique_id);
                        $this->tpl->parseCurrentBlock();
                }
                
                // table footer numinfo
                if ($this->enabled["numinfo"] && $this->enabled["footer"])
                {
                        $start = $this->offset + 1;                             // compute num info
                        if (!$this->dataExists())
                        {
                                $start = 0;
                        }
                        $end = $this->offset + $this->limit;
                        
                        if ($end > $this->max_count or $this->limit == 0)
                        {
                                $end = $this->max_count;
                        }
                        
                        if ($this->max_count > 0)
                        {
                                if ($this->lang_support)
                                {
                                        $numinfo = "(".$start." - ".$end." ".strtolower($this->lng->txt("of"))." ".$this->max_count.")";
                                }
                                else
                                {
                                        $numinfo = "(".$start." - ".$end." of ".$this->max_count.")";
                                }
                        }
                        if ($this->max_count > 0)
                        {
                                if ($this->getEnableNumInfo())
                                {
                                        $this->tpl->setCurrentBlock("tbl_footer_numinfo");
                                        $this->tpl->setVariable("NUMINFO", $numinfo);
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                        $footer = true;
                }
 
                // table footer linkbar
                if ($this->enabled["linkbar"] && $this->enabled["footer"] && $this->limit  != 0
                         && $this->max_count > 0)
                {
                        $layout = array(
                                                        "link"  => $this->footer_style,
                                                        "prev"  => $this->footer_previous,
                                                        "next"  => $this->footer_next,
                                                        );
                        //if (!$this->getDisplayAsBlock())
                        //{
                                $linkbar = $this->getLinkbar("1");
                                $this->tpl->setCurrentBlock("tbl_footer_linkbar");
                                $this->tpl->setVariable("LINKBAR", $linkbar);
                                $this->tpl->parseCurrentBlock();
                                $linkbar = true;
                        //}
                        $footer = true;
                }
                
                // column selector
                if (count($this->getSelectableColumns()) > 0)
                {
                        $items = array();
                        foreach ($this->getSelectableColumns() as $k => $c)
                        {
                                $items[$k] = array("txt" => $c["txt"],
                                        "selected" => $this->isColumnSelected($k));
                        }
                        include_once("./Services/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php");
                        $cb_over = new ilCheckboxListOverlayGUI("tbl_".$this->getId());
                        $cb_over->setLinkTitle($lng->txt("columns"));
                        $cb_over->setItems($items);
                        //$cb_over->setUrl("./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
                        //              $this->getId()."&cmd=saveSelectedFields&user_id=".$ilUser->getId());
                        $cb_over->setFormCmd($this->getParentCmd());
                        $cb_over->setFieldVar("tblfs".$this->getId());
                        $cb_over->setHiddenVar("tblfsh".$this->getId());
                        $cb_over->setSelectionHeaderClass("ilTableMenuItem");
                        $column_selector = $cb_over->getHTML();
                        $footer = true;
                }
 
                if($this->getShowTemplates() && is_object($ilUser))
                {
                        // template handling
                        if(isset($_REQUEST["tbltplcrt"]) && $_REQUEST["tbltplcrt"])
                        {
                                if($this->saveTemplate($_REQUEST["tbltplcrt"]))
                                {
                                        ilUtil::sendSuccess($lng->txt("tbl_template_created"));
                                }
                        }
                        else if(isset($_REQUEST["tbltpldel"]) && $_REQUEST["tbltpldel"])
                        {
                                if($this->deleteTemplate($_REQUEST["tbltpldel"]))
                                {
                                        ilUtil::sendSuccess($lng->txt("tbl_template_deleted"));
                                }
                        }
 
                        $create_id = "template_create_overlay_".$this->getId();
                        $delete_id = "template_delete_overlay_".$this->getId();
                        $list_id = "template_stg_".$this->getId();
 
                        include_once("./Services/Table/classes/class.ilTableTemplatesStorage.php");
                        $storage = new ilTableTemplatesStorage();
                        $templates = $storage->getNames($this->getContext(), $ilUser->getId());
                        
                        include_once("./Services/UIComponent/Overlay/classes/class.ilOverlayGUI.php");
 
                        // form to delete template
                        if(sizeof($templates))
                        {
                                $overlay = new ilOverlayGUI($delete_id);
                                $overlay->setTrigger($list_id."_delete");
                                $overlay->setAnchor("ilAdvSelListAnchorElement_".$list_id);
                                $overlay->setAutoHide(false);
                                $overlay->add();
 
                                $lng->loadLanguageModule("form");
                                $this->tpl->setCurrentBlock("template_editor_delete_item");
                                $this->tpl->setVariable("TEMPLATE_DELETE_OPTION_VALUE", "");
                                $this->tpl->setVariable("TEMPLATE_DELETE_OPTION", "- ".$lng->txt("form_please_select")." -");
                                $this->tpl->parseCurrentBlock();
                                foreach($templates as $name)
                                {
                                        $this->tpl->setVariable("TEMPLATE_DELETE_OPTION_VALUE", $name);
                                        $this->tpl->setVariable("TEMPLATE_DELETE_OPTION", $name);
                                        $this->tpl->parseCurrentBlock();
                                }
 
                                $this->tpl->setCurrentBlock("template_editor_delete");
                                $this->tpl->setVariable("TEMPLATE_DELETE_ID", $delete_id);
                                $this->tpl->setVariable("TXT_TEMPLATE_DELETE", $lng->txt("tbl_template_delete"));
                                $this->tpl->setVariable("TXT_TEMPLATE_DELETE_SUBMIT", $lng->txt("delete"));
                                $this->tpl->setVariable("TEMPLATE_DELETE_CMD", $this->parent_cmd);
                                $this->tpl->parseCurrentBlock();
                        }
 
 
                        // form to save new template
                        $overlay = new ilOverlayGUI($create_id);
                        $overlay->setTrigger($list_id."_create");
                        $overlay->setAnchor("ilAdvSelListAnchorElement_".$list_id);
                        $overlay->setAutoHide(false);
                        $overlay->add();
 
                        $this->tpl->setCurrentBlock("template_editor");
                        $this->tpl->setVariable("TEMPLATE_CREATE_ID", $create_id);
                        $this->tpl->setVariable("TXT_TEMPLATE_CREATE", $lng->txt("tbl_template_create"));
                        $this->tpl->setVariable("TXT_TEMPLATE_CREATE_SUBMIT", $lng->txt("save"));
                        $this->tpl->setVariable("TEMPLATE_CREATE_CMD", $this->parent_cmd);
                        $this->tpl->parseCurrentBlock();
 
                        // load saved template
                        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                        $alist = new ilAdvancedSelectionListGUI();
                        $alist->setId($list_id);
                        $alist->addItem($lng->txt("tbl_template_create"), "create", "#");
                        if(sizeof($templates))
                        {
                                $alist->addItem($lng->txt("tbl_template_delete"), "delete", "#");
                                foreach($templates as $name)
                                {
                                        $ilCtrl->setParameter($this->parent_obj, $this->prefix."_tpl", urlencode($name));
                                        $alist->addItem($name, $name, $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd));
                                        $ilCtrl->setParameter($this->parent_obj, $this->prefix."_tpl", "");
                                }
                        }
                        $alist->setListTitle($lng->txt("tbl_templates"));
                        $alist->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON);
                        $this->tpl->setVariable("TEMPLATE_SELECTOR", "&nbsp;".$alist->getHTML());
                }
 
                if ($footer)
                {
                        $this->tpl->setCurrentBlock("tbl_footer");
                        $this->tpl->setVariable("COLUMN_COUNT", $this->getColumnCount());
                        if ($this->getDisplayAsBlock())
                        {
                                $this->tpl->setVariable("BLK_CLASS", "Block");
                        }
                        $this->tpl->parseCurrentBlock();
                        
                        // top navigation, if number info or linkbar given
                        if ($numinfo != "" || $linkbar != "" || $column_selector != "" ||
                                count($this->filters) > 0 || count($this->optional_filters) > 0)
                        {
                                if (is_object($ilUser) && (count($this->filters) || count($this->optional_filters)))
                                {
                                        $this->tpl->setCurrentBlock("filter_activation");
                                        $this->tpl->setVariable("TXT_ACTIVATE_FILTER", $lng->txt("show_filter"));
                                        $this->tpl->setVariable("FILA_ID", $this->getId());
                                        if ($this->getId() != "")
                                        {
                                                $this->tpl->setVariable("SAVE_URLA", "./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
                                                        $this->getId()."&cmd=showFilter&user_id=".$ilUser->getId());
                                        }
                                        $this->tpl->parseCurrentBlock();
 
                                        
                                        if (!$this->getDisableFilterHiding())
                                        {
                                                $this->tpl->setCurrentBlock("filter_deactivation");
                                                $this->tpl->setVariable("TXT_HIDE", $lng->txt("hide_filter"));
                                                if ($this->getId() != "")
                                                {
                                                        $this->tpl->setVariable("SAVE_URL", "./ilias.php?baseClass=ilTablePropertiesStorage&table_id=".
                                                                $this->getId()."&cmd=hideFilter&user_id=".$ilUser->getId());
                                                        $this->tpl->setVariable("FILD_ID", $this->getId());
                                                }
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        
                                }
                                
                                if ($numinfo != "" && $this->getEnableNumInfo())
                                {
                                        $this->tpl->setCurrentBlock("top_numinfo");
                                        $this->tpl->setVariable("NUMINFO", $numinfo);
                                        $this->tpl->parseCurrentBlock();
                                }
                                if ($linkbar != "" && !$this->getDisplayAsBlock())
                                {
                                        $linkbar = $this->getLinkbar("2");
                                        $this->tpl->setCurrentBlock("top_linkbar");
                                        $this->tpl->setVariable("LINKBAR", $linkbar);
                                        $this->tpl->parseCurrentBlock();
                                }
                                
                                // column selector
                                $this->tpl->setVariable("COLUMN_SELECTOR", $column_selector);
                                
                                // row selector
                                if ($this->getShowRowsSelector() && 
                                        is_object($ilUser) &&
                                        $this->getId() &&
                                        !$this->rows_selector_off) // JF, 2014-10-27
                                {
                                        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                                        $alist = new ilAdvancedSelectionListGUI();
                                        $alist->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON);
                                        $alist->setId("sellst_rows_".$this->getId());
                                        $hpp = ($ilUser->getPref("hits_per_page") != 9999)
                                                ? $ilUser->getPref("hits_per_page")
                                                : $lng->txt("no_limit");
 
                                        $options = array(0 => $lng->txt("default")." (".$hpp.")",5 => 5, 10 => 10, 15 => 15, 20 => 20,
                                                                         30 => 30, 40 => 40, 50 => 50,
                                                                         100 => 100, 200 => 200, 400 => 400, 800 => 800);
                                        foreach ($options as $k => $v)
                                        {
                                                $ilCtrl->setParameter($this->parent_obj, $this->prefix."_trows", $k);
                                                $alist->addItem($v, $k, $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd));
                                                $ilCtrl->setParameter($this->parent_obj, $this->prefix."_trows", "");
                                        }
                                        $alist->setListTitle($this->getRowSelectorLabel() ? $this->getRowSelectorLabel() : $lng->txt("rows"));
                                        $this->tpl->setVariable("ROW_SELECTOR", $alist->getHTML());
                                }
 
                                // export
                                if(sizeof($this->export_formats) && $this->dataExists())
                                {                               
                                        include_once("./Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php");
                                        $alist = new ilAdvancedSelectionListGUI();
                                        $alist->setStyle(ilAdvancedSelectionListGUI::STYLE_LINK_BUTTON);
                                        $alist->setId("sellst_xpt");
                                        foreach($this->export_formats as $format => $caption_lng_id)
                                        {
                                                $ilCtrl->setParameter($this->parent_obj, $this->prefix."_xpt", $format);
                                                $url = $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd);
                                                $ilCtrl->setParameter($this->parent_obj, $this->prefix."_xpt", "");
                                                $alist->addItem($lng->txt($caption_lng_id), $format, $url);
                                        }
                                        $alist->setListTitle($lng->txt("export"));
                                        $this->tpl->setVariable("EXPORT_SELECTOR", "&nbsp;".$alist->getHTML());
                                }
                                
                                $this->tpl->setCurrentBlock("top_navigation");
                                $this->tpl->setVariable("COLUMN_COUNT", $this->getColumnCount());
                                if ($this->getDisplayAsBlock())
                                {
                                        $this->tpl->setVariable("BLK_CLASS", "Block");
                                }
                                $this->tpl->parseCurrentBlock();
                        }
                }
        }

References $ilCtrl, $ilUser, $layout, ilTableGUI\$limit, $lng, ilTableGUI\$max_count, $options, $start, $url, dataExists(), deleteTemplate(), ilTableGUI\getColumnCount(), getContext(), getDisableFilterHiding(), getDisplayAsBlock(), getEnableNumInfo(), getFormName(), getId(), getLinkbar(), getParentCmd(), getRowSelectorLabel(), getSelectableColumns(), getSelectAllCheckbox(), getShowRowsSelector(), getShowTemplates(), isColumnSelected(), saveTemplate(), ilUtil\sendSuccess(), and ilAdvancedSelectionListGUI\STYLE_LINK_BUTTON.

Referenced by getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHeader()

ilTable2GUI::fillHeader ( )

Reimplemented in ilTestQuestionsTableGUI, and ilQuestionBrowserTableGUI.

Definition at line 1377 of file class.ilTable2GUI.php.

        {
                global $lng;
                
                $allcolumnswithwidth = true;
                foreach ((array) $this->column as $idx => $column)
                {
                        if (!strlen($column["width"])) 
                        {
                                $allcolumnswithwidth = false;
                        }
                        else if($column["width"] == "1")
                        {
                                // IE does not like 1 but seems to work with 1%
                                $this->column[$idx]["width"] = "1%";
                        }
                }
                if ($allcolumnswithwidth)
                {
                        foreach ((array) $this->column as $column)
                        {
                                $this->tpl->setCurrentBlock("tbl_colgroup_column");
                                $this->tpl->setVariable("COLGROUP_COLUMN_WIDTH", $column["width"]);
                                $this->tpl->parseCurrentBlock();
                        }
                }
                $ccnt = 0;
                foreach ((array) $this->column as $column)
                {
                        $ccnt++;
                        //tooltip
                        if ($column["tooltip"] != "")
                        {                               
                                include_once("./Services/UIComponent/Tooltip/classes/class.ilTooltipGUI.php");
                                ilTooltipGUI::addTooltip("thc_".$this->getId()."_".$ccnt, $column["tooltip"], 
                                        "", "bottom center", "top center", !$column["tooltip_html"]);
                        }
                        if (!$this->enabled["sort"] || $column["sort_field"] == "" || $column["is_checkbox_action_column"])
                        {
                                $this->tpl->setCurrentBlock("tbl_header_no_link");
                                if ($column["width"] != "")
                                {
                                        $this->tpl->setVariable("TBL_COLUMN_WIDTH_NO_LINK"," width=\"".$column["width"]."\"");
                                }
                                if ($column["class"] != "")
                                {
                                        $this->tpl->setVariable("TBL_COLUMN_CLASS_NO_LINK"," class=\"".$column["class"]."\"");
                                }
                                if (!$column["is_checkbox_action_column"])
                                {
                                        $this->tpl->setVariable("TBL_HEADER_CELL_NO_LINK",
                                                $column["text"]);
                                }
                                else
                                {
                                        $this->tpl->setVariable("TBL_HEADER_CELL_NO_LINK",
                                                ilUtil::img(ilUtil::getImagePath("spacer.png"), $lng->txt("action")));
                                }
                                $this->tpl->setVariable("HEAD_CELL_NL_ID", "thc_".$this->getId()."_".$ccnt);
                                if ($column["class"] != "")
                                {
                                        $this->tpl->setVariable("TBL_HEADER_CLASS"," " . $column["class"]);
                                }
                                $this->tpl->parseCurrentBlock();
                                $this->tpl->touchBlock("tbl_header_th");
                                continue;
                        }
                        if (($column["sort_field"] == $this->order_field) && ($this->order_direction != ""))
                        {
                                $this->tpl->setCurrentBlock("tbl_order_image");
                                if ($this->order_direction == "asc")
                                {
                                        $this->tpl->setVariable("ORDER_CLASS", "glyphicon glyphicon-arrow-up");
                                }
                                else
                                {
                                        $this->tpl->setVariable("ORDER_CLASS", "glyphicon glyphicon-arrow-down");
                                }
                                $this->tpl->setVariable("IMG_ORDER_ALT", $this->lng->txt("change_sort_direction"));
                                $this->tpl->parseCurrentBlock();
                        }
 
                        $this->tpl->setCurrentBlock("tbl_header_cell");
                        $this->tpl->setVariable("TBL_HEADER_CELL", $column["text"]);
                        $this->tpl->setVariable("HEAD_CELL_ID", "thc_".$this->getId()."_".$ccnt);
                        
                        // only set width if a value is given for that column
                        if ($column["width"] != "")
                        {
                                $this->tpl->setVariable("TBL_COLUMN_WIDTH"," width=\"".$column["width"]."\"");
                        }
                        if ($column["class"] != "")
                        {
                                $this->tpl->setVariable("TBL_COLUMN_CLASS"," class=\"".$column["class"]."\"");
                        }
 
                        $lng_sort_column = $this->lng->txt("sort_by_this_column");
                        $this->tpl->setVariable("TBL_ORDER_ALT",$lng_sort_column);
                
                        $order_dir = "asc";
 
                        if ($column["sort_field"] == $this->order_field)
                        { 
                                $order_dir = $this->sort_order;
 
                                $lng_change_sort = $this->lng->txt("change_sort_direction");
                                $this->tpl->setVariable("TBL_ORDER_ALT",$lng_change_sort);
                        }
                
                        if ($column["class"] != "")
                        {
                                $this->tpl->setVariable("TBL_HEADER_CLASS"," " . $column["class"]);
                        }
                        $this->setOrderLink($column["sort_field"], $order_dir);
                        $this->tpl->parseCurrentBlock();
                        $this->tpl->touchBlock("tbl_header_th");
                }
                
                $this->tpl->setCurrentBlock("tbl_header");
                $this->tpl->parseCurrentBlock();
        }

References $column, $lng, ilTooltipGUI\addTooltip(), getId(), ilUtil\getImagePath(), ilUtil\img(), and setOrderLink().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHeaderCSV()

ilTable2GUI::fillHeaderCSV ( $a_csv )

protected

CSV Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

object $a_csv current file

Reimplemented in ilBookingReservationsTableGUI, ilSCORM2004TrackingItemsTableGUI, ilSCORMTrackingItemsTableGUI, ilLPProgressTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, and ilTrUserObjectsPropsTableGUI.

Definition at line 3367 of file class.ilTable2GUI.php.

        {
                foreach ($this->column as $column)
                {
                        $title = strip_tags($column["text"]);
                        if($title)
                        {
                                $a_csv->addColumn($title);
                        }
                }
                $a_csv->addRow();
        }

References $column, and ilTableGUI\$title.

Referenced by exportData().

Here is the caller graph for this function:

◆ fillHeaderExcel()

ilTable2GUI::fillHeaderExcel	(	ilExcel	$a_excel,
		&	$a_row
	)

protected

Excel Version of Fill Header.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented in ilBookingReservationsTableGUI, ilLPProgressTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, ilTrUserObjectsPropsTableGUI, ilSCORM2004TrackingItemsTableGUI, and ilSCORMTrackingItemsTableGUI.

Definition at line 3315 of file class.ilTable2GUI.php.

        {
                $col = 0;
                foreach ($this->column as $column)
                {
                        $title = strip_tags($column["text"]);
                        if($title)
                        {
                                $a_excel->setCell($a_row, $col++, $title);
                        }
                }               
                $a_excel->setBold("A".$a_row.":".$a_excel->getColumnCoord($col-1).$a_row);
        }

References $column, ilTableGUI\$title, ilExcel\getColumnCoord(), ilExcel\setBold(), and ilExcel\setCell().

Referenced by exportData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillHiddenRow()

ilTable2GUI::fillHiddenRow ( )

Definition at line 2582 of file class.ilTable2GUI.php.

        {
                $hidden_row = false;
                if(count($this->hidden_inputs))
                {
                        foreach ($this->hidden_inputs as $hidden_input)
                        {
                                $this->tpl->setCurrentBlock("tbl_hidden_field");
                                $this->tpl->setVariable("FIELD_NAME", $hidden_input["name"]);
                                $this->tpl->setVariable("FIELD_VALUE", $hidden_input["value"]);
                                $this->tpl->parseCurrentBlock();
                        }
 
                        $this->tpl->setCurrentBlock("tbl_hidden_row");
                        $this->tpl->parseCurrentBlock();
                }
        }

Referenced by getHTML().

Here is the caller graph for this function:

◆ fillMetaCSV()

ilTable2GUI::fillMetaCSV ( $a_csv )

protected

Add meta information to csv export.

Likely to be overwritten by derived class.

Parameters

object $a_csv current file

Reimplemented in ilLPTableBaseGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, and ilLPObjectStatisticsTypesTableGUI.

Definition at line 3356 of file class.ilTable2GUI.php.

        {
                
        }

Referenced by exportData().

Here is the caller graph for this function:

◆ fillMetaExcel()

ilTable2GUI::fillMetaExcel	(	ilExcel	$a_excel,
		&	$a_row
	)

protected

Add meta information to excel export.

Likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter

Reimplemented in ilLPTableBaseGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, and ilLPObjectStatisticsTypesTableGUI.

Definition at line 3303 of file class.ilTable2GUI.php.

        {
 
        }

Referenced by exportData().

Here is the caller graph for this function:

◆ fillRow()

ilTable2GUI::fillRow ( $a_set )

protected

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

array $a_set data array

Definition at line 2141 of file class.ilTable2GUI.php.

        {
                foreach ($a_set as $key => $value)
                {
                        $this->tpl->setVariable("VAL_".strtoupper($key), $value);
                }
        }

Referenced by getHTML().

Here is the caller graph for this function:

◆ fillRowCSV()

ilTable2GUI::fillRowCSV	(	$a_csv,
		$a_set
	)

protected

CSV Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

object	$a_csv	current file
array	$a_set	data array

Reimplemented in ilBookingReservationsTableGUI, ilPollAnswerTableGUI, ilPollUserTableGUI, ilSCORM2004TrackingItemsTableGUI, ilSCORMTrackingItemsTableGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, ilLPObjectStatisticsTypesTableGUI, ilLPProgressTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, and ilTrUserObjectsPropsTableGUI.

Definition at line 3387 of file class.ilTable2GUI.php.

        {
                foreach ($a_set as $key => $value)
                {
                        if(is_array($value))
                        {
                                $value = implode(', ', $value);
                        }
                        $a_csv->addColumn(strip_tags($value));
                }
                $a_csv->addRow();
        }

Referenced by exportData().

Here is the caller graph for this function:

◆ fillRowExcel()

ilTable2GUI::fillRowExcel	(	ilExcel	$a_excel,
		&	$a_row,
			$a_set
	)

protected

Excel Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters

ilExcel	$a_excel	excel wrapper
int	$a_row	row counter
array	$a_set	data array

Reimplemented in ilBookingReservationsTableGUI, ilPollAnswerTableGUI, ilPollUserTableGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsTableGUI, ilLPObjectStatisticsTypesTableGUI, ilLPProgressTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, ilTrUserObjectsPropsTableGUI, ilUserLPTableGUI, ilSCORM2004TrackingItemsTableGUI, and ilSCORMTrackingItemsTableGUI.

Definition at line 3337 of file class.ilTable2GUI.php.

        {
                $col = 0;
                foreach ($a_set as $value)
                {
                        if(is_array($value))
                        {
                                $value = implode(', ', $value);
                        }
                        $a_excel->setCell($a_row, $col++, $value);
                }
        }

References ilExcel\setCell().

Referenced by exportData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllCommandLimit()

static ilTable2GUI::getAllCommandLimit ( )

static

Get maximum number of entries to enable actions for all.

Returns: int

Definition at line 3415 of file class.ilTable2GUI.php.

        {
                global $ilClientIniFile;
                
                $limit = $ilClientIniFile->readVariable("system", "TABLE_ACTION_ALL_LIMIT");
                if(!$limit)
                {
                        $limit = self::ACTION_ALL_LIMIT;
                }
                
                return $limit;
        }

References ilTableGUI\$limit, and ACTION_ALL_LIMIT.

◆ getCloseFormTag()

ilTable2GUI::getCloseFormTag ( )

Get close form tag.

Returns: boolean close form tag

Definition at line 165 of file class.ilTable2GUI.php.

        {
                return $this->close_form_tag;
        }

References $close_form_tag.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getContext()

ilTable2GUI::getContext ( )

Get context.

Returns: string

Definition at line 2991 of file class.ilTable2GUI.php.

        {
                return $this->context;
        }

References $context.

Referenced by deleteTemplate(), fillFooter(), restoreTemplate(), and saveTemplate().

Here is the caller graph for this function:

◆ getCurrentState()

ilTable2GUI::getCurrentState ( )

get current settings for order, limit, columns and filter

Returns: array

Definition at line 2886 of file class.ilTable2GUI.php.

        {
                $this->determineOffsetAndOrder();
                $this->determineLimit();
                $this->determineSelectedColumns();
                $this->determineSelectedFilters();
 
                // "filter" show/hide is not saved
 
                $result = array();
                $result["order"] = $this->getOrderField();
                $result["direction"] = $this->getOrderDirection();
                $result["offset"] = $this->getOffset();
                $result["rows"] = $this->getLimit();            
                $result["selfilters"] = $this->getSelectedFilters();
                
                // #9514 - $this->getSelectedColumns() will omit deselected, leading to 
                // confusion on restoring template
                $result["selfields"] = $this->selected_column;  
                
                // gather filter values
                if($this->filters)
                {
                        foreach($this->filters as $item)
                        {
                                $result["filter_values"][$item->getFieldId()] = $this->getFilterValue($item);
                        }
                }
                if($this->optional_filters && $result["selfilters"])
                {
                        foreach($this->optional_filters as $item)
                        {
                                if(in_array($item->getFieldId(), $result["selfilters"]))
                                {
                                        $result["filter_values"][$item->getFieldId()] = $this->getFilterValue($item);
                                }
                        }
                }
 
                return $result;
        }

References $result, $selected_column, determineLimit(), determineOffsetAndOrder(), determineSelectedColumns(), determineSelectedFilters(), getFilterValue(), getLimit(), getOffset(), ilTableGUI\getOrderDirection(), getOrderField(), and getSelectedFilters().

Referenced by saveTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getData()

ilTable2GUI::getData ( )

final

Reimplemented from ilTableGUI.

Definition at line 585 of file class.ilTable2GUI.php.

        {
                return $this->row_data;
        }

Referenced by ilPCFileListTableGUI\__construct(), ilSkillLevelTableGUI\__construct(), ilTestQuestionsTableGUI\fillRow(), ilLPObjectStatisticsDailyTableGUI\getGraph(), ilLPObjectStatisticsTableGUI\getGraph(), ilLPObjectStatisticsTypesTableGUI\getGraph(), getHTML(), ilTestSkillLevelThresholdsTableGUI\getInputElements(), ilTestManScoringParticipantsTableGUI\getInternalyOrderedDataValues(), ilPCIIMTriggerTableGUI\initActions(), ilImageMapTableGUI\initActions(), assFileUploadFileTableGUI\initCommand(), and ilWebResourceEditableLinkTableGUI\updateFromPost().

Here is the caller graph for this function:

◆ getDefaultFilterVisibility()

ilTable2GUI::getDefaultFilterVisibility ( )

Get default filter visibility.

Returns: bool

Definition at line 1186 of file class.ilTable2GUI.php.

        {
                return $this->default_filter_visibility;
        }

References $default_filter_visibility.

Referenced by isFilterVisible().

Here is the caller graph for this function:

◆ getDefaultOrderDirection()

ilTable2GUI::getDefaultOrderDirection ( )

Get Default order direction.

Returns: string Default order direction

Definition at line 1168 of file class.ilTable2GUI.php.

        {
                return $this->defaultorderdirection;
        }

Referenced by determineOffsetAndOrder().

Here is the caller graph for this function:

◆ getDefaultOrderField()

ilTable2GUI::getDefaultOrderField ( )

Get Default order field.

Returns: string Default order field

Definition at line 1148 of file class.ilTable2GUI.php.

        {
                return $this->defaultorderfield;
        }

Referenced by determineOffsetAndOrder(), ilRegistrationCodesTableGUI\getItems(), and arIndexTableGUI\setOrderAndSegmentation().

Here is the caller graph for this function:

◆ getDescription()

ilTable2GUI::getDescription ( )

Get description.

Returns: string description

Definition at line 533 of file class.ilTable2GUI.php.

        {
                return $this->description;
        }

Referenced by render().

Here is the caller graph for this function:

◆ getDisableFilterHiding()

ilTable2GUI::getDisableFilterHiding ( )

Get disable filter hiding

Returns: boolean

Definition at line 824 of file class.ilTable2GUI.php.

        {
                return $this->disable_filter_hiding;
        }

References $disable_filter_hiding.

Referenced by fillFooter(), and renderFilter().

Here is the caller graph for this function:

◆ getDisplayAsBlock()

ilTable2GUI::getDisplayAsBlock ( )

Get display as block.

Returns: boolean display as block

Definition at line 1012 of file class.ilTable2GUI.php.

        {
                return $this->display_as_block;
        }

Referenced by fillFooter(), getLinkbar(), and render().

Here is the caller graph for this function:

◆ getEnableHeader()

ilTable2GUI::getEnableHeader ( )

Get Enable Header.

Returns: boolean Enable Header

Definition at line 485 of file class.ilTable2GUI.php.

        {
                return $this->enabled["header"];
        }

◆ getEnableNumInfo()

ilTable2GUI::getEnableNumInfo ( )

Get enable num info.

Returns: boolean enable number of records info

Definition at line 505 of file class.ilTable2GUI.php.

        {
                return $this->num_info;
        }

Referenced by fillFooter().

Here is the caller graph for this function:

◆ getEnableTitle()

ilTable2GUI::getEnableTitle ( )

Get Enable Title.

Returns: boolean Enable Title

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

        {
                return $this->enabled["title"];
        }

◆ getExportMode()

ilTable2GUI::getExportMode ( )

Was export activated?

Returns: int

Definition at line 3194 of file class.ilTable2GUI.php.

    {
                return $this->export_mode;
        }

References $export_mode.

Referenced by getHTML(), getLimit(), and getOffset().

Here is the caller graph for this function:

◆ getExternalSegmentation()

ilTable2GUI::getExternalSegmentation ( )

Get external segmentation.

Returns: boolean data is segmented externally

Definition at line 1116 of file class.ilTable2GUI.php.

        {
                return $this->ext_seg;
        }

References $ext_seg.

Referenced by determineOffsetAndOrder(), getHTML(), and ilTermsOfServiceTableGUI\populate().

Here is the caller graph for this function:

◆ getExternalSorting()

ilTable2GUI::getExternalSorting ( )

Get external sorting.

Returns: boolean data is sorted externally

Definition at line 1052 of file class.ilTable2GUI.php.

        {
                return $this->ext_sort;
        }

References $ext_sort.

Referenced by exportData(), getHTML(), ilTermsOfServiceTableGUI\populate(), and setData().

Here is the caller graph for this function:

◆ getFilterCols()

ilTable2GUI::getFilterCols ( )

Get filter columns.

Returns: int number of filter columns

Definition at line 804 of file class.ilTable2GUI.php.

        {
                return $this->filter_cols;
        }

References $filter_cols.

Referenced by renderFilter().

Here is the caller graph for this function:

◆ getFilterCommand()

ilTable2GUI::getFilterCommand ( )

Get filter command.

Returns: string filter command

Definition at line 1074 of file class.ilTable2GUI.php.

        {
                return $this->filter_cmd;
        }

References $filter_cmd.

◆ getFilterItemByPostVar()

ilTable2GUI::getFilterItemByPostVar ( $a_post_var )

final

Definition at line 770 of file class.ilTable2GUI.php.

        {
                foreach ($this->getFilterItems() as $item)
                {
                        if ($item->getPostVar() == $a_post_var)
                        {
                                return $item;
                        }
                }
                foreach ($this->getFilterItems(true) as $item)
                {
                        if ($item->getPostVar() == $a_post_var)
                        {
                                return $item;
                        }
                }
                return false;
        }

References getFilterItems().

Referenced by ilLanguageExtTableGUI\__construct(), executeCommand(), ilLPTableBaseGUI\executeCommand(), ilLPTableBaseGUI\getCurrentFilter(), ilObjectRolePermissionTableGUI\initColumns(), ilWorkflowEngineDefinitionsTableGUI\isFiltered(), and ilRoleTableGUI\parse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFilterItems()

ilTable2GUI::getFilterItems ( $a_optionals = false )

final

Get filter items.

Definition at line 761 of file class.ilTable2GUI.php.

        {
                if (!$a_optionals)
                {
                        return $this->filters;
                }
                return $this->optional_filters;
        }

References $filters, and $optional_filters.

Referenced by determineSelectedFilters(), getFilterItemByPostVar(), ilTestQuestionBrowserTableGUI\getQuestionsData(), ilSurveyQuestionblockbrowserTableGUI\initData(), ilSurveyQuestionbrowserTableGUI\initData(), renderFilter(), resetFilter(), and writeFilterToSession().

Here is the caller graph for this function:

◆ getFilterValue()

ilTable2GUI::getFilterValue ( ilFormPropertyGUI $a_item )

protected

Get current filter value.

Parameters

ilFormPropertyGUI $a_item

Returns: mixed

Definition at line 2934 of file class.ilTable2GUI.php.

        {
                if(method_exists($a_item, "getChecked"))
                {
                        return $a_item->getChecked();
                }
                else if(method_exists($a_item, "getValue"))
                {
                        return $a_item->getValue();
                }
                else if(method_exists($a_item, "getDate"))
                {
                        return $a_item->getDate()->get(IL_CAL_DATE);
                }
        }

References IL_CAL_DATE.

Referenced by getCurrentState().

Here is the caller graph for this function:

◆ getFormAction()

ilTable2GUI::getFormAction ( )

final

Get Form action parameter.

Returns: string Form action

Definition at line 948 of file class.ilTable2GUI.php.

        {
                return $this->form_action;
        }

Referenced by getHTML(), ilLOTestAssignmentTableGUI\init(), ilObjectCopyCourseGroupSelectionTableGUI\init(), ilObjectCopyProgressTableGUI\init(), ilSCTreeDuplicatesTableGUI\init(), ilConsultationHourBookingTableGUI\initTable(), and ilConsultationHourGroupTableGUI\initTable().

Here is the caller graph for this function:

◆ getFormName()

ilTable2GUI::getFormName ( )

Get Form name.

Returns: string Form name

Reimplemented from ilTableGUI.

Definition at line 968 of file class.ilTable2GUI.php.

        {
                return $this->formname;
        }

Referenced by fillFooter(), ilObjectRolePermissionTableGUI\fillRow(), and getHTML().

Here is the caller graph for this function:

◆ getHTML()

ilTable2GUI::getHTML ( )

Get HTML.

Reimplemented in ilMediaPoolTableGUI.

Definition at line 1606 of file class.ilTable2GUI.php.

        {
                global $lng, $ilCtrl, $ilUser;
 
                if($this->getExportMode())
                {
                        $this->exportData($this->getExportMode(), true);
                }
                
                $this->prepareOutput();
                
                if (is_object($ilCtrl) && $this->getId() == "")
                {
                        $ilCtrl->saveParameter($this->getParentObject(), $this->getNavParameter());
                }
                                
                if(!$this->getPrintMode())
                {
                        // set form action
                        if ($this->form_action != "" && $this->getOpenFormTag())
                        {
                                $hash = "";
                                if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization"))
                                {
                                        $hash = "#".$this->getTopAnchor();
                                }
 
                                if((bool)$this->form_multipart)
                                {
                                        $this->tpl->touchBlock("form_multipart_bl");
                                }
 
                                if($this->getPreventDoubleSubmission())
                                {
                                        $this->tpl->touchBlock("pdfs");
                                }
 
                                $this->tpl->setCurrentBlock("tbl_form_header");
                                $this->tpl->setVariable("FORMACTION", $this->getFormAction().$hash);
                                $this->tpl->setVariable("FORMNAME", $this->getFormName());                              
                                $this->tpl->parseCurrentBlock();
                        }
 
                        if ($this->form_action != "" && $this->getCloseFormTag())
                        {
                                $this->tpl->touchBlock("tbl_form_footer");
                        }
                }
                
                if(!$this->enabled['content'])
                {
                        return $this->render();
                }
 
                if (!$this->getExternalSegmentation())
                {
                        $this->setMaxCount(count($this->row_data));
                }
 
                $this->determineOffsetAndOrder();
                
                $this->setFooter("tblfooter",$this->lng->txt("previous"),$this->lng->txt("next"));
                
                $data = $this->getData();
                if($this->dataExists())
                {
                        // sort
                        if (!$this->getExternalSorting() && $this->enabled["sort"])
                        {
                                $data = ilUtil::sortArray($data, $this->getOrderField(),
                                        $this->getOrderDirection(), $this->numericOrdering($this->getOrderField()));
                        }
 
                        // slice
                        if (!$this->getExternalSegmentation())
                        {
                                $data = array_slice($data, $this->getOffset(), $this->getLimit());
                        }
                }
                
                // fill rows
                if($this->dataExists())
                {
                        if($this->getPrintMode())
                        {
                                ilDatePresentation::setUseRelativeDates(false);
                        }
 
                        $this->tpl->addBlockFile("TBL_CONTENT", "tbl_content", $this->row_template,
                                $this->row_template_dir);
        
                        foreach($data as $set)
                        {
                                $this->tpl->setCurrentBlock("tbl_content");
                                $this->css_row = ($this->css_row != "tblrow1")
                                        ? "tblrow1"
                                        : "tblrow2";
                                $this->tpl->setVariable("CSS_ROW", $this->css_row);
 
                                $this->fillRow($set);
                                $this->tpl->setCurrentBlock("tbl_content");
                                $this->tpl->parseCurrentBlock();
                        }
                }
                else
                {
                        // add standard no items text (please tell me, if it messes something up, alex, 29.8.2008)
                        $no_items_text = (trim($this->getNoEntriesText()) != '')
                                ? $this->getNoEntriesText()
                                : $lng->txt("no_items");
 
                        $this->css_row = ($this->css_row != "tblrow1")
                                        ? "tblrow1"
                                        : "tblrow2";                            
                        
                        $this->tpl->setCurrentBlock("tbl_no_entries");
                        $this->tpl->setVariable('TBL_NO_ENTRY_CSS_ROW', $this->css_row);
                        $this->tpl->setVariable('TBL_NO_ENTRY_COLUMN_COUNT', $this->column_count);
                        $this->tpl->setVariable('TBL_NO_ENTRY_TEXT', trim($no_items_text));
                        $this->tpl->parseCurrentBlock();                        
                }
 
 
                if(!$this->getPrintMode())
                {
                        $this->fillFooter();
 
                        $this->fillHiddenRow();
 
                        $this->fillActionRow();
 
                        $this->storeNavParameter();
                }
                
                return $this->render();
        }

References ilTableGUI\$data, $ilCtrl, $ilUser, $lng, dataExists(), determineOffsetAndOrder(), exportData(), fillActionRow(), fillFooter(), fillHiddenRow(), fillRow(), getCloseFormTag(), getData(), getExportMode(), getExternalSegmentation(), getExternalSorting(), getFormAction(), getFormName(), getId(), getLimit(), getNavParameter(), getNoEntriesText(), getOffset(), getOpenFormTag(), ilTableGUI\getOrderDirection(), getOrderField(), getParentObject(), getPreventDoubleSubmission(), getPrintMode(), numericOrdering(), prepareOutput(), render(), ilTableGUI\setFooter(), ilTableGUI\setMaxCount(), ilDatePresentation\setUseRelativeDates(), ilUtil\sortArray(), and storeNavParameter().

Referenced by ilBadgePersonalTableGUI\fillRow(), ilBadgeTableGUI\fillRow(), ilObjectBadgeTableGUI\fillRow(), and arIndexTableGUI\render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilTable2GUI::getId ( )

Get element id.

Returns: string id

Definition at line 992 of file class.ilTable2GUI.php.

        {
                return $this->id;
        }

Referenced by ilCourseParticipantsTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), ilSearchResultTableGUI\__construct(), __construct(), ilSubscriberTableGUI\__construct(), ilMailSearchCoursesMembersTableGUI\__construct(), ilWaitingListTableGUI\__construct(), ilLPTableBaseGUI\addToClipboard(), ilTestSkillLevelThresholdsTableGUI\completeCompetenceTitles(), ilLOMemberTestResultTableGUI\createTestResultLink(), determineOffsetAndOrder(), determineSelectedColumns(), determineSelectedFilters(), fillFooter(), fillHeader(), ilExParticipantTableGUI\fillRow(), ilSCORMTrackingItemsScoTableGUI\fillRow(), getHTML(), ilParticipantTableGUI\getSelectableColumns(), ilSubscriberTableGUI\getSelectableColumns(), ilWaitingListTableGUI\getSelectableColumns(), ilWorkspaceShareTableGUI\initFilter(), ilBookingReservationsTableGUI\initFilter(), ilParticipantTableGUI\initSettings(), arIndexTableGUI\initTitle(), ilDclRecordListTableGUI\loadProperty(), loadProperty(), ilCourseParticipantsTableGUI\parse(), ilLOMemberTestResultTableGUI\parse(), ilGroupParticipantsTableGUI\parse(), ilSCORMTrackingItemPerUserTableGUI\parse(), ilSCORMTrackingItemsScoTableGUI\parse(), ilSubscriberTableGUI\readSubscriberData(), ilWaitingListTableGUI\readUserData(), ilBuddySystemRelationsTableGUI\render(), render(), renderFilter(), ilParticipantTableGUI\showActionLinks(), ilSubscriberTableGUI\showActionLinks(), ilWaitingListTableGUI\showActionLinks(), and storeProperty().

Here is the caller graph for this function:

◆ getIsDataTable()

ilTable2GUI::getIsDataTable ( )

Get is data table.

Returns: boolean is data table

Definition at line 445 of file class.ilTable2GUI.php.

        {
                return $this->datatable;
        }

Referenced by render().

Here is the caller graph for this function:

◆ getLimit()

ilTable2GUI::getLimit ( )

Get limit.

Reimplemented from ilTableGUI.

Definition at line 3128 of file class.ilTable2GUI.php.

        {
                if($this->getExportMode() || $this->getPrintMode())
                {
                        return 9999;
                }
                return parent::getLimit();
        }

References getExportMode(), and getPrintMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLinkbar()

ilTable2GUI::getLinkbar ( $a_num )

Get previous/next linkbar.

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

Returns: array linkbar or false on error

Definition at line 2464 of file class.ilTable2GUI.php.

        {
                global $ilCtrl, $lng, $ilUser;
 
                $hash = "";
                if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization"))
                {
                        $hash = "#".$this->getTopAnchor();
                }
 
                $link = $ilCtrl->getLinkTargetByClass(get_class($this->parent_obj), $this->parent_cmd).
                        "&".$this->getNavParameter()."=".
                        $this->getOrderField().":".$this->getOrderDirection().":";
                
                $LinkBar = "";
                $layout_prev = $lng->txt("previous");
                $layout_next = $lng->txt("next");
                
                // if more entries then entries per page -> show link bar
                if ($this->max_count > $this->getLimit() || $this->custom_prev_next)
                {
                        $sep = "<span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>";
 
                        // calculate number of pages
                        $pages = intval($this->max_count / $this->getLimit());
 
                        // add a page if a rest remains
                        if (($this->max_count % $this->getLimit()))
                                $pages++;
                        
                        // links to other pages
                        $offset_arr = array();
                        for ($i = 1 ;$i <= $pages ; $i++)
                        {
                                $newoffset = $this->getLimit() * ($i-1);
 
                                $nav_value = $this->getOrderField().":".$this->getOrderDirection().":".$newoffset;
                                $offset_arr[$nav_value] = $i;
                        }
                                                                        
                        $sep = "<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>";
                        
                        // previous link
                        if ($this->custom_prev_next && $this->custom_prev != "")
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep;
                                $LinkBar .= "<a href=\"".$this->custom_prev.$hash."\">".$layout_prev."</a>";
                        }
                        else if ($this->getOffset() >= 1 && !$this->custom_prev_next)
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep;
                                $prevoffset = $this->getOffset() - $this->getLimit();
                                $LinkBar .= "<a href=\"".$link.$prevoffset.$hash."\">".$layout_prev."</a>";
                        }
                        else
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep;
                                $LinkBar .= '<span class="ilTableFootLight">'.$layout_prev."</span>";
                        }
                        
                        // current value
                        if ($a_num == "1")
                        {
                                $LinkBar .= '<input type="hidden" name="'.$this->getNavParameter().
                                        '" value="'.$this->getOrderField().":".$this->getOrderDirection().":".$this->getOffset().'" />';
                        }
                        
                        $sep = "<span>&nbsp;&nbsp;|&nbsp;&nbsp;</span>";
 
                        // show next link (if not last page)
                        if ($this->custom_prev_next && $this->custom_next != "")
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep;
                                $LinkBar .= "<a href=\"".$this->custom_next.$hash."\">".$layout_next."</a>";
                        }
                        else if (! ( ($this->getOffset() / $this->getLimit())==($pages-1) ) && ($pages!=1) &&
                                !$this->custom_prev_next)
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep; 
                                $newoffset = $this->getOffset() + $this->getLimit();
                                $LinkBar .= "<a href=\"".$link.$newoffset.$hash."\">".$layout_next."</a>";
                        }
                        else
                        {
                                if ($LinkBar != "")
                                        $LinkBar .= $sep; 
                                $LinkBar .= '<span class="ilTableFootLight">'.$layout_next."</span>";
                        }
                        
                        $sep = "<span>&nbsp;&nbsp;&nbsp;&nbsp;</span>";
                        
                        if (count($offset_arr) && !$this->getDisplayAsBlock() && !$this->custom_prev_next)
                        {                               
                                if ($LinkBar != "")
                                        $LinkBar .= $sep;
                                $LinkBar .= "".
                                        '<label for="tab_page_sel_'.$a_num.'">'.$lng->txt("page").'</label> '.
                                        ilUtil::formSelect($this->nav_value,
                                        $this->getNavParameter().$a_num, $offset_arr, false, true, 0, "small",
                                        array("id" => "tab_page_sel_".$a_num,
                                                "onchange" => "ilTablePageSelection(this, 'cmd[".$this->parent_cmd."]')"));
                                        //' <input class="submit" type="submit" name="cmd['.$this->parent_cmd.']" value="'.
                                        //$lng->txt("ok").'" />';
                        }
 
                        return $LinkBar;
                }
                else
                {
                        return false;
                }
        }

References $ilCtrl, $ilUser, $lng, ilUtil\formSelect(), getDisplayAsBlock(), getLimit(), getNavParameter(), getOffset(), ilTableGUI\getOrderDirection(), and getOrderField().

Referenced by fillFooter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNavParameter()

ilTable2GUI::getNavParameter ( )

final

Definition at line 1348 of file class.ilTable2GUI.php.

        {
                return $this->prefix."_table_nav";
        }

Referenced by determineOffsetAndOrder(), getHTML(), getLinkbar(), resetOffset(), and setOrderLink().

Here is the caller graph for this function:

◆ getNoEntriesText()

ilTable2GUI::getNoEntriesText ( )

Get text for an empty table.

Returns: string Text

Definition at line 425 of file class.ilTable2GUI.php.

        {
                return $this->noentriestext;
        }

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

Here is the caller graph for this function:

◆ getOffset()

ilTable2GUI::getOffset ( )

Get offset.

Reimplemented from ilTableGUI.

Definition at line 3140 of file class.ilTable2GUI.php.

        {
                if($this->getExportMode() || $this->getPrintMode())
                {
                        return 0;
                }
                return parent::getOffset();
        }

References getExportMode(), and getPrintMode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOpenFormTag()

ilTable2GUI::getOpenFormTag ( )

Get open form tag.

Returns: boolean open form tag

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

        {
                return $this->open_form_tag;
        }

References $open_form_tag.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getOrderField()

ilTable2GUI::getOrderField ( )

Reimplemented in ilBookingReservationsTableGUI.

Definition at line 548 of file class.ilTable2GUI.php.

        {
                return $this->order_field;
        }

Here is the caller graph for this function:

◆ getParentCmd()

ilTable2GUI::getParentCmd ( )

Get parent command.

Returns: string get parent gui object default command

Definition at line 385 of file class.ilTable2GUI.php.

        {
                return $this->parent_cmd;
        }

Referenced by ilExerciseSubmissionTableGUI\__construct(), ilBadgeUserTableGUI\__construct(), ilWikiExportOrderTableGUI\__construct(), fillFooter(), ilContainerStartObjectsTableGUI\fillRow(), ilAssignedUsersTableGUI\fillRow(), ilConsultationHourBookingTableGUI\initTable(), ilConsultationHourGroupTableGUI\initTable(), ilExParticipantTableGUI\parseData(), ilExerciseSubmissionTableGUI\parseRow(), and renderFilter().

Here is the caller graph for this function:

◆ getParentObject()

ilTable2GUI::getParentObject ( )

Get parent object.

Returns: object parent GUI object

Definition at line 375 of file class.ilTable2GUI.php.

        {
                return $this->parent_obj;
        }

Here is the caller graph for this function:

◆ getPrefix()

ilTable2GUI::getPrefix ( )

final

Definition at line 607 of file class.ilTable2GUI.php.

        {
                return $this->prefix;
        }

References ilTableGUI\$prefix.

Referenced by ilAssQuestionSkillAssignmentsTableGUI\__construct(), and setId().

Here is the caller graph for this function:

◆ getPreventDoubleSubmission()

ilTable2GUI::getPreventDoubleSubmission ( )

Get prevent double submission.

Returns: bool prevent double submission

Definition at line 3460 of file class.ilTable2GUI.php.

        {
                return $this->prevent_double_submission;
        }

References $prevent_double_submission.

Referenced by getHTML().

Here is the caller graph for this function:

◆ getPrintMode()

ilTable2GUI::getPrintMode ( )

Get print mode.

Returns: bool $a_value

Definition at line 3184 of file class.ilTable2GUI.php.

    {
                return $this->print_mode;
        }

References $print_mode.

Referenced by ilTrObjectUsersPropsTableGUI\__construct(), ilTrUserObjectsPropsTableGUI\__construct(), ilTrObjectUsersPropsTableGUI\fillRow(), ilTrUserObjectsPropsTableGUI\fillRow(), getHTML(), getLimit(), getOffset(), and render().

Here is the caller graph for this function:

◆ getResetCommand()

ilTable2GUI::getResetCommand ( )

Get reset filter command.

Returns: string reset command

Definition at line 1096 of file class.ilTable2GUI.php.

        {
                return $this->reset_cmd;
        }

References $reset_cmd.

◆ getRowSelectorLabel()

ilTable2GUI::getRowSelectorLabel ( )

Returns: string

Definition at line 3440 of file class.ilTable2GUI.php.

        {
                return $this->row_selector_label;
        }

References $row_selector_label.

Referenced by fillFooter().

Here is the caller graph for this function:

◆ getSelectableColumns()

ilTable2GUI::getSelectableColumns ( )

Get selectable columns.

Returns: array key: column id, val: true/false -> default on/off

Reimplemented in ilBookingObjectsTableGUI, ilExerciseSubmissionTableGUI, ilTermListTableGUI, ilSCORM2004TrackingItemsTableGUI, ilSCORMTrackingItemsTableGUI, ilStudyProgrammeMembersTableGUI, ilSurveyResultsCumulatedTableGUI, ilSurveyQuestionsTableGUI, ilEvaluationAllTableGUI, ilTestQuestionsTableGUI, ilQuestionBrowserTableGUI, ilQuestionPoolPrintViewTableGUI, arDeleteGUI, arIndexTableGUI, ilParticipantTableGUI, ilSubscriberTableGUI, ilWaitingListTableGUI, ilRepositoryUserResultTableGUI, ilSearchResultTableGUI, ilTermsOfServiceAcceptanceHistoryTableGUI, ilTermsOfServiceAgreementByLanguageTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, ilTrUserObjectsPropsTableGUI, ilUserTableGUI, and ilWorkflowEngineDefinitionsTableGUI.

Definition at line 219 of file class.ilTable2GUI.php.

        {
                return array();
        }

Referenced by ilBookingReservationsTableGUI\__construct(), determineSelectedColumns(), fillFooter(), ilBookingReservationsTableGUI\fillHeaderCSV(), and ilBookingReservationsTableGUI\fillHeaderExcel().

Here is the caller graph for this function:

◆ getSelectAllCheckbox()

ilTable2GUI::getSelectAllCheckbox ( )

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

Returns: string name of the checkbox

Reimplemented from ilTableGUI.

Definition at line 1022 of file class.ilTable2GUI.php.

        {
                return $this->select_all_checkbox;
        }

References ilTableGUI\$select_all_checkbox.

Referenced by fillFooter().

Here is the caller graph for this function:

◆ getSelectedColumns()

ilTable2GUI::getSelectedColumns ( )

Get selected columns.

Parameters

return

Reimplemented in ilEvaluationAllTableGUI, and ilRegistrationCodesTableGUI.

Definition at line 307 of file class.ilTable2GUI.php.

        {
                $scol = array();
                foreach ($this->selected_column as $k => $v)
                {
                        if ($v)
                        {
                                $scol[$k] = $k;
                        }
                }
                return $scol;
        }

Here is the caller graph for this function:

◆ getSelectedFilters()

ilTable2GUI::getSelectedFilters ( )

Get selected filters.

Parameters

return

Definition at line 846 of file class.ilTable2GUI.php.

        {
                $sfil = array();
                foreach ($this->selected_filter as $k => $v)
                {
                        if ($v)
                        {
                                $sfil[$k] = $k;
                        }
                }
                return $sfil;
        }

Referenced by getCurrentState().

Here is the caller graph for this function:

◆ getShowRowsSelector()

ilTable2GUI::getShowRowsSelector ( )

Get rows-per-page selector state.

Returns: bool

Definition at line 3011 of file class.ilTable2GUI.php.

        {
                return $this->show_rows_selector;
        }

References $show_rows_selector.

Referenced by fillFooter().

Here is the caller graph for this function:

◆ getShowTemplates()

ilTable2GUI::getShowTemplates ( )

Get template state.

Returns: bool

Definition at line 3031 of file class.ilTable2GUI.php.

        {
                return $this->show_templates;
        }

References $show_templates.

Referenced by fillFooter().

Here is the caller graph for this function:

◆ getTopAnchor()

ilTable2GUI::getTopAnchor ( )

Get top anchor.

Returns: string top anchor

Definition at line 405 of file class.ilTable2GUI.php.

        {
                return $this->top_anchor;
        }

References $top_anchor.

Referenced by render().

Here is the caller graph for this function:

◆ getTopCommands()

ilTable2GUI::getTopCommands ( )

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

Returns: boolean top commands true/false

Definition at line 1316 of file class.ilTable2GUI.php.

        {
                return $this->top_commands;
        }

References $top_commands.

Referenced by fillActionRow().

Here is the caller graph for this function:

◆ initFilter()

ilTable2GUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented in ilBookingObjectsTableGUI, ilCourseParticipantsGroupsTableGUI, ilDclRecordListTableGUI, ilExerciseSubmissionTableGUI, ilPresentationListTableGUI, ilTermListTableGUI, ilMediaPoolTableGUI, ilSCORMTrackingUsersTableGUI, ilSurveyQuestionblockbrowserTableGUI, ilSurveyQuestionbrowserTableGUI, ilSurveyQuestionsTableGUI, ilEvaluationAllTableGUI, ilTestDynamicQuestionSetStatisticTableGUI, ilTestManScoringParticipantsBySelectedQuestionAndPassTableGUI, ilTestManScoringParticipantsTableGUI, ilTestParticipantsTableGUI, ilTestPassDetailsOverviewTableGUI, ilTestQuestionBrowserTableGUI, ilQuestionBrowserTableGUI, ilObjectRolePermissionTableGUI, ilRbacLogTableGUI, ilRoleTableGUI, ilBadgeTableGUI, ilBadgeUserTableGUI, ilObjectBadgeTableGUI, ilBuddySystemRelationsTableGUI, ilCopySelfAssQuestionTableGUI, ilLanguageExtTableGUI, ilMailFolderTableGUI, ilParticipantTableGUI, ilPDNewsTableGUI, ilWorkspaceShareTableGUI, ilRegistrationCodesTableGUI, ilTermsOfServiceAcceptanceHistoryTableGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsLPTableGUI, ilLPObjectStatisticsTableGUI, ilLPObjectStatisticsTypesTableGUI, ilTrMatrixTableGUI, ilTrObjectUsersPropsTableGUI, ilTrSummaryTableGUI, ilTrUserObjectsPropsTableGUI, ilAccountCodesTableGUI, ilRoleAssignmentTableGUI, ilUserTableGUI, and ilWorkflowEngineDefinitionsTableGUI.

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

367 {

368 }

Referenced by ilBookingReservationsTableGUI\__construct(), and executeCommand().

Here is the caller graph for this function:

◆ isAdvMDFilter()

ilTable2GUI::isAdvMDFilter	(	ilAdvancedMDRecordGUI	$a_gui,
			$a_element
	)

protected

Check if filter element is based on adv md.

Parameters

ilAdvancedMDRecordGUI	$a_gui
type	$a_element

Returns: boolean

Definition at line 2041 of file class.ilTable2GUI.php.

        {               
                foreach($a_gui->getFilterElements(false) as $item)
                {
                        if($item === $a_element)
                        {
                                return true;
                        }
                }
                return false;
        }

References ilAdvancedMDRecordGUI\getFilterElements().

Referenced by writeFilterToSession().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isColumnSelected()

ilTable2GUI::isColumnSelected ( $a_col )

Is given column selected?

Parameters

string column name

Returns: boolean

Definition at line 296 of file class.ilTable2GUI.php.

        {
                return $this->selected_column[$a_col];
        }

Referenced by arIndexTableGUI\checkColumnVisibile(), fillFooter(), ilParticipantTableGUI\initFilter(), ilCourseParticipantsTableGUI\parse(), and ilGroupParticipantsTableGUI\parse().

Here is the caller graph for this function:

◆ isFilterSelected()

ilTable2GUI::isFilterSelected ( $a_col )

Is given filter selected?

Parameters

string column name

Returns: boolean

Definition at line 835 of file class.ilTable2GUI.php.

        {
                return $this->selected_filter[$a_col];
        }

Referenced by ilTermsOfServiceTableGUI\populate(), and renderFilter().

Here is the caller graph for this function:

◆ isFilterVisible()

ilTable2GUI::isFilterVisible ( )

protected

Check if filter is visible: manually shown (session, db) or default value set.

Returns: bool

Definition at line 2024 of file class.ilTable2GUI.php.

        {
                $prop = $this->loadProperty('filter');
                if($prop === '0' || $prop === '1')
                {
                        return (bool) $prop;
                }
                return $this->getDefaultFilterVisibility();
        }

References getDefaultFilterVisibility(), and loadProperty().

Referenced by renderFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadProperty()

ilTable2GUI::loadProperty ( $type )

Load table property.

Parameters

string $type

Returns: mixed

Reimplemented in ilDclRecordListTableGUI.

Definition at line 2867 of file class.ilTable2GUI.php.

    {
                global $ilUser;
 
                if(is_object($ilUser) && $this->getId() != "")
                {
                        include_once("./Services/Table/classes/class.ilTablePropertiesStorage.php");
                        $tab_prop = new ilTablePropertiesStorage();
 
                        return $tab_prop->getProperty($this->getId(), $ilUser->getId(), $type);
                }
                return null;
        }

References $ilUser, and getId().

Referenced by determineLimit(), determineOffsetAndOrder(), determineSelectedColumns(), determineSelectedFilters(), and isFilterVisible().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ numericOrdering()

ilTable2GUI::numericOrdering ( $a_field )

Should this field be sorted numeric?

Returns: boolean numeric ordering; default is false

Reimplemented in ilExGradesTableGUI, ilBookingObjectsTableGUI, ilBookingReservationsTableGUI, ilAssignmentsTableGUI, ilExAssignmentListTextTableGUI, ilExAssignmentPeerReviewTableGUI, ilExcCriteriaCatalogueTableGUI, ilExcCriteriaTableGUI, ilForumStatisticsTableGUI, ilPresentationListTableGUI, ilTermListTableGUI, ilPollAnswerTableGUI, ilSurveyMaintenanceTableGUI, ilSurveyResultsCumulatedTableGUI, ilAssessmentFolderLogAdministrationTableGUI, ilEvaluationAllTableGUI, ilResultsByQuestionTableGUI, ilTestAverageReachedPointsTableGUI, ilAssQuestionSkillUsagesTableGUI, ilQuestionCumulatedStatisticsTableGUI, ilQuestionPoolExportTableGUI, ilWikiPagesTableGUI, ilPageHistoryTableGUI, ilFileSystemTableGUI, ilMemberExportFileTableGUI, ilRepositoryObjectResultTableGUI, ilRepositoryUserResultTableGUI, ilSearchResultTableGUI, ilSkillLevelTableGUI, ilTaxAssignedItemsTableGUI, ilTaxonomyTableGUI, ilLPObjectStatisticsDailyTableGUI, ilLPObjectStatisticsLPTableGUI, ilLPObjectStatisticsTableGUI, ilLPObjectStatisticsTypesTableGUI, ilLPProgressTableGUI, ilTrSummaryTableGUI, ilForumTopicTableGUI, ilTestExportTableGUI, ilQuestionBrowserTableGUI, ilQuestionPoolPrintViewTableGUI, ilMailSearchCoursesTableGUI, ilMailAttachmentTableGUI, ilTermsOfServiceAcceptanceHistoryTableGUI, ilTermsOfServiceAgreementByLanguageTableGUI, ilDclRecordListTableGUI, ilTestFixedParticipantsTableGUI, ilTestParticipantsTableGUI, ilTestPassOverviewTableGUI, ilTestPersonalDefaultSettingsTableGUI, and ilAssQuestionHintsTableGUI.

Definition at line 1748 of file class.ilTable2GUI.php.

        {
                return false;
        }

Referenced by exportData(), getHTML(), and ilTestManScoringParticipantsTableGUI\getInternalyOrderedDataValues().

Here is the caller graph for this function:

◆ prepareOutput()

ilTable2GUI::prepareOutput ( )

protected

Anything that must be done before HTML is generated.

Reimplemented in ilMediaPoolTableGUI, ilExportTableGUI, ilFileSystemTableGUI, ilMultilingualismTableGUI, ilObjectTranslation2TableGUI, and ilObjectTranslationTableGUI.

Definition at line 1502 of file class.ilTable2GUI.php.

1503 {

1504 }

Referenced by getHTML().

Here is the caller graph for this function:

◆ render()

ilTable2GUI::render ( )

render table @access public

Reimplemented from ilTableGUI.

Reimplemented in ilExerciseSubmissionTableGUI, ilMediaPoolTableGUI, arIndexTableGUI, and ilBuddySystemRelationsTableGUI.

Definition at line 1757 of file class.ilTable2GUI.php.

        {
                global $lng, $ilCtrl;
 
                $this->tpl->setVariable("CSS_TABLE",$this->getStyle("table"));
                $this->tpl->setVariable("DATA_TABLE", (int) $this->getIsDataTable());
                if ($this->getId() != "")
                {
                        $this->tpl->setVariable("ID", 'id="'.$this->getId().'"');
                }
                
                // description
                if ($this->getDescription() != "")
                {
                        $this->tpl->setCurrentBlock("tbl_header_description");
                        $this->tpl->setVariable("TBL_DESCRIPTION", $this->getDescription());
                        $this->tpl->parseCurrentBlock();
                }
 
                if(!$this->getPrintMode())
                {
                        $this->renderFilter();
                }
                
                if ($this->getDisplayAsBlock())
                {
                        $this->tpl->touchBlock("outer_start_1");
                        $this->tpl->touchBlock("outer_end_1");
                }
                else
                {
                        $this->tpl->touchBlock("outer_start_2");
                        $this->tpl->touchBlock("outer_end_2");
                }
                
                // table title and icon
                if ($this->enabled["title"] && ($this->title != ""
                        || $this->icon != "" || count($this->header_commands) > 0 ||
                        $this->headerHTML != "" || $this->close_command != ""))
                {
                        if ($this->enabled["icon"])
                        {
                                $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();
                        }
 
                        if(!$this->getPrintMode())
                        {
                                foreach($this->header_commands as $command)
                                {
                                        if ($command["img"] != "")
                                        {
                                                $this->tpl->setCurrentBlock("tbl_header_img_link");
                                                if ($command["target"] != "")
                                                {
                                                        $this->tpl->setVariable("TARGET_IMG_LINK",
                                                                'target="'.$command["target"].'"');
                                                }
                                                $this->tpl->setVariable("ALT_IMG_LINK", $command["text"]);
                                                $this->tpl->setVariable("HREF_IMG_LINK", $command["href"]);
                                                $this->tpl->setVariable("SRC_IMG_LINK",
                                                        $command["img"]);
                                                $this->tpl->parseCurrentBlock();
                                        }
                                        else
                                        {
                                                $this->tpl->setCurrentBlock("head_cmd");
                                                $this->tpl->setVariable("TXT_HEAD_CMD", $command["text"]);
                                                $this->tpl->setVariable("HREF_HEAD_CMD", $command["href"]);
                                                $this->tpl->parseCurrentBlock();
                                        }
                                }
                        }
                        
                        if (isset ($this->headerHTML)) {
                                $this->tpl->setCurrentBlock("tbl_header_html");
                                $this->tpl->setVariable ("HEADER_HTML", $this->headerHTML);
                            $this->tpl->parseCurrentBlock();
                        }
                        
                        // close command
                        if ($this->close_command != "")
                        {
                                $this->tpl->setCurrentBlock("tbl_header_img_link");
                                $this->tpl->setVariable("ALT_IMG_LINK",$lng->txt("close"));
                                $this->tpl->setVariable("HREF_IMG_LINK",$this->close_command);
                                $this->tpl->parseCurrentBlock();
                        }
 
                        $this->tpl->setCurrentBlock("tbl_header_title");
                        $this->tpl->setVariable("TBL_TITLE",$this->title);
                        $this->tpl->setVariable("TOP_ANCHOR",$this->getTopAnchor());
                        if ($this->getDisplayAsBlock())
                        {
                                $this->tpl->setVariable("BLK_CLASS", "Block");
                        }
                        $this->tpl->parseCurrentBlock();
                }
 
                // table header
                if ($this->enabled["header"])
                {
                        $this->fillHeader();
                }
 
                $this->tpl->touchBlock("tbl_table_end");
 
                return $this->tpl->get();
        }

References $ilCtrl, $lng, fillHeader(), getDescription(), getDisplayAsBlock(), getId(), ilUtil\getImagePath(), getIsDataTable(), getPrintMode(), ilTableGUI\getStyle(), getTopAnchor(), and renderFilter().

Referenced by ilTestSkillLevelThresholdsTableGUI\fillRow(), and getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ renderFilter()

ilTable2GUI::renderFilter ( )

private

Render Filter section.

Definition at line 1872 of file class.ilTable2GUI.php.

        {
                global $lng, $tpl;
                
                $filter = $this->getFilterItems();
                $opt_filter = $this->getFilterItems(true);
 
                $tpl->addJavascript("./Services/Table/js/ServiceTable.js");
                
                if (count($filter) == 0 && count($opt_filter) == 0)
                {
                        return;
                }
 
                include_once("./Services/YUI/classes/class.ilYuiUtil.php");
                ilYuiUtil::initConnection();
 
                $ccnt = 0;
 
                // render standard filter
                if (count($filter) > 0)
                {
                        foreach ($filter as $item)
                        {
                                if ($ccnt >= $this->getFilterCols())
                                {
                                        $this->tpl->setCurrentBlock("filter_row");
                                        $this->tpl->parseCurrentBlock();
                                        $ccnt = 0;
                                }
                                $this->tpl->setCurrentBlock("filter_item");
                                $this->tpl->setVariable("OPTION_NAME",
                                        $item->getTitle());
                                $this->tpl->setVariable("F_INPUT_ID",
                                        $item->getFieldId());
                                $this->tpl->setVariable("INPUT_HTML",
                                        $item->getTableFilterHTML());
                                $this->tpl->parseCurrentBlock();
                                $ccnt++;
                        }
                }
                
                // render optional filter
                if (count($opt_filter) > 0)
                {
                        $this->determineSelectedFilters();
 
                        foreach ($opt_filter as $item)
                        {
                                if($this->isFilterSelected($item->getPostVar()))
                                {
                                        if ($ccnt >= $this->getFilterCols())
                                        {
                                                $this->tpl->setCurrentBlock("filter_row");
                                                $this->tpl->parseCurrentBlock();
                                                $ccnt = 0;
                                        }
                                        $this->tpl->setCurrentBlock("filter_item");
                                        $this->tpl->setVariable("OPTION_NAME",
                                                $item->getTitle());
                                        $this->tpl->setVariable("F_INPUT_ID",
                                                $item->getFieldId());
                                        $this->tpl->setVariable("INPUT_HTML",
                                                $item->getTableFilterHTML());
                                        $this->tpl->parseCurrentBlock();
                                        $ccnt++;
                                }
                        }
                
                        // filter selection
                        $items = array();
                        foreach ($opt_filter as $item)
                        {
                                $k = $item->getPostVar();
                                $items[$k] = array("txt" => $item->getTitle(),
                                        "selected" => $this->isFilterSelected($k));
                        }
 
                        include_once("./Services/UIComponent/CheckboxListOverlay/classes/class.ilCheckboxListOverlayGUI.php");
                        $cb_over = new ilCheckboxListOverlayGUI("tbl_filters_".$this->getId());
                        $cb_over->setLinkTitle($lng->txt("optional_filters"));
                        $cb_over->setItems($items);
 
                        $cb_over->setFormCmd($this->getParentCmd());
                        $cb_over->setFieldVar("tblff".$this->getId());
                        $cb_over->setHiddenVar("tblfsf".$this->getId());
 
                        $cb_over->setSelectionHeaderClass("ilTableMenuItem");
                        $this->tpl->setCurrentBlock("filter_select");
 
                        // apply should be the first submit because of enter/return, inserting hidden submit
                        $this->tpl->setVariable("HIDDEN_CMD_APPLY", $this->filter_cmd);
 
                        $this->tpl->setVariable("FILTER_SELECTOR", $cb_over->getHTML());
                    $this->tpl->parseCurrentBlock();
                }
 
                // if any filter
                if($ccnt > 0 || count($opt_filter) > 0)
                {
                        $this->tpl->setVariable("TXT_FILTER", $lng->txt("filter"));
                        
                        if($ccnt > 0)
                        {
                                if ($ccnt < $this->getFilterCols())
                                {
                                        for($i = $ccnt; $i<=$this->getFilterCols(); $i++)
                                        {
                                                $this->tpl->touchBlock("filter_empty_cell");
                                        }
                                }
                                $this->tpl->setCurrentBlock("filter_row");
                                $this->tpl->parseCurrentBlock();
 
                                $this->tpl->setCurrentBlock("filter_buttons");                          
                                $this->tpl->setVariable("CMD_APPLY", $this->filter_cmd);
                                $this->tpl->setVariable("TXT_APPLY", $this->filter_cmd_txt 
                                        ? $this->filter_cmd_txt
                                        : $lng->txt("apply_filter"));
                                $this->tpl->setVariable("CMD_RESET", $this->reset_cmd);
                                $this->tpl->setVariable("TXT_RESET", $this->reset_cmd_txt 
                                        ? $this->reset_cmd_txt 
                                        : $lng->txt("reset_filter"));
                        }
                        else if(count($opt_filter) > 0)
                        {
                                $this->tpl->setCurrentBlock("optional_filter_hint");
                                $this->tpl->setVariable('TXT_OPT_HINT', $lng->txt('optional_filter_hint'));
                                $this->tpl->parseCurrentBlock();
                        }
                        
                        $this->tpl->setCurrentBlock("filter_section");
                        $this->tpl->setVariable("FIL_ID", $this->getId());
                        $this->tpl->parseCurrentBlock();
                        
                        // (keep) filter hidden?
                        if(!$this->isFilterVisible())   
                        {
                                if (!$this->getDisableFilterHiding())
                                {
                                        $this->tpl->setCurrentBlock("filter_hidden");
                                        $this->tpl->setVariable("FI_ID", $this->getId());
                                        $this->tpl->parseCurrentBlock();
                                }
                        }
                }
        }

References $lng, $tpl, determineSelectedFilters(), getDisableFilterHiding(), getFilterCols(), getFilterItems(), getId(), getParentCmd(), ilYuiUtil\initConnection(), isFilterSelected(), and isFilterVisible().

Referenced by render().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetFilter()

ilTable2GUI::resetFilter ( )

Reset filter.

Reimplemented in arIndexTableGUI, and ilMailFolderTableGUI.

Definition at line 2106 of file class.ilTable2GUI.php.

        {
                global $lng;
                
                $filter = $this->getFilterItems();
                $opt_filter = $this->getFilterItems(true);
 
                foreach ($filter as $item)
                {
                        if ($item->checkInput())
                        {
                                $item->setValueByArray($_POST);
                                $item->clearFromSession();
                        }
                }
                foreach ($opt_filter as $item)
                {
                        if ($item->checkInput())
                        {
                                $item->setValueByArray($_POST);
                                $item->clearFromSession();
                        }
                }
                
                // #13209
                unset($_REQUEST["tbltplcrt"]);
                unset($_REQUEST["tbltpldel"]);  
        }

References $_POST, $lng, and getFilterItems().

Referenced by ilLPTableBaseGUI\executeCommand(), and ilTestQuestionBrowserTableGUI\resetFilterCmd().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetOffset()

ilTable2GUI::resetOffset ( $a_in_determination = false )

Reset offset.

Definition at line 348 of file class.ilTable2GUI.php.

        {
                if (!$this->nav_determined && !$a_in_determination)
                {
                        $this->determineOffsetAndOrder();
                }
                $this->nav_value = $this->getOrderField().":".$this->getOrderDirection().":0";
                $_GET[$this->getNavParameter()] =
                        $_POST[$this->getNavParameter()."1"] =
                        $this->nav_value;
//echo $this->nav_value;
                $this->setOffset(0);
        }

References $_GET, $_POST, determineOffsetAndOrder(), getNavParameter(), ilTableGUI\getOrderDirection(), getOrderField(), and ilTableGUI\setOffset().

Referenced by arIndexTableGUI\applyFilter(), determineLimit(), determineOffsetAndOrder(), ilLPTableBaseGUI\executeCommand(), ilLMQuestionListTableGUI\getItems(), ilRegistrationCodesTableGUI\getItems(), ilTrObjectUsersPropsTableGUI\getItems(), ilTrUserObjectsPropsTableGUI\getItems(), ilAccountCodesTableGUI\getItems(), ilUserLPTableGUI\getItems(), ilUserTableGUI\getItems(), ilTermsOfServiceTableGUI\populate(), arIndexTableGUI\resetFilter(), and ilCalendarManageTableGUI\resetToDefaults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restoreTemplate()

ilTable2GUI::restoreTemplate ( $a_name )

Restore state from template.

Parameters

string $a_name

Returns: bool

Definition at line 3042 of file class.ilTable2GUI.php.

        {
                global $ilUser;
                
                $a_name = ilUtil::stripSlashes($a_name);
 
                if(trim($a_name) && $this->getContext() != "" && is_object($ilUser) && $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        include_once("./Services/Table/classes/class.ilTableTemplatesStorage.php");
                        $storage = new ilTableTemplatesStorage();
 
                        $data = $storage->load($this->getContext(), $ilUser->getId(), $a_name);
                        if(is_array($data))
                        {
                                foreach($data as $property => $value)
                                {
                                        $this->storeProperty($property, $value);
                                }
                        }
 
                        $data["filter_values"] = unserialize($data["filter_values"]);
                        if($data["filter_values"])
                        {
                                $this->restore_filter_values = $data["filter_values"];
                        }
                        
                        $this->restore_filter = true;
 
                        return true;
                }
                return false;
        }

References ilTableGUI\$data, $ilUser, getContext(), storeProperty(), and ilUtil\stripSlashes().

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveTemplate()

ilTable2GUI::saveTemplate ( $a_name )

Save current state as template.

Parameters

string $a_name

Returns: bool

Definition at line 3081 of file class.ilTable2GUI.php.

        {
                global $ilUser;
                
                $a_name = ilUtil::prepareFormOutput($a_name, true);
                
                if(trim($a_name) && $this->getContext() != "" && is_object($ilUser) && $ilUser->getId() != ANONYMOUS_USER_ID)
                {
                        include_once("./Services/Table/classes/class.ilTableTemplatesStorage.php");
                        $storage = new ilTableTemplatesStorage();
 
                        $state = $this->getCurrentState();
                        $state["filter_values"] = serialize($state["filter_values"]);
                        $state["selfields"] = serialize($state["selfields"]);
                        $state["selfilters"] = serialize($state["selfilters"]);
 
                        $storage->store($this->getContext(), $ilUser->getId(), $a_name, $state);
                        return true;
                }
                return false;
        }

References $ilUser, getContext(), getCurrentState(), and ilUtil\prepareFormOutput().

Referenced by fillFooter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setCloseCommand()

ilTable2GUI::setCloseCommand ( $a_link )

Add command for closing table.

Parameters

string $a_link closing link

Deprecated:

Definition at line 1262 of file class.ilTable2GUI.php.

        {
                $this->close_command = $a_link;
        }

◆ setCloseFormTag()

ilTable2GUI::setCloseFormTag ( $a_val )

Set close form tag.

Parameters

boolean close form tag

Definition at line 155 of file class.ilTable2GUI.php.

        {
                $this->close_form_tag = $a_val;
        }

Referenced by ilQuestionPoolImportVerificationTableGUI\__construct().

Here is the caller graph for this function:

◆ setContext()

ilTable2GUI::setContext ( $id )

Set context.

Parameters

string $id

Definition at line 2978 of file class.ilTable2GUI.php.

        {
                if(trim($id))
                {
                        $this->context = $id;
                }
        }

Referenced by __construct().

Here is the caller graph for this function:

◆ setCustomPreviousNext()

ilTable2GUI::setCustomPreviousNext	(	$a_prev_link,
		$a_next_link
	)

Set custom previous/next links.

Definition at line 924 of file class.ilTable2GUI.php.

        {
                $this->custom_prev_next = true;
                $this->custom_prev = $a_prev_link;
                $this->custom_next = $a_next_link;
        }

◆ setData()

ilTable2GUI::setData ( $a_data )

final

set table data @access public

Parameters

array table data

Reimplemented from ilTableGUI.

Definition at line 553 of file class.ilTable2GUI.php.

        {
                // check column names against given data (to ensure proper sorting)
                if(DEVMODE && 
                        $this->enabled["header"] && $this->enabled["sort"] && 
                        $this->columns_determined && is_array($this->column) && 
                        is_array($a_data) && sizeof($a_data) && !$this->getExternalSorting())
                {
                        $check = $a_data;
                        $check = array_keys(array_shift($check));                       
                        foreach($this->column as $col)
                        {
                                if($col["sort_field"] && !in_array($col["sort_field"], $check))
                                {
                                        $invalid[] = $col["sort_field"];
                                }
                        }
                        
                        // this triggers an error, if some columns are not set for some rows
                        // which may just be a representation of "null" values, e.g.
                        // ilAdvancedMDValues:queryForRecords works that way.
/*                      if(sizeof($invalid))
                        {
                                trigger_error("The following columns are defined as sortable but".
                                        " cannot be found in the given data: ".implode(", ", $invalid).
                                        ". Sorting will not work properly.", E_USER_WARNING);
                        }*/
                }
                
                $this->row_data = $a_data;
        }

References getExternalSorting().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDefaultFilterVisiblity()

ilTable2GUI::setDefaultFilterVisiblity ( $a_status )

Set default filter visiblity.

Parameters

bool $a_status

Definition at line 1177 of file class.ilTable2GUI.php.

        {
                $this->default_filter_visibility = $a_status;
        }

Referenced by ilParticipantTableGUI\initFilter().

Here is the caller graph for this function:

◆ setDefaultOrderDirection()

ilTable2GUI::setDefaultOrderDirection ( $a_defaultorderdirection )

Set Default order direction.

Parameters

string $a_defaultorderdirection Default order direction

Definition at line 1158 of file class.ilTable2GUI.php.

        {
                $this->defaultorderdirection = $a_defaultorderdirection;
        }

Here is the caller graph for this function:

◆ setDefaultOrderField()

ilTable2GUI::setDefaultOrderField ( $a_defaultorderfield )

Set Default order field.

Parameters

string $a_defaultorderfield Default order field

Definition at line 1138 of file class.ilTable2GUI.php.

        {
                $this->defaultorderfield = $a_defaultorderfield;
        }

Here is the caller graph for this function:

◆ setDescription()

ilTable2GUI::setDescription ( $a_val )

Set description.

Parameters

string description

Definition at line 523 of file class.ilTable2GUI.php.

        {
                $this->description = $a_val;
        }

Here is the caller graph for this function:

◆ setDisableFilterHiding()

ilTable2GUI::setDisableFilterHiding ( $a_val = true )

Set disable filter hiding.

Parameters

boolean disable filter hiding

Definition at line 814 of file class.ilTable2GUI.php.

        {
                $this->disable_filter_hiding = $a_val;
        }

Here is the caller graph for this function:

◆ setDisplayAsBlock()

ilTable2GUI::setDisplayAsBlock ( $a_val )

Set display as block.

Parameters

boolean display as block

Definition at line 1002 of file class.ilTable2GUI.php.

        {
                $this->display_as_block = $a_val;
        }

Referenced by assFileUploadFileTableGUI\__construct(), and ilCalendarCategoryTableGUI\__construct().

Here is the caller graph for this function:

◆ setEnableAllCommand()

ilTable2GUI::setEnableAllCommand ( $a_value )

Enable actions for all entries in current result.

Parameters

bool $a_value

Definition at line 3405 of file class.ilTable2GUI.php.

        {
                $this->enable_command_for_all = (bool)$a_value;
        }

Referenced by ilUserTableGUI\__construct().

Here is the caller graph for this function:

◆ setEnableHeader()

ilTable2GUI::setEnableHeader ( $a_enableheader )

Set Enable Header.

Parameters

boolean $a_enableheader Enable Header

Definition at line 475 of file class.ilTable2GUI.php.

        {
                $this->enabled["header"] = $a_enableheader;
        }

Here is the caller graph for this function:

◆ setEnableNumInfo()

ilTable2GUI::setEnableNumInfo ( $a_val )

Set enable num info.

Parameters

boolean enable number of records info

Definition at line 495 of file class.ilTable2GUI.php.

        {
                $this->num_info = $a_val;
        }

Here is the caller graph for this function:

◆ setEnableTitle()

ilTable2GUI::setEnableTitle ( $a_enabletitle )

Set Enable Title.

Parameters

boolean $a_enabletitle Enable Title

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

        {
                $this->enabled["title"] = $a_enabletitle;
        }

Here is the caller graph for this function:

◆ setExportFormats()

ilTable2GUI::setExportFormats ( array $formats )

Set available export formats.

Parameters

array $formats

Definition at line 3154 of file class.ilTable2GUI.php.

    {           
                $this->export_formats = array();
                
                // #11339
                $valid = array(self::EXPORT_EXCEL => "tbl_export_excel",
                        self::EXPORT_CSV => "tbl_export_csv");
                
                foreach($formats as $format)
            {
                   if(array_key_exists($format, $valid))
                   {
                                $this->export_formats[$format] = $valid[$format];
                   }
                }
        }

References $valid.

Here is the caller graph for this function:

◆ setExternalSegmentation()

ilTable2GUI::setExternalSegmentation ( $a_val )

Set external segmentation.

Parameters

boolean data is segmented externally

Definition at line 1106 of file class.ilTable2GUI.php.

        {
                $this->ext_seg = $a_val;
        }

Here is the caller graph for this function:

◆ setExternalSorting()

ilTable2GUI::setExternalSorting ( $a_val )

Set external sorting.

Parameters

boolean data is sorted externally

Definition at line 1042 of file class.ilTable2GUI.php.

        {
                $this->ext_sort = $a_val;
        }

Here is the caller graph for this function:

◆ setFilterCols()

ilTable2GUI::setFilterCols ( $a_val )

Set filter columns.

Parameters

int	number of filter columns

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

        {
                $this->filter_cols = $a_val;
        }

◆ setFilterCommand()

ilTable2GUI::setFilterCommand	(	$a_val,
		$a_caption = `null`
	)

Set filter command.

Parameters

string	filter command
string	filter caption

Definition at line 1063 of file class.ilTable2GUI.php.

        {
                $this->filter_cmd = $a_val;
                $this->filter_cmd_txt = $a_caption;
        }

Here is the caller graph for this function:

◆ SetFilterValue()

ilTable2GUI::SetFilterValue	(	ilFormPropertyGUI	$a_item,
			$a_value
	)

protected

Set current filter value.

Parameters

ilFormPropertyGUI	$a_item
mixed	$a_value

Definition at line 2956 of file class.ilTable2GUI.php.

        {
                if(method_exists($a_item, "setChecked"))
                {
                        $a_item->setChecked($a_value);
                }
                else if(method_exists($a_item, "setValue"))
                {
                        $a_item->setValue($a_value);
                }
                else if(method_exists($a_item, "setDate"))
                {
                        $a_item->setDate(new ilDate($a_value, IL_CAL_DATE));
                }
                $a_item->writeToSession();
        }

References IL_CAL_DATE, and ilFormPropertyGUI\writeToSession().

Referenced by ilTrMatrixTableGUI\getItems(), and ilTrMatrixTableGUI\initFilter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setFormAction()

ilTable2GUI::setFormAction	(	$a_form_action,
		$a_multipart = `false`
	)

final

Set Form action parameter.

Parameters

string	$a_form_action	Form action
bvool	$a_multipart	Form multipart status

Definition at line 937 of file class.ilTable2GUI.php.

        {
                $this->form_action = $a_form_action;
                $this->form_multipart = (bool)$a_multipart;
        }

Here is the caller graph for this function:

◆ setFormName()

ilTable2GUI::setFormName ( $a_formname = "" )

Set Form name.

Parameters

string $a_formname Form name

Reimplemented from ilTableGUI.

Definition at line 958 of file class.ilTable2GUI.php.

        {
                $this->formname = $a_formname;
        }

Here is the caller graph for this function:

◆ setHeaderHTML()

ilTable2GUI::setHeaderHTML ( $html )

set header html

Parameters

string $html

Definition at line 2837 of file class.ilTable2GUI.php.

        {
            $this->headerHTML = $html;
        }

References $html.

◆ setId()

ilTable2GUI::setId ( $a_val )

Set id.

Parameters

string element id

Definition at line 978 of file class.ilTable2GUI.php.

        {
                $this->id = $a_val;
                if ($this->getPrefix() == "")
                {
                        $this->setPrefix($a_val);
                }
        }

References getPrefix(), and setPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setIsDataTable()

ilTable2GUI::setIsDataTable ( $a_val )

Set is data table.

Parameters

boolean is data table

Definition at line 435 of file class.ilTable2GUI.php.

        {
                $this->datatable = $a_val;
        }

Referenced by ilPDNewsTableGUI\__construct(), and __construct().

Here is the caller graph for this function:

◆ setLimit()

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

set max.

datasets displayed per page @access public

Parameters

integer	limit
integer	default limit

Reimplemented from ilTableGUI.

Definition at line 3465 of file class.ilTable2GUI.php.

        {
                parent::setLimit($a_limit, $a_default_limit);
                
                // #17077 - if limit is set "manually" to 9999, force rows selector off
                if($a_limit == 9999 &&
                        $this->limit_determined)
                {               
                        $this->rows_selector_off = true;
                }
        }

Here is the caller graph for this function:

◆ setNoEntriesText()

ilTable2GUI::setNoEntriesText ( $a_text )

Set text for an empty table.

Parameters

string $a_text Text

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

        {
                $this->noentriestext = $a_text;
        }

Referenced by ilCourseObjectiveMaterialAssignmentTableGUI\__construct(), ilObjectRolePermissionTableGUI\__construct(), ilObjectRoleTemplatePermissionTableGUI\__construct(), ilObjectivesAlignmentTableGUI\__construct(), ilMailingListsTableGUI\__construct(), ilQuestionCumulatedStatisticsTableGUI\__construct(), and ilAssQuestionHintsTableGUI\__construct().

Here is the caller graph for this function:

◆ setOpenFormTag()

ilTable2GUI::setOpenFormTag ( $a_val )

Set open form tag.

Parameters

boolean open form tag

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

        {
                $this->open_form_tag = $a_val;
        }

Referenced by ilUploadDirFilesTableGUI\__construct(), and ilQuestionPoolImportVerificationTableGUI\__construct().

Here is the caller graph for this function:

◆ setOrderField()

ilTable2GUI::setOrderField ( $a_order_field )

set order column

Parameters

string (array) field name for ordering

Definition at line 543 of file class.ilTable2GUI.php.

        {
                $this->order_field = $a_order_field;
        }

Referenced by ilDataBibliographicRecordListTableGUI\__construct(), determineOffsetAndOrder(), ilRegistrationCodesTableGUI\getItems(), and ilCalendarManageTableGUI\resetToDefaults().

Here is the caller graph for this function:

◆ setOrderLink()

ilTable2GUI::setOrderLink	(	$sort_field,
		$order_dir
	)

Reimplemented from ilTableGUI.

Definition at line 1353 of file class.ilTable2GUI.php.

        {
                global $ilCtrl, $ilUser;
                
                $hash = "";
                if (is_object($ilUser) && $ilUser->getPref("screen_reader_optimization"))
                {
                        $hash = "#".$this->getTopAnchor();
                }
 
                $old = $_GET[$this->getNavParameter()];
                
                // set order link
                $ilCtrl->setParameter($this->parent_obj,
                        $this->getNavParameter(),
                        $sort_field.":".$order_dir.":".$this->offset);
                $this->tpl->setVariable("TBL_ORDER_LINK",
                        $ilCtrl->getLinkTarget($this->parent_obj, $this->parent_cmd).$hash);
                
                // set old value of nav variable
                $ilCtrl->setParameter($this->parent_obj,
                        $this->getNavParameter(), $old);
        }

References $_GET, $ilCtrl, $ilUser, $old, and getNavParameter().

Referenced by fillHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPrefix()

ilTable2GUI::setPrefix ( $a_prefix )

final

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

Parameters

string prefix

Reimplemented from ilTableGUI.

Definition at line 602 of file class.ilTable2GUI.php.

        {
                $this->prefix = $a_prefix;
        }

Here is the caller graph for this function:

◆ setPreventDoubleSubmission()

ilTable2GUI::setPreventDoubleSubmission ( $a_val )

Set prevent double submission.

Parameters

bool $a_val prevent double submission

Definition at line 3450 of file class.ilTable2GUI.php.

        {
                $this->prevent_double_submission = $a_val;
        }

◆ setPrintMode()

ilTable2GUI::setPrintMode ( $a_value = false )

Toogle print mode.

Parameters

bool $a_value

Definition at line 3175 of file class.ilTable2GUI.php.

    {
                $this->print_mode = (bool)$a_value;
        }

Referenced by ilTrObjectUsersPropsTableGUI\__construct(), ilTrSummaryTableGUI\__construct(), and ilTrUserObjectsPropsTableGUI\__construct().

Here is the caller graph for this function:

◆ setResetCommand()

ilTable2GUI::setResetCommand	(	$a_val,
		$a_caption = `null`
	)

Set reset filter command.

Parameters

string	reset command
string	reset caption

Definition at line 1085 of file class.ilTable2GUI.php.

        {
                $this->reset_cmd = $a_val;
                $this->reset_cmd_txt = $a_caption;
        }

Here is the caller graph for this function:

◆ setRowSelectorLabel()

ilTable2GUI::setRowSelectorLabel ( $row_selector_label )

Parameters

string $row_selector_label

Definition at line 3431 of file class.ilTable2GUI.php.

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

References $row_selector_label.

Referenced by ilForumTopicTableGUI\initMergeThreadsTable().

Here is the caller graph for this function:

◆ setRowTemplate()

ilTable2GUI::setRowTemplate	(	$a_template,
		$a_template_dir = `""`
	)

final

Set row template.

Parameters

string	$a_template	Template file name.
string	$a_template_dir	Service/Module directory.

Definition at line 1127 of file class.ilTable2GUI.php.

        {
                $this->row_template = $a_template;
                $this->row_template_dir = $a_template_dir;
        }

Here is the caller graph for this function:

◆ setSelectAllCheckbox()

ilTable2GUI::setSelectAllCheckbox ( $a_select_all_checkbox )

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

Parameters

string $a_select_all_checkbox name of the checkbox

Reimplemented from ilTableGUI.

Definition at line 1032 of file class.ilTable2GUI.php.

        {
                $this->select_all_checkbox = $a_select_all_checkbox;
        }

Here is the caller graph for this function:

◆ setShowRowsSelector()

ilTable2GUI::setShowRowsSelector ( $a_value )

Toggle rows-per-page selector.

Parameters

bool $a_value

Definition at line 3001 of file class.ilTable2GUI.php.

        {
                $this->show_rows_selector = (bool)$a_value;
        }

Here is the caller graph for this function:

◆ setShowTemplates()

ilTable2GUI::setShowTemplates ( $a_value )

Toggle templates.

Parameters

bool $a_value

Definition at line 3021 of file class.ilTable2GUI.php.

        {
                $this->show_templates = (bool)$a_value;
        }

Here is the caller graph for this function:

◆ setTitle()

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

final

Set title and title icon.

Reimplemented from ilTableGUI.

Definition at line 513 of file class.ilTable2GUI.php.

        {
                parent::setTitle($a_title, $a_icon, $a_icon_alt);
        }

Here is the caller graph for this function:

◆ setTopAnchor()

ilTable2GUI::setTopAnchor ( $a_val )

Set top anchor.

Parameters

string top anchor

Definition at line 395 of file class.ilTable2GUI.php.

        {
                $this->top_anchor = $a_val;
        }

Referenced by ilBookmarkAdministrationTableGUI\__construct().

Here is the caller graph for this function:

◆ setTopCommands()

ilTable2GUI::setTopCommands ( $a_val )

Set top commands (display command buttons on top of table, too)

Parameters

boolean top commands true/false

Definition at line 1306 of file class.ilTable2GUI.php.

        {
                $this->top_commands = $a_val;
        }

Here is the caller graph for this function:

◆ storeNavParameter()

ilTable2GUI::storeNavParameter ( )

Definition at line 1585 of file class.ilTable2GUI.php.

        {
                if ($this->getOrderField() != "")
                {
                        $this->storeProperty("order", $this->getOrderField());
                }
                if ($this->getOrderDirection() != "")
                {
                        $this->storeProperty("direction", $this->getOrderDirection());
                }
//echo "-".$this->getOffset()."-";
                if ($this->getOffset() !== "")
                {
                        $this->storeProperty("offset", $this->getOffset());
                }
        }

References getOffset(), ilTableGUI\getOrderDirection(), getOrderField(), and storeProperty().

Referenced by ilLPTableBaseGUI\executeCommand(), and getHTML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ storeProperty()

ilTable2GUI::storeProperty	(	$type,
		$value
	)

Store table property.

Parameters

string	$type
mixed	$value

Definition at line 2848 of file class.ilTable2GUI.php.

        {
                global $ilUser;
 
                if(is_object($ilUser) && $this->getId() != "")
                {
                        include_once("./Services/Table/classes/class.ilTablePropertiesStorage.php");
                        $tab_prop = new ilTablePropertiesStorage();
 
                        $tab_prop->storeProperty($this->getId(), $ilUser->getId(), $type, $value);
                }
        }

References $ilUser, and getId().

Referenced by determineLimit(), determineSelectedColumns(), determineSelectedFilters(), restoreTemplate(), and storeNavParameter().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeFilterToSession()

ilTable2GUI::writeFilterToSession ( )

Write filter values to session.

Reimplemented in ilMailFolderTableGUI.

Definition at line 2056 of file class.ilTable2GUI.php.

        {                               
                $advmd_record_gui = null;
                if(method_exists($this, "getAdvMDRecordGUI"))
                {
                        $advmd_record_gui = $this->getAdvMDRecordGUI();
                }
        
                foreach ($this->getFilterItems() as $item)
                {                               
                        if($advmd_record_gui &&
                                $this->isAdvMDFilter($advmd_record_gui, $item))
                        {
                                continue;
                        }                                       
                        
                        if ($item->checkInput())
                        {
                                $item->setValueByArray($_POST);
                                $item->writeToSession();
                        }
                }
                foreach ($this->getFilterItems(true) as $item)
                {
                        if($advmd_record_gui &&
                                $this->isAdvMDFilter($advmd_record_gui, $item))
                        {
                                continue;
                        }       
                        
                        if ($item->checkInput())
                        {
                                $item->setValueByArray($_POST);
                                $item->writeToSession();
                        }
                }
                
                if($advmd_record_gui)
                {       
                        $advmd_record_gui->importFilter();
                }       
                
                // #13209
                unset($_REQUEST["tbltplcrt"]);
                unset($_REQUEST["tbltpldel"]);  
        }

References $_POST, getFilterItems(), and isAdvMDFilter().

Referenced by arIndexTableGUI\applyFilter(), ilTestQuestionBrowserTableGUI\applyFilterCmd(), and ilLPTableBaseGUI\executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $close_command

ilTable2GUI::$close_command = ""

protected

Definition at line 17 of file class.ilTable2GUI.php.

◆ $close_form_tag

ilTable2GUI::$close_form_tag = true

protected

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

Referenced by getCloseFormTag().

◆ $columns_determined

ilTable2GUI::$columns_determined = false

protected

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

◆ $context

ilTable2GUI::$context = ""

protected

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

Referenced by ilMailSearchCoursesMembersTableGUI\__construct(), ilMailSearchCoursesTableGUI\__construct(), and getContext().

◆ $default_filter_visibility

ilTable2GUI::$default_filter_visibility = false

protected

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

Referenced by getDefaultFilterVisibility().

◆ $disable_filter_hiding

ilTable2GUI::$disable_filter_hiding = false

protected

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

Referenced by getDisableFilterHiding().

◆ $enable_command_for_all

ilTable2GUI::$enable_command_for_all

protected

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

◆ $export_formats

ilTable2GUI::$export_formats

protected

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

◆ $export_mode

ilTable2GUI::$export_mode

protected

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

Referenced by getExportMode().

◆ $ext_seg

ilTable2GUI::$ext_seg = false

protected

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

Referenced by getExternalSegmentation().

◆ $ext_sort

ilTable2GUI::$ext_sort = false

protected

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

Referenced by getExternalSorting().

◆ $filter_cmd

ilTable2GUI::$filter_cmd = 'applyFilter'

protected

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

Referenced by getFilterCommand().

◆ $filter_cols

ilTable2GUI::$filter_cols = 5

protected

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

Referenced by getFilterCols().

◆ $filters

ilTable2GUI::$filters = array()

protected

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

Referenced by getFilterItems().

◆ $filters_determined

ilTable2GUI::$filters_determined = false

protected

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

◆ $headerHTML

ilTable2GUI::$headerHTML

private

Definition at line 19 of file class.ilTable2GUI.php.

◆ $limit_determined

ilTable2GUI::$limit_determined = false

protected

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

◆ $mi_sel_buttons

ilTable2GUI::$mi_sel_buttons = null

protected

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

◆ $nav_determined

ilTable2GUI::$nav_determined = false

protected

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

◆ $open_form_tag

ilTable2GUI::$open_form_tag = true

protected

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

Referenced by getOpenFormTag().

◆ $optional_filters

ilTable2GUI::$optional_filters = array()

protected

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

Referenced by getFilterItems().

◆ $prevent_double_submission

ilTable2GUI::$prevent_double_submission = true

protected

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

Referenced by getPreventDoubleSubmission().

◆ $print_mode

ilTable2GUI::$print_mode

protected

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

Referenced by getPrintMode().

◆ $reset_cmd

ilTable2GUI::$reset_cmd = 'resetFilter'

protected

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

Referenced by getResetCommand().

◆ $restore_filter

ilTable2GUI::$restore_filter

protected

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

◆ $restore_filter_values

ilTable2GUI::$restore_filter_values

protected

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

◆ $row_selector_label

ilTable2GUI::$row_selector_label

protected

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

Referenced by getRowSelectorLabel(), and setRowSelectorLabel().

◆ $rows_selector_off

ilTable2GUI::$rows_selector_off = false

protected

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

◆ $selectable_columns

ilTable2GUI::$selectable_columns = array()

protected

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

Referenced by ilTrObjectUsersPropsTableGUI\getSelectableColumns().

◆ $selected_column

ilTable2GUI::$selected_column = array()

protected

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

Referenced by getCurrentState().

◆ $selected_filter

ilTable2GUI::$selected_filter = false

protected

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

◆ $show_rows_selector

ilTable2GUI::$show_rows_selector = true

protected

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

Referenced by getShowRowsSelector().

◆ $show_templates

ilTable2GUI::$show_templates = false

protected

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

Referenced by getShowTemplates().

◆ $sortable_fields

ilTable2GUI::$sortable_fields = array()

protected

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

◆ $top_anchor

ilTable2GUI::$top_anchor = "il_table_top"

protected

Definition at line 20 of file class.ilTable2GUI.php.

Referenced by getTopAnchor().

◆ $top_commands

ilTable2GUI::$top_commands = true

protected

Definition at line 33 of file class.ilTable2GUI.php.

Referenced by getTopCommands().

◆ $unique_id

ilTable2GUI::$unique_id

private

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

Referenced by __construct(), ilTermsOfServiceAcceptanceHistoryTableGUI\prepareRow(), and ilTermsOfServiceAgreementByLanguageTableGUI\prepareRow().

◆ ACTION_ALL_LIMIT

const ilTable2GUI::ACTION_ALL_LIMIT = 1000

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

Referenced by getAllCommandLimit().

◆ EXPORT_CSV

const ilTable2GUI::EXPORT_CSV = 2

Definition at line 81 of file class.ilTable2GUI.php.

Referenced by exportData().

◆ EXPORT_EXCEL

const ilTable2GUI::EXPORT_EXCEL = 1

Definition at line 80 of file class.ilTable2GUI.php.

Referenced by exportData(), and ilObjLanguageExtGUI\statisticsObject().

◆ FILTER_DATE

const ilTable2GUI::FILTER_DATE = 3

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

Referenced by addFilterItemByMetaType().

◆ FILTER_DATE_RANGE

const ilTable2GUI::FILTER_DATE_RANGE = 6

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

Referenced by ilDclDatetimeFieldRepresentation\addFilterInputFieldToTable(), addFilterItemByMetaType(), ilBookingObjectsTableGUI\initFilter(), ilRbacLogTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), and ilBookingReservationsTableGUI\initFilter().

◆ FILTER_DATETIME_RANGE

const ilTable2GUI::FILTER_DATETIME_RANGE = 8

Definition at line 78 of file class.ilTable2GUI.php.

Referenced by addFilterItemByMetaType(), ilTrObjectUsersPropsTableGUI\initFilter(), and ilTrSummaryTableGUI\initFilter().

◆ FILTER_DURATION_RANGE

const ilTable2GUI::FILTER_DURATION_RANGE = 7

Definition at line 77 of file class.ilTable2GUI.php.

Referenced by addFilterItemByMetaType(), ilTrObjectUsersPropsTableGUI\initFilter(), and ilTrSummaryTableGUI\initFilter().

◆ FILTER_LANGUAGE

const ilTable2GUI::FILTER_LANGUAGE = 4

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

Referenced by addFilterItemByMetaType(), ilTrObjectUsersPropsTableGUI\initFilter(), and ilTrSummaryTableGUI\initFilter().

◆ FILTER_NUMBER_RANGE

const ilTable2GUI::FILTER_NUMBER_RANGE = 5

Definition at line 75 of file class.ilTable2GUI.php.

Referenced by ilDclNumberFieldRepresentation\addFilterInputFieldToTable(), addFilterItemByMetaType(), ilTrObjectUsersPropsTableGUI\initFilter(), and ilTrSummaryTableGUI\initFilter().

◆ FILTER_SELECT

const ilTable2GUI::FILTER_SELECT = 2

Definition at line 72 of file class.ilTable2GUI.php.

Referenced by ilDclBooleanFieldRepresentation\addFilterInputFieldToTable(), ilDclRatingFieldRepresentation\addFilterInputFieldToTable(), ilDclReferenceFieldRepresentation\addFilterInputFieldToTable(), addFilterItemByMetaType(), ilCourseParticipantsGroupsTableGUI\initFilter(), ilObjectRolePermissionTableGUI\initFilter(), ilRbacLogTableGUI\initFilter(), ilParticipantTableGUI\initFilter(), ilTrObjectUsersPropsTableGUI\initFilter(), ilTrSummaryTableGUI\initFilter(), and ilBookingReservationsTableGUI\initFilter().

◆ FILTER_TEXT

const ilTable2GUI::FILTER_TEXT = 1

Definition at line 71 of file class.ilTable2GUI.php.

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

Services/Table/classes/class.ilTable2GUI.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addColumn()

◆ addCommandButton()

◆ addCommandButtonInstance()

◆ addFilterItem()

◆ addFilterItemByMetaType()

◆ addHeaderCommand()

◆ addHiddenInput()

◆ addMultiCommand()

◆ addMultiItemSelectionButton()

◆ addSelectionButton()

◆ clearCommandButtons()

◆ dataExists()

◆ deleteTemplate()

◆ determineLimit()

◆ determineOffsetAndOrder()

◆ determineSelectedColumns()

◆ determineSelectedFilters()

◆ executeCommand()

◆ exportData()

◆ fillActionRow()

◆ fillFooter()

◆ fillHeader()

◆ fillHeaderCSV()

◆ fillHeaderExcel()

◆ fillHiddenRow()

◆ fillMetaCSV()

◆ fillMetaExcel()

◆ fillRow()

◆ fillRowCSV()

◆ fillRowExcel()

◆ getAllCommandLimit()

◆ getCloseFormTag()

◆ getContext()

◆ getCurrentState()

◆ getData()

◆ getDefaultFilterVisibility()

◆ getDefaultOrderDirection()

◆ getDefaultOrderField()

◆ getDescription()

◆ getDisableFilterHiding()

◆ getDisplayAsBlock()

◆ getEnableHeader()

◆ getEnableNumInfo()

◆ getEnableTitle()

◆ getExportMode()

◆ getExternalSegmentation()

◆ getExternalSorting()

◆ getFilterCols()

◆ getFilterCommand()

◆ getFilterItemByPostVar()

◆ getFilterItems()

◆ getFilterValue()

◆ getFormAction()

◆ getFormName()

◆ getHTML()

◆ getId()

◆ getIsDataTable()

◆ getLimit()

◆ getLinkbar()

◆ getNavParameter()

◆ getNoEntriesText()

◆ getOffset()

◆ getOpenFormTag()

◆ getOrderField()

◆ getParentCmd()

◆ getParentObject()

◆ getPrefix()

◆ getPreventDoubleSubmission()

◆ getPrintMode()