Inheritance diagram for ilLearningSequenceParticipantsTableGUI:

Collaboration diagram for ilLearningSequenceParticipantsTableGUI:

Public Member Functions
	__construct (ilLearningSequenceMembershipGUI $parent_gui, ilObjLearningSequence $ls_object, ilObjUserTracking $obj_user_tracking, ilPrivacySettings $privacy_settings, ilLanguage $lng, ilAccess $access, ilRbacReview $rbac_review, ilSetting $settings)

	parse ()

	getSelectableColumns ()

Public Member Functions inherited from ilParticipantTableGUI
	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
	initForm ()

	fillRow (array $a_set)

	getFirstAccess (int $user_id)

	getLastAccess (int $user_id)

	getCompletedSteps (int $user_id)

	getLastVisitedStep (int $user_id)
	Different to the concept we decide to use the title of the object instead of its actually number in the ls items list. More...

	getTitleFor (int $ref_id)

	getExportFieldsInfo ()

Protected Member Functions inherited from ilParticipantTableGUI
	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
ilLearningSequenceMembershipGUI	$parent_gui

ilObjLearningSequence	$ls_object

ilObjUserTracking	$obj_user_tracking

ilPrivacySettings	$privacy_settings

ilAccess	$access

ilRbacReview	$rbac_review

ilSetting	$settings

Protected Attributes inherited from ilParticipantTableGUI
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

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

Static Protected Attributes inherited from ilParticipantTableGUI
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

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceParticipantsTableGUI::__construct	(	ilLearningSequenceMembershipGUI	$parent_gui,
		ilObjLearningSequence	$ls_object,
		ilObjUserTracking	$obj_user_tracking,
		ilPrivacySettings	$privacy_settings,
		ilLanguage	$lng,
		ilAccess	$access,
		ilRbacReview	$rbac_review,
		ilSetting	$settings
	)

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

References $access, ilTableGUI\$lng, $ls_object, $obj_user_tracking, $parent_gui, $privacy_settings, $rbac_review, $settings, ILIAS\GlobalScreen\Provider\__construct(), ILIAS\Repository\access(), ilTable2GUI\getId(), ilObjLearningSequence\getLSParticipants(), ilParticipantTableGUI\getRepositoryObject(), initForm(), ilParticipantTableGUI\initSettings(), ILIAS\Repository\lng(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), and ILIAS\Repository\settings().

       {
         $this->parent_gui = $parent_gui;
         $this->rep_object = $ls_object;
 
         $this->obj_user_tracking = $obj_user_tracking;
         $this->privacy_settings = $privacy_settings;
         $this->lng = $lng;
         $this->access = $access;
         $this->rbac_review = $rbac_review;
         $this->settings = $settings;
 
         $this->lng->loadLanguageModule('lso');
         $this->lng->loadLanguageModule('trac');
         $this->lng->loadLanguageModule('rbac');
         $this->lng->loadLanguageModule('mmbr');
         $this->lng->loadLanguageModule('user');
         $this->lng->loadLanguageModule('ps');
 
         $this->participants = $ls_object->getLSParticipants();
 
         $this->setPrefix('participants');
 
         $this->setId('lso_' . $this->getRepositoryObject()->getId());
         parent::__construct($parent_gui, 'participants');
 
         $this->initSettings();
         $this->initForm();
     }

Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLearningSequenceParticipantsTableGUI::fillRow ( array $a_set )

protected

