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

Inheritance diagram for ilParticipantTableGUI:

Collaboration diagram for ilParticipantTableGUI:

Public Member Functions
	initFilter ()
	Init table filter. More...

	getSelectableColumns ()

	checkAcceptance (int $a_usr_id)

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 ()

	setShowTemplates (bool $a_value)

	getShowTemplates ()

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

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

	deleteTemplate (string $a_name)

	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
	getRepositoryObject ()

	getParticipants ()

	initSettings ()

	showActionLinks ($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
ilParticipants	$participants = null

array	$current_filter = []

ilObject	$rep_object

Protected Attributes inherited from ilTable2GUI
string	$requested_tmpl_delete

string	$requested_tmpl_create

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_templates = false

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

Static Protected Attributes
static bool	$export_allowed = false

static bool	$confirmation_required = true

static array	$accepted_ids = null

static array	$all_columns = null

static bool	$has_odf_definitions = false

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

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

Member Function Documentation

◆ checkAcceptance()

ilParticipantTableGUI::checkAcceptance ( int $a_usr_id )

Definition at line 134 of file class.ilParticipantTableGUI.php.

Referenced by ilGroupParticipantsTableGUI\parse(), ilLearningSequenceParticipantsTableGUI\parse(), and ilCourseParticipantsTableGUI\parse().

                                                   : bool
     {
         if (!self::$confirmation_required) {
             return true;
         }
         if (!self::$export_allowed) {
             return false;
         }
         return in_array($a_usr_id, self::$accepted_ids);
     }

Here is the caller graph for this function:

◆ getParticipants()

ilParticipantTableGUI::getParticipants ( )

protected

Definition at line 129 of file class.ilParticipantTableGUI.php.

References $participants.

Referenced by ilLearningSequenceParticipantsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), and ilCourseParticipantsTableGUI\fillRow().

                                         : ?\ilParticipants
     {
         return $this->participants;
     }

Here is the caller graph for this function:

◆ getRepositoryObject()

ilParticipantTableGUI::getRepositoryObject ( )

protected

Definition at line 124 of file class.ilParticipantTableGUI.php.

References $rep_object.

                                             : ilObject
     {
         return $this->rep_object;
     }

Here is the caller graph for this function:

◆ getSelectableColumns()

ilParticipantTableGUI::getSelectableColumns ( )

Definition at line 88 of file class.ilParticipantTableGUI.php.

References $DIC, $GLOBALS, $ilSetting, ilExportFieldsInfo\_getInstanceByType(), ilTable2GUI\getId(), getRepositoryObject(), and ILIAS\Repository\lng().

