Inheritance diagram for ilCourseParticipantsGroupsTableGUI:

Collaboration diagram for ilCourseParticipantsGroupsTableGUI:

Public Member Functions
	__construct (object $a_parent_obj, string $a_parent_cmd, int $ref_id)
	Constructor. More...

	initGroups ()
	find groups in course, exclude groups in groups More...

	initFilter ()
	Init filter. More...

	getItems ()

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)

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
int	$ref_id

int	$obj_id

array	$filter = []

array	$groups = []

array	$groups_rights = []

array	$participants = []

ilAccessHandler	$access

ilTree	$tree

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

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 23 of file class.ilCourseParticipantsGroupsTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilCourseParticipantsGroupsTableGUI::__construct	(	object	$a_parent_obj,
		string	$a_parent_cmd,
		int	$ref_id
	)

Constructor.

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

References $DIC, $ref_id, ILIAS\GlobalScreen\Provider\__construct(), ilObject\_lookupObjId(), ILIAS\Repository\access(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiItemSelectionButton(), ILIAS\Repository\ctrl(), getItems(), initFilter(), initGroups(), ILIAS\Repository\lng(), ilTable2GUI\setEnableHeader(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setLimit(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setTitle().

     {
         global $DIC;
 
         $this->access = $DIC->access();
         $this->tree = $DIC->repositoryTree();
 
         $this->ref_id = $ref_id;
         $this->obj_id = ilObject::_lookupObjId($ref_id);
 
         $this->setId('tblcrsprtgrp_' . $ref_id);
         parent::__construct($a_parent_obj, $a_parent_cmd);
         $this->lng->loadLanguageModule('grp');
         $this->setLimit(9999);
 
         $this->setTitle($this->lng->txt('crs_grp_assignments'));
 
         $this->addColumn('', '', '0');
         $this->addColumn($this->lng->txt("name"), "name", '35%');
         $this->addColumn($this->lng->txt("login"), "login", '35%');
         $this->addColumn($this->lng->txt("crs_groups_nr"), "groups_number");
         $this->addColumn($this->lng->txt("groups"));
 
         $this->setEnableHeader(true);
         $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, $a_parent_cmd));
         $this->setRowTemplate("tpl.crs_members_grp_row.html", "components/ILIAS/Course");
         $this->setSelectAllCheckbox("usrs");
 
         $this->initGroups();
 
         if ($this->groups) {
             $selectable_groups = [];
             foreach ($this->groups as $ref_id => $something) {
                 if ($this->groups_rights[$ref_id]['manage_members']) {
                     $selectable_groups[$ref_id] = $this->groups[$ref_id];
                 }
             }
             if ($selectable_groups !== []) {
                 $this->addMultiItemSelectionButton(
                     "grp_id",
                     $selectable_groups,
                     "add",
                     $this->lng->txt("crs_add_to_group")
                 );
             }
             $this->initFilter();
         }
         $this->getItems();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilCourseParticipantsGroupsTableGUI::fillRow ( array $a_set )

protected

Definition at line 202 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ilTableGUI\$title, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                             : void
     {
         $this->tpl->setVariable("VAL_ID", $a_set["usr_id"]);
 
         $this->tpl->setVariable("TXT_USER", $a_set["name"]);
         $this->tpl->setVariable("TXT_LOGIN", $a_set["login"]);
         $this->tpl->setVariable("VAL_GROUP_NUMBER", $a_set["groups_number"]);
 
         if (count($a_set["groups"]) !== 0) {
             foreach ($a_set["groups"] as $type => $groups) {
                 foreach ($groups as $grp_id => $title) {
                     if (
                         ($type == "admins" && $this->groups_rights[$grp_id]["edit_permission"]) ||
                         ($type == "members" && $this->groups_rights[$grp_id]["manage_members"])
                     ) {
                         $this->tpl->setCurrentBlock("groups_remove");
 
                         $this->tpl->setVariable("TXT_GROUP_REMOVE", $this->lng->txt("grp_unsubscribe"));
 
                         $this->ctrl->setParameter($this->parent_obj, "usr_id", $a_set["usr_id"]);
                         $this->ctrl->setParameter($this->parent_obj, "grp_id", $grp_id);
                         $this->tpl->setVariable(
                             "URL_REMOVE",
                             $this->ctrl->getLinkTarget($this->parent_obj, "confirmremove")
                         );
                         $this->ctrl->setParameter($this->parent_obj, "grp_id", "");
                         $this->ctrl->setParameter($this->parent_obj, "usr_id", "");
 
                         $this->tpl->parseCurrentBlock();
                     }
 
                     $this->tpl->setCurrentBlock("groups");
                     $this->tpl->setVariable("TXT_GROUP_TITLE", $title);
                     $this->tpl->parseCurrentBlock();
                 }
             }
         }
     }

Here is the call graph for this function:

◆ getItems()

ilCourseParticipantsGroupsTableGUI::getItems ( )

Definition at line 156 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ilCourseParticipants\_getInstanceByObjId(), ilObjUser\_lookupName(), ILIAS\Repository\access(), ILIAS\Repository\filter(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

Referenced by __construct().

                               : void
     {
         if ($this->groups) {
             $part = ilCourseParticipants::_getInstanceByObjId($this->obj_id);
             $members = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                 'manage_members',
                 'manage_members',
                 $this->ref_id,
                 $part->getMembers()
             );
 
             if ($members !== []) {
                 $usr_data = array();
                 foreach ($members as $usr_id) {
                     $name = ilObjUser::_lookupName($usr_id);
                     $user_groups = array("members" => array(), "admins" => array());
                     $user_groups_number = 0;
                     foreach (array_keys($this->participants) as $group_id) {
                         if (in_array($usr_id, $this->participants[$group_id]["members"])) {
                             $user_groups["members"][$group_id] = $this->groups[$group_id];
                             $user_groups_number++;
                         } elseif (in_array($usr_id, $this->participants[$group_id]["admins"])) {
                             $user_groups["admins"][$group_id] = $this->groups[$group_id];
                             $user_groups_number++;
                         }
                     }
 
                     if ((!$this->filter["name"] || stristr(implode("", $name), $this->filter["name"])) &&
                         (!$this->filter["group"] || array_key_exists($this->filter["group"], $user_groups["members"]) ||
                             array_key_exists($this->filter["group"], $user_groups["admins"]))) {
                         $usr_data[] = array("usr_id" => $usr_id,
                                             "name" => $name["lastname"] . ", " . $name["firstname"],
                                             "groups" => $user_groups,
                                             "groups_number" => $user_groups_number,
                                             "login" => $name["login"]
                         );
                     }
                 }
 
                 $usr_data = array_slice($usr_data, $this->getOffset(), $this->getLimit());
                 $this->setMaxCount(count($members));
                 $this->setData($usr_data);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilCourseParticipantsGroupsTableGUI::initFilter ( )

Init filter.

Definition at line 144 of file class.ilCourseParticipantsGroupsTableGUI.php.

References ilTable2GUI\addFilterItemByMetaType(), ILIAS\Repository\filter(), ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, and ILIAS\Repository\lng().

Referenced by __construct().

                                 : void
     {
         $item = $this->addFilterItemByMetaType("name", ilTable2GUI::FILTER_TEXT);
         $this->filter["name"] = $item->getValue();
 
         if ($this->groups) {
             $item = $this->addFilterItemByMetaType("group", ilTable2GUI::FILTER_SELECT);
             $item->setOptions(array("" => $this->lng->txt("all")) + $this->groups);
             $this->filter["group"] = $item->getValue();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initGroups()

ilCourseParticipantsGroupsTableGUI::initGroups ( )

find groups in course, exclude groups in groups

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

References ilGroupParticipants\_getInstanceByObjId(), and ILIAS\Repository\access().

Referenced by __construct().

                                 : void
     {
         $parent_node = $this->tree->getNodeData($this->ref_id);
         $groups = $this->tree->getSubTree($parent_node, true, ['grp']);
         if (is_array($groups) && count($groups)) {
             $this->participants = $this->groups = $this->groups_rights = array();
             foreach ($groups as $idx => $group_data) {
                 // check for group in group
                 if ($group_data["parent"] != $this->ref_id && $this->tree->checkForParentType(
                     $group_data["ref_id"],
                     "grp",
                     true
                 )) {
                     unset($groups[$idx]);
                 } else {
                     $this->groups[$group_data["ref_id"]] = $group_data["title"];
                     $this->groups_rights[$group_data["ref_id"]]["manage_members"] = $this->access->checkRbacOrPositionPermissionAccess(
                         'manage_members',
                         'manage_members',
                         $group_data['ref_id']
                     );
 
                     $this->groups_rights[$group_data["ref_id"]]["edit_permission"] = $this->access->checkAccess(
                         "edit_permission",
                         "",
                         $group_data["ref_id"]
                     );
 
                     $gobj = ilGroupParticipants::_getInstanceByObjId($group_data["obj_id"]);
 
                     $members = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                         'manage_members',
                         'manage_members',
                         $group_data['ref_id'],
                         $gobj->getMembers()
                     );
                     $admins = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
                         'manage_members',
                         'manage_members',
                         $group_data['ref_id'],
                         $gobj->getAdmins()
                     );
 
                     $this->participants[$group_data["ref_id"]]["members"] = $members;
                     $this->participants[$group_data["ref_id"]]["admins"] = $admins;
                 }
             }
         }
     }