Definition at line 112 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilObjUserTracking\_enabledLearningProgress(), ilObjUser\_lookupActive(), ILIAS\Repository\access(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, getCompletedSteps(), getFirstAccess(), getLastAccess(), getLastVisitedStep(), ilParticipantTableGUI\getParticipants(), ilTable2GUI\getSelectedColumns(), ILIAS\Repository\lng(), and ilParticipantTableGUI\showActionLinks().

                                             : void
     {
         $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
         $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
         $this->tpl->setVariable('VAL_LOGIN', $a_set['login']);
 
         if (
             !$this->access->checkAccessOfUser((int) $a_set['usr_id'], 'read', '', $this->getRepositoryObject()->getRefId()) &&
             is_array($info = $this->access->getInfo())
         ) {
             $this->tpl->setCurrentBlock('access_warning');
             $this->tpl->setVariable('PARENT_ACCESS', $info[0]['text']);
             $this->tpl->parseCurrentBlock();
         }
 
         if (!ilObjUser::_lookupActive((int) $a_set['usr_id'])) {
             $this->tpl->setCurrentBlock('access_warning');
             $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
             $this->tpl->parseCurrentBlock();
         }
 
         foreach ($this->getSelectedColumns() as $field) {
             switch ($field) {
                 case 'prtf':
                     $tmp = array();
                     if (array_key_exists('prtf', $a_set) && is_array($a_set['prtf'])) {
                         foreach ($a_set['prtf'] as $prtf_url => $prtf_txt) {
                             $tmp[] = '<a href="' . $prtf_url . '">' . $prtf_txt . '</a>';
                         }
                     }
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', implode('<br />', $tmp));
                     $this->tpl->parseCurrentBlock();
                     break;
                 case 'roles':
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', (string) $a_set['roles_label']);
                     $this->tpl->parseCurrentBlock();
                     break;
                 case 'org_units':
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits((int) $a_set['usr_id']));
                     $this->tpl->parseCurrentBlock();
                     break;
                 default:
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
                     $this->tpl->parseCurrentBlock();
                     break;
             }
         }
 
         $this->tpl->setVariable('VAL_POSTNAME', 'participants');
 
         if (
             $this->obj_user_tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS) &&
             ilObjUserTracking::_enabledLearningProgress()
 
         ) {
             $this->tpl->setVariable('FIRST_ACCESS', $this->getFirstAccess((int) $a_set['usr_id']));
             $this->tpl->setVariable('LAST_ACCESS', $this->getLastAccess((int) $a_set['usr_id']));
         }
 
         $this->tpl->setVariable('COMPLETED_STEPS', $this->getCompletedSteps((int) $a_set['usr_id']));
         $this->tpl->setVariable('LAST_VISITED_STEP', $this->getLastVisitedStep((int) $a_set['usr_id']));
 
         if ($this->getParticipants()->isAdmin((int) $a_set['usr_id'])) {
             $this->tpl->setVariable('VAL_NOTIFICATION_ID', (int) $a_set['usr_id']);
             $this->tpl->setVariable(
                 'VAL_NOTIFICATION_CHECKED',
                 $a_set['notification'] ? 'checked="checked"' : ''
             );
         }
 
         $this->showActionLinks($a_set);
         $this->tpl->setVariable('VAL_LOGIN', $a_set['login']);
     }

Here is the call graph for this function:

◆ getCompletedSteps()

ilLearningSequenceParticipantsTableGUI::getCompletedSteps ( int $user_id )

protected

Definition at line 218 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilParticipantTableGUI\getRepositoryObject().

