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

Inheritance diagram for ilModulesTableGUI:

Collaboration diagram for ilModulesTableGUI:

Public Member Functions
	__construct (ilObjRepositorySettingsGUI $a_parent_obj, string $a_parent_cmd="", bool $a_has_write=false)

	getComponents ()

Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

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

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

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

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

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

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

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

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

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

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

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

	setContext (string $id)

	getContext ()

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

	getShowRowsSelector ()

	getLimit ()

	getOffset ()

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

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

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

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	setLimit (int $a_limit=0, int $a_default_limit=0)

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

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

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

	getData ()

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

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

	setHeaderNames (array $a_header_names)

	getColumnCount ()

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

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

	setOneColumnWidth (string $a_column_width, int $a_column_number)

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

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

	getLimit ()

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

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

	getOffset ()

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

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

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

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

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

	setFormName (string $a_name="cmd")

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

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $btn_value)

Protected Member Functions
	fillRow (array $a_set)

	getPluginComponents (array $obj_types, string $component, string $slotName, string $slotId)

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	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, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

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

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

	setFilterValue (ilTableFilterItem $a_item, $a_value)

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

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

	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...

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

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

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

Protected Attributes
ilObjectDefinition	$obj_definition

ilSetting	$settings

array	$pos_group_options

int	$old_grp_id

ilComponentRepository	$component_repository

Protected Attributes inherited from ilTable2GUI
string	$requested_nav_par2 = ""

string	$requested_nav_par = ""

string	$requested_nav_par1 = ""

ILIAS Table TableGUIRequest	$table_request = null

array	$selected_columns = []

ilCtrl	$ctrl

object	$parent_obj = null

string	$parent_cmd = ""

string	$close_command = ""

string	$top_anchor = "il_table_top"

array	$filters = array()

array	$optional_filters = array()

string	$filter_cmd = 'applyFilter'

string	$reset_cmd = 'resetFilter'

int	$filter_cols = 5

bool	$ext_sort = false

bool	$ext_seg = false

string	$context = ""

array	$mi_sel_buttons = []

bool	$disable_filter_hiding = false

bool	$top_commands = true

array	$selectable_columns = array()

array	$selected_column = array()

bool	$show_rows_selector = true

bool	$rows_selector_off = false

bool	$nav_determined = false

bool	$limit_determined = false

bool	$filters_determined = false

bool	$columns_determined = false

bool	$open_form_tag = true

bool	$close_form_tag = true

array	$export_formats = []

int	$export_mode = 0

bool	$print_mode = false

bool	$enable_command_for_all = false

bool	$restore_filter = false

array	$restore_filter_values = []

bool	$default_filter_visibility = false

array	$sortable_fields = array()

bool	$prevent_double_submission = true

string	$row_selector_label = ""

bool	$select_all_on_top = false

array	$sel_buttons = []

string	$nav_value = ''

string	$noentriestext = ''

string	$css_row = ''

bool	$display_as_block = false

string	$description = ''

string	$id = ""

bool	$custom_prev_next = false

string	$reset_cmd_txt = ""

string	$defaultorderfield = ""

string	$defaultorderdirection = ""

array	$column = []

bool	$datatable = false

bool	$num_info = false

bool	$form_multipart = false

array	$row_data = []

string	$order_field = ""

array	$selected_filter = []

string	$form_action = ""

string	$formname = ""

string	$sort_order = ""

array	$buttons = []

array	$multi = []

array	$hidden_inputs = []

array	$header_commands = []

string	$row_template = ""

string	$row_template_dir = ""

string	$filter_cmd_txt = ""

string	$custom_prev = ""

string	$custom_next = ""

array	$raw_post_data = null

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTableGUI
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()

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

Data Fields inherited from ilTable2GUI
const	FILTER_TEXT = 1

const	FILTER_SELECT = 2

const	FILTER_DATE = 3

const	FILTER_LANGUAGE = 4

const	FILTER_NUMBER_RANGE = 5

const	FILTER_DATE_RANGE = 6

const	FILTER_DURATION_RANGE = 7

const	FILTER_DATETIME_RANGE = 8

const	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Detailed Description

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

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

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning TableGUI class for module listing

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilModulesTableGUI::__construct	(	ilObjRepositorySettingsGUI	$a_parent_obj,
		string	$a_parent_cmd = `""`,
		bool	$a_has_write = `false`
	)

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