Referenced by ilGroupParticipantsTableGUI\__construct(), and ilCourseParticipantsTableGUI\__construct().

                                           : array
     {
         global $DIC;
 
         $ilSetting = $DIC['ilSetting'];
 
         $GLOBALS['DIC']['lng']->loadLanguageModule('ps');
         if (self::$all_columns) {
             # return self::$all_columns;
         }
 
         $ef = ilExportFieldsInfo::_getInstanceByType($this->getRepositoryObject()->getType());
         self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
 
         if ($ilSetting->get('user_portfolios')) {
             self::$all_columns['prtf'] = array(
                 'txt' => $this->lng->txt('obj_prtf'),
                 'default' => false
             );
         }
 
         $login = array_splice(self::$all_columns, 0, 1);
         self::$all_columns = array_merge(
             array(
                 'roles' =>
                     array(
                         'txt' => $this->lng->txt('objs_role'),
                         'default' => true
                     )
             ),
             self::$all_columns
         );
         self::$all_columns = array_merge($login, self::$all_columns);
         return self::$all_columns;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFilter()

ilParticipantTableGUI::initFilter ( )

Init table filter.

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

References $path, ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, ilTable2GUI\getParentObject(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ILIAS\Repository\int(), ilTable2GUI\isColumnSelected(), ILIAS\Repository\lng(), and ilTable2GUI\setDefaultFilterVisiblity().

Referenced by ilGroupParticipantsTableGUI\__construct(), ilCourseParticipantsTableGUI\__construct(), and ilLearningSequenceParticipantsTableGUI\initForm().

                                 : void
     {
         $this->setDefaultFilterVisiblity(true);
 
         $login = $this->addFilterItemByMetaType(
             'login',
             ilTable2GUI::FILTER_TEXT,
             false,
             $this->lng->txt('name')
         );
         $this->current_filter['login'] = (string) $login->getValue();
         $this->current_filter['roles'] = 0;
         if ($this->isColumnSelected('roles')) {
             $role = $this->addFilterItemByMetaType(
                 'roles',
                 ilTable2GUI::FILTER_SELECT,
                 false,
                 $this->lng->txt('objs_role')
             );
 
             $options = array();
             $options[0] = $this->lng->txt('all_roles');
             $role->setOptions($options + $this->getParentObject()->getLocalRoles());
             $this->current_filter['roles'] = (int) $role->getValue();
         }
 
         if ($this->isColumnSelected('org_units')) {
             $paths = ilOrgUnitPathStorage::getTextRepresentationOfOrgUnits();
 
             $options[0] = $this->lng->txt('select_one');
             foreach ($paths as $org_ref_id => $path) {
                 $options[$org_ref_id] = $path;
             }
 
             $org = $this->addFilterItemByMetaType(
                 'org_units',
                 ilTable2GUI::FILTER_SELECT,
                 false,
                 $this->lng->txt('org_units')
             );
             $org->setOptions($options);
             $this->current_filter['org_units'] = $org->getValue();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettings()

ilParticipantTableGUI::initSettings ( )

protected

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

References ilCourseDefinedFieldDefinition\_hasFields(), ilTable2GUI\getId(), ilPrivacySettings\getInstance(), getRepositoryObject(), and ilMemberAgreement\lookupAcceptedAgreements().

Referenced by ilLearningSequenceParticipantsTableGUI\__construct(), ilGroupParticipantsTableGUI\__construct(), and ilCourseParticipantsTableGUI\__construct().

                                      : void
     {
         if (self::$accepted_ids !== null) {
             return;
         }
         self::$export_allowed = ilPrivacySettings::getInstance()->checkExportAccess($this->getRepositoryObject()->getRefId());
 
         self::$confirmation_required = ($this->getRepositoryObject()->getType() === 'crs')
             ? ilPrivacySettings::getInstance()->courseConfirmationRequired()
             : ilPrivacySettings::getInstance()->groupConfirmationRequired();
 
         self::$accepted_ids = ilMemberAgreement::lookupAcceptedAgreements($this->getRepositoryObject()->getId());
 
         self::$has_odf_definitions = (bool) ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showActionLinks()

ilParticipantTableGUI::showActionLinks ( $a_set )

protected

Definition at line 161 of file class.ilParticipantTableGUI.php.

References ILIAS\Repository\ctrl(), ilTable2GUI\getId(), ilTable2GUI\getParentObject(), getRepositoryObject(), ilCourseConstants\IL_CRS_VIEW_OBJECTIVE, and ILIAS\Repository\lng().

Referenced by ilLearningSequenceParticipantsTableGUI\fillRow(), ilGroupParticipantsTableGUI\fillRow(), and ilCourseParticipantsTableGUI\fillRow().

                                               : void
     {
         $loc_enabled = (
             $this->getRepositoryObject()->getType() === 'crs' and
             $this->getRepositoryObject()->getViewMode() === ilCourseConstants::IL_CRS_VIEW_OBJECTIVE
         );
 
         if (!self::$has_odf_definitions && !$loc_enabled) {
             $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
             $this->tpl->setCurrentBlock('link');
             $this->tpl->setVariable('LINK_NAME', $this->ctrl->getLinkTarget($this->parent_obj, 'editMember'));
             $this->tpl->setVariable('LINK_TXT', $this->lng->txt('edit'));
             $this->tpl->parseCurrentBlock();
             return;
         }
 
         // show action menu
         $list = new ilAdvancedSelectionListGUI();
         $list->setSelectionHeaderClass('small');
         $list->setItemLinkClass('small');
         $list->setId('actl_' . $a_set['usr_id'] . '_' . $this->getId());
         $list->setListTitle($this->lng->txt('actions'));
 
         $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
         $list->addItem($this->lng->txt('edit'), '', $this->ctrl->getLinkTarget($this->getParentObject(), 'editMember'));
 
         if (self::$has_odf_definitions) {
             $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui', 'member_id', $a_set['usr_id']);
             $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_cdf_edit_member');
             $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui', 'editMember'));
         }
 
         if ($loc_enabled) {
             $this->ctrl->setParameterByClass('illomembertestresultgui', 'uid', $a_set['usr_id']);
             $list->addItem(
                 $this->lng->txt('crs_loc_mem_show_res'),
                 '',
                 $this->ctrl->getLinkTargetByClass('illomembertestresultgui', '')
             );
         }
         $this->tpl->setVariable('ACTION_USER', $list->getHTML());
     }