Referenced by fillRow().

                                                       : string
     {
         $passed = 0;
 
         $learner_items = $this->getRepositoryObject()->getLSLearnerItems(
             $user_id
         );
 
         $completion_states = $this->rep_object->getLPCompletionStates();
 
         foreach ($learner_items as $learner_item) {
             if (in_array($learner_item->getLearningProgressStatus(), $completion_states)) {
                 $passed++;
             }
         }
 
         return $passed . " / " . count($learner_items);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getExportFieldsInfo()

ilLearningSequenceParticipantsTableGUI::getExportFieldsInfo ( )

protected

Definition at line 414 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilExportFieldsInfo\_getInstanceByType(), and ilParticipantTableGUI\getRepositoryObject().

Referenced by getSelectableColumns().

                                             : ilExportFieldsInfo
     {
         return ilExportFieldsInfo::_getInstanceByType(
             $this->getRepositoryObject()->getType()
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFirstAccess()

ilLearningSequenceParticipantsTableGUI::getFirstAccess ( int $user_id )

protected

Definition at line 190 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilTableGUI\$data, and ilParticipantTableGUI\getRepositoryObject().

Referenced by fillRow().

                                                    : string
     {
         $data = $this->getRepositoryObject()->getStateDB()->getFirstAccessFor(
             $this->getRepositoryObject()->getRefId(),
             [$user_id]
         );
 
         if ($data[$user_id] === '-1') {
             return "-";
         }
 
         return $data[$user_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastAccess()

ilLearningSequenceParticipantsTableGUI::getLastAccess ( int $user_id )

protected

Definition at line 204 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilTableGUI\$data, and ilParticipantTableGUI\getRepositoryObject().

Referenced by fillRow().

                                                   : string
     {
         $data = $this->getRepositoryObject()->getStateDB()->getLastAccessFor(
             $this->getRepositoryObject()->getRefId(),
             [$user_id]
         );
 
         if ($data[$user_id] === '-1') {
             return "-";
         }
 
         return $data[$user_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastVisitedStep()

ilLearningSequenceParticipantsTableGUI::getLastVisitedStep ( int $user_id )

protected

Different to the concept we decide to use the title of the object instead of its actually number in the ls items list.

The ls item list could change and the number isn't very revealing.

Definition at line 242 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilTableGUI\$data, ilParticipantTableGUI\getRepositoryObject(), and getTitleFor().

Referenced by fillRow().

                                                        : string
     {
         $data = $this->getRepositoryObject()->getStateDB()->getCurrentItemsFor(
             $this->getRepositoryObject()->getRefId(),
             [$user_id]
         );
 
         if ($data[$user_id] === -1) {
             return "-";
         }
 
         return $this->getTitleFor((int) $data[$user_id]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSelectableColumns()

ilLearningSequenceParticipantsTableGUI::getSelectableColumns ( )

Definition at line 383 of file class.ilLearningSequenceParticipantsTableGUI.php.

References getExportFieldsInfo(), ilTable2GUI\getId(), ilParticipantTableGUI\getRepositoryObject(), ILIAS\Repository\lng(), and ILIAS\Repository\settings().

Referenced by initForm().

                                           : array
     {
         $ef = $this->getExportFieldsInfo();
         $columns = $ef->getSelectableFieldsInfo(
             $this->getRepositoryObject()->getId()
         );
 
         if ($this->settings->get('user_portfolios')) {
             $columns['prtf'] = array(
                 'txt' => $this->lng->txt('obj_prtf'),
                 'default' => false
             );
         }
 
         return array_merge(
             [
                 'roles' => [
                     'txt' => $this->lng->txt('objs_role'),
                     'default' => true
                 ]
             ],
             [
                 'org_units' => [
                     'txt' => $this->lng->txt("org_units"),
                     'default' => false
                 ]
             ],
             $columns
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleFor()

ilLearningSequenceParticipantsTableGUI::getTitleFor ( int $ref_id )

protected

Definition at line 256 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Referenced by getLastVisitedStep().

                                                : string
     {
         return ilObject::_lookupTitle(ilObject::_lookupObjId($ref_id));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initForm()

ilLearningSequenceParticipantsTableGUI::initForm ( )

protected

Definition at line 68 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilObjUserTracking\_enabledLearningProgress(), ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\enable(), ilObjUserTracking\EXTENDED_DATA_LAST_ACCESS, getSelectableColumns(), ilTable2GUI\getSelectedColumns(), ilParticipantTableGUI\initFilter(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormName(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowRowsSelector().

Referenced by __construct().

                                  : void
     {
         $this->setFormName('participants');
         $this->setDefaultOrderField('roles');
         $this->setRowTemplate("tpl.show_participants_row.html", "Modules/LearningSequence");
         $this->setShowRowsSelector(true);
         $this->setSelectAllCheckbox('participants');
 
         $this->addColumn('', 'f', "1");
         $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
         $this->addColumn($this->lng->txt('login'), 'login');
 
         $all_cols = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $col) {
             $this->addColumn($all_cols[$col]['txt'], $col);
         }
 
         if (
             $this->obj_user_tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS) &&
             ilObjUserTracking::_enabledLearningProgress()
 
         ) {
             $this->addColumn($this->lng->txt('first_access'), "first_access");
             $this->addColumn($this->lng->txt('last_access'), "last_access");
         }
         $this->addColumn($this->lng->txt('completed_steps'), "completed_steps");
         $this->addColumn($this->lng->txt('last_visited_step'), "last_visited_step");
         $this->addColumn($this->lng->txt('lso_notification'), 'notification');
         $this->addColumn($this->lng->txt(''), 'optional');
 
         $this->enable('sort');
         $this->enable('header');
         $this->enable('numinfo');
         $this->enable('select_all');
 
         $this->initFilter();
 
         $this->addMultiCommand('editParticipants', $this->lng->txt('edit'));
         $this->addMultiCommand('confirmDeleteParticipants', $this->lng->txt('remove'));
         $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
         $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
         $this->addCommandButton('updateParticipantsStatus', $this->lng->txt('save'));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilLearningSequenceParticipantsTableGUI::parse ( )

Definition at line 261 of file class.ilLearningSequenceParticipantsTableGUI.php.

References ilTableGUI\$data, ilTableGUI\$title, ILIAS\Repository\access(), ilParticipantTableGUI\checkAcceptance(), ilTable2GUI\determineOffsetAndOrder(), ilObjectFactory\getInstanceByRefId(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilParticipantTableGUI\getRepositoryObject(), ilTable2GUI\getSelectedColumns(), ilUserQuery\getUserListData(), ilUserDefinedData\lookupData(), ilTable2GUI\setData(), and ilArrayUtil\sortArray().

                            : void
     {
         $this->determineOffsetAndOrder(true);
 
         $ls_participants = $this->participants->getParticipants();
 
         $ls_participants = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
             'manage_members',
             'manage_members',
             $this->getRepositoryObject()->getRefId(),
             $ls_participants
         );
 
         if (!$ls_participants) {
             $this->setData(array());
             return;
         }
 
         $lso_user_data = $this->parent_gui->readMemberData(
             $ls_participants,
             $this->getSelectedColumns()
         );
 
         $additional_fields = $this->getSelectedColumns();
         unset($additional_fields['prtf']);
         unset($additional_fields['roles']);
         unset($additional_fields['org_units']);
 
         $udf_ids = $usr_data_fields = $odf_ids = array();
         foreach ($additional_fields as $field) {
             if (substr($field, 0, 3) == 'udf') {
                 $udf_ids[] = substr($field, 4);
                 continue;
             }
 
             if (substr($field, 0, 3) == 'odf') {
                 $odf_ids[] = substr($field, 4);
                 continue;
             }
 
             $usr_data_fields[] = $field;
         }
 
         $usr_data = ilUserQuery::getUserListData(
             $this->getOrderField(),
             $this->getOrderDirection(),
             0,
             9999,
             $this->current_filter['login'],
             '',
             null,
             false,
             false,
             0,
             0,
             null,
             $usr_data_fields,
             $ls_participants
         );
 
         $user_data = array();
         $filtered_user_ids = array();
         $local_roles = $this->parent_gui->getLocalRoles();
 
         foreach ($usr_data['set'] as $ud) {
             $user_id = $ud['usr_id'];
 
             if ($this->current_filter['roles']) {
                 if (!$this->rbac_review->isAssigned($user_id, $this->current_filter['roles'])) {
                     continue;
                 }
             }
 
             if (array_key_exists('org_units', $this->current_filter)
                 && $this->current_filter['org_units'] !== ''
             ) {
                 $org_unit = $this->current_filter['org_units'];
                 $title = ilObjectFactory::getInstanceByRefId($org_unit)->getTitle();
                 $user_units = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits((int) $user_id);
                 if (strpos($user_units, $title) === false) {
                     continue;
                 }
             }
 
             $filtered_user_ids[] = $user_id;
             $user_data[$user_id] = array_merge($ud, $lso_user_data[$user_id]);
 
             $roles = array();
             foreach ($local_roles as $role_id => $role_name) {
                 if ($this->rbac_review->isAssigned((int) $user_id, $role_id)) {
                     $roles[] = $role_name;
                 }
             }
 
             $user_data[$user_id]['name'] = $user_data[$user_id]['lastname'] . ', ' . $user_data[$user_id]['firstname'];
             $user_data[$user_id]['roles_label'] = implode('<br />', $roles);
             $user_data[$user_id]['roles'] = $this->participants->setRoleOrderPosition((int) $user_id);
         }
 
         // Custom user data fields
         if ($udf_ids !== []) {
             $data = ilUserDefinedData::lookupData($ls_participants, $udf_ids);
             foreach ($data as $usr_id => $fields) {
                 if (!$this->checkAcceptance((int) $usr_id)) {
                     continue;
                 }
 
                 foreach ($fields as $field_id => $value) {
                     $user_data[$usr_id]['udf_' . $field_id] = $value;
                 }
             }
         }
 
         $user_data = ilArrayUtil::sortArray(
             $user_data,
             'name',
             $this->getOrderDirection()
         );
 
         $this->setData($user_data);
     }

Here is the call graph for this function:

Referenced by __construct().

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

Modules/LearningSequence/classes/Members/class.ilLearningSequenceParticipantsTableGUI.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ fillRow()

◆ getCompletedSteps()

◆ getExportFieldsInfo()

◆ getFirstAccess()

◆ getLastAccess()

◆ getLastVisitedStep()

◆ getSelectableColumns()

◆ getTitleFor()

◆ initForm()

◆ parse()

Field Documentation

◆ $access

◆ $ls_object

◆ $obj_user_tracking

◆ $parent_gui

◆ $privacy_settings

◆ $rbac_review

◆ $settings