References $DIC, ilTableGUI\$lng, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ILIAS\Repository\ctrl(), getComponents(), ILIAS\Repository\lng(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ILIAS\Repository\settings(), ilTable2GUI\setTitle(), and ilLanguage\txt().

       {
         global $DIC;
 
         $this->ctrl = $DIC->ctrl();
         $this->lng = $DIC->language();
         $this->obj_definition = $DIC["objDefinition"];
         $this->settings = $DIC->settings();
         $this->component_repository = $DIC["component.repository"];
         $ilCtrl = $DIC->ctrl();
         $lng = $DIC->language();
 
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
         $this->setId("repmodtbl");
 
         $this->setTitle($lng->txt("cmps_repository_object_types"));
 
         $this->addColumn($lng->txt("cmps_add_new_rank"), "");
         $this->addColumn($lng->txt("cmps_rep_object"), "");
         $this->addColumn($lng->txt("cmps_module"), "");
         $this->addColumn($lng->txt("cmps_group"), "");
         $this->addColumn($lng->txt("cmps_enable_creation"), "");
 
         if ($a_has_write) {
             // save options command
             $this->addCommandButton("saveModules", $lng->txt("cmps_save_options"));
         }
 
         $this->setEnableHeader(true);
         $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
         $this->setRowTemplate(
             "tpl.table_row_module.html",
             "components/ILIAS/Repository/Administration"
         );
         $this->setLimit(9999);
         $this->setExternalSorting(true);
 
         $this->getComponents();
 
         $this->old_grp_id = 0;
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilModulesTableGUI::fillRow ( array $a_set )

protected

Definition at line 172 of file class.ilModulesTableGUI.php.

References ilObject\_getIcon(), ilLegacyFormElementsUtil\formSelect(), and ilLegacyFormElementsUtil\prepareFormOutput().

                                             : void
     {
         if ((int) $a_set["pos_group"] !== $this->old_grp_id) {
             $this->tpl->setCurrentBlock("pos_grp_bl");
             $this->tpl->setVariable("TXT_POS_GRP", $this->pos_group_options[$a_set["pos_group"]]);
             $this->tpl->parseCurrentBlock();
 
             $this->tpl->setCurrentBlock("tbl_content");
             $this->tpl->parseCurrentBlock();
 
             $this->css_row = ($this->css_row !== "tblrow1")
                     ? "tblrow1"
                     : "tblrow2";
             $this->tpl->setVariable("CSS_ROW", $this->css_row);
 
             $this->old_grp_id = $a_set["pos_group"];
         }
 
         // group
         if ($a_set["group_id"] != "") {
             $this->tpl->setCurrentBlock("group");
             $this->tpl->setVariable("VAL_GROUP", $a_set["group"]);
             $this->tpl->setVariable("VAL_GROUP_ID", $a_set["group_id"]);
             $this->tpl->parseCurrentBlock();
         }
 
         $this->tpl->setCurrentBlock("rep_object");
         // #11598 - using "caption" (from lng) instead of "object"
         $this->tpl->setVariable("TXT_REP_OBJECT", $a_set["caption"]);
         $this->tpl->setVariable("TXT_REP_OBJECT_ID", $a_set["id"]);
         $this->tpl->setVariable(
             "IMG_REP_OBJECT",
             ilObject::_getIcon(0, "tiny", $a_set["id"])
         );
 
         // grouping
         $sel = ilLegacyFormElementsUtil::formSelect(
             $a_set["pos_group"],
             "obj_grp[" . $a_set["id"] . "]",
             $this->pos_group_options,
             false,
             true
         );
         $this->tpl->setVariable("GROUP_SEL", $sel);
 
         // position
         $this->tpl->setVariable("VAR_POS", "obj_pos[" . $a_set["id"] . "]");
         $this->tpl->setVariable("VAL_POS", ilLegacyFormElementsUtil::prepareFormOutput($a_set["pos"]));
 
         // enable creation
         $this->tpl->setVariable("VAR_DISABLE_CREATION", "obj_enbl_creation[" . $a_set["id"] . "]");
         if ($a_set["creation"]) {
             $this->tpl->setVariable(
                 "CHECKED_DISABLE_CREATION",
                 ' checked="checked" '
             );
         }
 
         $this->tpl->setVariable("TXT_MODULE_NAME", $a_set["subdir"]);
     }

Here is the call graph for this function:

◆ getComponents()

ilModulesTableGUI::getComponents ( )

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

References ilTableGUI\$data, $ilSetting, ilTableGUI\$lng, $obj_definition, $settings, ilObjRepositorySettings\getNewItemGroups(), getPluginComponents(), ILIAS\Repository\int(), null, ilTable2GUI\setData(), ilArrayUtil\sortArray(), ilLanguage\txt(), ilComponentInfo\TYPE_MODULES, and ilComponentInfo\TYPE_SERVICES.

Referenced by __construct().

                                    : void
     {
         $objDefinition = $this->obj_definition;
         $ilSetting = $this->settings;
         $lng = $this->lng;
 
         // unassigned objects should be last
         $this->pos_group_options = [0 => $lng->txt("rep_new_item_group_unassigned")];
         $pos_group_map[0] = "9999";
 
         foreach (ilObjRepositorySettings::getNewItemGroups() as $item) {
             $this->pos_group_options[$item["id"]] = $item["title"];
             $pos_group_map[$item["id"]] = $item["pos"];
         }
 
         $obj_types = [];
 
         // parse modules
         foreach ($this->component_repository->getComponents() as $mod) {
             if ($mod->getType() !== ilComponentInfo::TYPE_MODULES) {
                 continue;
             }
             $has_repo = false;
             $rep_types = $objDefinition::getRepositoryObjectTypesForComponent(
                 ilComponentInfo::TYPE_MODULES,
                 $mod->getName()
             );
             if (count($rep_types) > 0) {
                 foreach ($rep_types as $ridx => $rt) {
                     // we only want to display repository modules
                     if ($rt["repository"]) {
                         $has_repo = true;
                     } else {
                         unset($rep_types[$ridx]);
                     }
                 }
             }
             if ($has_repo) {
                 foreach ($rep_types as $rt) {
                     $obj_types[$rt["id"]] = [
                         "object" => $rt["class_name"],
                         "caption" => $lng->txt("obj_" . $rt["id"]),
                         "subdir" => $mod->getName(),
                         "grp" => $rt["grp"],
                         "default_pos" => $rt["default_pos"]
                     ];
                 }
             }
         }
 
         // parse plugins
         $obj_types = $this->getPluginComponents($obj_types, ilComponentInfo::TYPE_SERVICES, "Repository", "robj");
         $obj_types = $this->getPluginComponents($obj_types, ilComponentInfo::TYPE_MODULES, "OrgUnit", "orguext");
 
         // parse positions
         $data = [];
         foreach ($obj_types as $obj_type => $item) {
             $org_pos = $ilSetting->get("obj_add_new_pos_" . $obj_type);
             if (!(int) $org_pos) {
                 // no setting yet, use default
                 $org_pos = $item["default_pos"];
             }
             if (strlen($org_pos) < 8) {
                 // "old" setting without group part, add "unassigned" group
                 $org_pos = $pos_group_map[0] . str_pad($org_pos, 4, "0", STR_PAD_LEFT);
             }
 
             $pos_grp_id = $ilSetting->get("obj_add_new_pos_grp_" . $obj_type, '0');
 
             $group = null;
             if ($item["grp"] != "") {
                 $group = $objDefinition->getGroup($item["grp"]);
                 $group = $group["name"];
             }
 
             $data[] = [
                 "id" => $obj_type,
                 "object" => $item["object"],
                 "caption" => $item["caption"],
                 "subdir" => $item["subdir"],
                 "pos" => (int) substr($org_pos, 4),
                 "pos_group" => $pos_grp_id,
                 "creation" => !$ilSetting->get("obj_dis_creation_" . $obj_type, '0'),
                 "group_id" => $item["grp"],
                 "group" => $group,
                 "sort_key" => (int) $org_pos
             ];
         }
 
         $data = ilArrayUtil::sortArray($data, "sort_key", "asc", true);
 
         $this->setData($data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPluginComponents()

ilModulesTableGUI::getPluginComponents	(	array	$obj_types,
		string	$component,
		string	$slotName,
		string	$slotId
	)

protected

Definition at line 233 of file class.ilModulesTableGUI.php.

References ilTableGUI\$lng, XapiProxy\$plugin, ilObjectPlugin\lookupTxtById(), and ilLanguage\txt().

Referenced by getComponents().

      : array {
         $lng = $this->lng;
         $plugins = $this->component_repository->getPluginSlotById($slotId)->getActivePlugins();
         foreach ($plugins as $plugin) {
             $obj_types[$plugin->getId()] = [
                 "object" => $plugin->getName(),
                 "caption" => ilObjectPlugin::lookupTxtById($plugin->getId(), "obj_" . $plugin->getId()),
                 "subdir" => $lng->txt("cmps_plugin"),
                 "grp" => "",
                 "default_pos" => 2000
             ];
         }
         return $obj_types;
     }