ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilLearningSequenceParticipantsTableGUI Class Reference
+ 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)
 
 fillRow ($set)
 Standard Version of Fill Row. More...
 
 parse ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
- Public Member Functions inherited from ilParticipantTableGUI
 initFilter ()
 Init table filter. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 checkAcceptance ($a_usr_id)
 Check acceptance. More...
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 ilTable2GUI constructor. More...
 
 setOpenFormTag ($a_val)
 Set open form tag. More...
 
 getOpenFormTag ()
 Get open form tag. More...
 
 setCloseFormTag ($a_val)
 Set close form tag. More...
 
 getCloseFormTag ()
 Get close form tag. More...
 
 determineLimit ()
 Determine the limit. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 Determine selected columns. More...
 
 isColumnSelected ($a_col)
 Is given column selected? More...
 
 getSelectedColumns ()
 Get selected columns. More...
 
 executeCommand ()
 Execute command. More...
 
 resetOffset ($a_in_determination=false)
 Reset offset. More...
 
 initFilter ()
 Init filter. More...
 
 getParentObject ()
 Get parent object. More...
 
 getParentCmd ()
 Get parent command. More...
 
 setTopAnchor ($a_val)
 Set top anchor. More...
 
 getTopAnchor ()
 Get top anchor. More...
 
 setNoEntriesText ($a_text)
 Set text for an empty table. More...
 
 getNoEntriesText ()
 Get text for an empty table. More...
 
 setIsDataTable ($a_val)
 Set is data table. More...
 
 getIsDataTable ()
 Get is data table. More...
 
 setEnableTitle ($a_enabletitle)
 Set Enable Title. More...
 
 getEnableTitle ()
 Get Enable Title. More...
 
 setEnableHeader ($a_enableheader)
 Set Enable Header. More...
 
 getEnableHeader ()
 Get Enable Header. More...
 
 setEnableNumInfo ($a_val)
 Set enable num info. More...
 
 getEnableNumInfo ()
 Get enable num info. More...
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 Set title and title icon. More...
 
 setDescription ($a_val)
 Set description. More...
 
 getDescription ()
 Get description. More...
 
 setOrderField ($a_order_field)
 set order column More...
 
 getOrderField ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 getPrefix ()
 
 addFilterItem ($a_input_item, $a_optional=false)
 Add filter item. More...
 
 addFilterItemByMetaType ($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
 Add filter by standard type. More...
 
 getFilterItems ($a_optionals=false)
 Get filter items. More...
 
 getFilterItemByPostVar ($a_post_var)
 
 setFilterCols ($a_val)
 Set filter columns. More...
 
 getFilterCols ()
 Get filter columns. More...
 
 setDisableFilterHiding ($a_val=true)
 Set disable filter hiding. More...
 
 getDisableFilterHiding ()
 Get disable filter hiding. More...
 
 isFilterSelected ($a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 Get selected filters. More...
 
 determineSelectedFilters ()
 Determine selected filters. More...
 
 setCustomPreviousNext ($a_prev_link, $a_next_link)
 Set custom previous/next links. More...
 
 setFormAction ($a_form_action, $a_multipart=false)
 Set Form action parameter. More...
 
 getFormAction ()
 Get Form action parameter. More...
 
 setFormName ($a_formname="")
 Set Form name. More...
 
 getFormName ()
 Get Form name. More...
 
 setId ($a_val)
 Set id. More...
 
 getId ()
 Get element id. More...
 
 setDisplayAsBlock ($a_val)
 Set display as block. More...
 
 getDisplayAsBlock ()
 Get display as block. More...
 
 getSelectAllCheckbox ()
 Get the name of the checkbox that should be toggled with a select all button. More...
 
 setSelectAllCheckbox ($a_select_all_checkbox, $a_select_all_on_top=false)
 Set the name of the checkbox that should be toggled with a select all button. More...
 
 setExternalSorting ($a_val)
 Set external sorting. More...
 
 getExternalSorting ()
 Get external sorting. More...
 
 setFilterCommand ($a_val, $a_caption=null)
 Set filter command. More...
 
 getFilterCommand ()
 Get filter command. More...
 
 setResetCommand ($a_val, $a_caption=null)
 Set reset filter command. More...
 
 getResetCommand ()
 Get reset filter command. More...
 
 setExternalSegmentation ($a_val)
 Set external segmentation. More...
 
 getExternalSegmentation ()
 Get external segmentation. More...
 
 setRowTemplate ($a_template, $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField ($a_defaultorderfield)
 Set Default order field. More...
 
 getDefaultOrderField ()
 Get Default order field. More...
 
 setDefaultOrderDirection ($a_defaultorderdirection)
 Set Default order direction. More...
 
 getDefaultOrderDirection ()
 Get Default order direction. More...
 
 setDefaultFilterVisiblity ($a_status)
 Set default filter visiblity. More...
 
 getDefaultFilterVisibility ()
 Get default filter visibility. More...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButtonBase $a_button)
 Add Command button instance. More...
 
 addSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button. More...
 
 addMultiItemSelectionButton ($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
 Add Selection List + Command button for selected items. More...
 
 setCloseCommand ($a_link)
 Add command for closing table. More...
 
 addMultiCommand ($a_cmd, $a_text)
 Add Command button. More...
 
 addHiddenInput ($a_name, $a_value)
 Add Hidden Input field. More...
 
 addHeaderCommand ($a_href, $a_text, $a_target="", $a_img="")
 Add Header Command (Link) (Image needed for now) More...
 
 setTopCommands ($a_val)
 Set top commands (display command buttons on top of table, too) More...
 
 getTopCommands ()
 Get top commands (display command buttons on top of table, too) More...
 
 addColumn ( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
 Add a column to the header. More...
 
 getNavParameter ()
 
 setOrderLink ($sort_field, $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder ($a_omit_offset=false)
 Determine offset and order. More...
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering ($a_field)
 Should this field be sorted numeric? More...
 
 render ()
 render table @access public More...
 
 writeFilterToSession ()
 Write filter values to session. More...
 
 resetFilter ()
 Reset filter. More...
 
 fillFooter ()
 Fill footer row. More...
 
 getLinkbar ($a_num)
 Get previous/next linkbar. More...
 
 fillHiddenRow ()
 
 fillActionRow ()
 Fill Action Row. More...
 
 setHeaderHTML ($html)
 set header html More...
 
 storeProperty ($type, $value)
 Store table property. More...
 
 loadProperty ($type)
 Load table property. More...
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext ($id)
 Set context. More...
 
 getContext ()
 Get context. More...
 
 setShowRowsSelector ($a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 Get rows-per-page selector state. More...
 
 setShowTemplates ($a_value)
 Toggle templates. More...
 
 getShowTemplates ()
 Get template state. More...
 
 restoreTemplate ($a_name)
 Restore state from template. More...
 
 saveTemplate ($a_name)
 Save current state as template. More...
 
 deleteTemplate ($a_name)
 Delete template. More...
 
 getLimit ()
 Get limit. More...
 
 getOffset ()
 Get offset. More...
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode ($a_value=false)
 Toogle print mode. More...
 
 getPrintMode ()
 Get print mode. More...
 
 getExportMode ()
 Was export activated? More...
 
 exportData ($format, $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand ($a_value)
 Enable actions for all entries in current result. More...
 
 setRowSelectorLabel ($row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission ($a_val)
 Set prevent double submission. More...
 
 getPreventDoubleSubmission ()
 Get prevent double submission. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template @access public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data @access public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title @access public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page @access public More...
 
 setHeaderNames ($a_header_names)
 set table header names @access public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns @access public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars @access public More...
 
 setColumnWidth ($a_column_width)
 set table column widths @access public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width @access public More...
 
 setMaxCount ($a_max_count)
 set max. More...
 
 setLimit ($a_limit=0, $a_default_limit=0)
 set max. More...
 
 getLimit ()
 Get limit. More...
 
 setPrefix ($a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) @access public More...
 
 setOffset ($a_offset)
 set dataset offset @access public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column @access public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction @access public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction @access public More...
 
 enable ($a_module_name)
 enables particular modules of table More...
 
 disable ($a_module_name)
 diesables particular modules of table More...
 
 sortData ()
 
 render ()
 render table @access public More...
 
 renderHeader ()
 
 setOrderLink ($key, $order_dir)
 
 setStyle ($a_element, $a_style)
 
 getStyle ($a_element)
 
 setBase ($a_base)
 Set Base script name (deprecated, only use this for workarounds). More...
 
 getBase ()
 Get Base script name (deprecated, only use this for workarounds). More...
 
 getFormName ()
 
 setFormName ($a_name="cmd")
 
 getSelectAllCheckbox ()
 
 setSelectAllCheckbox ($a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton ($btn_name, $btn_value)
 

Protected Member Functions

 initForm ()
 
 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 ()
 Get participants. More...
 
 initSettings ()
 Init acceptance. More...
 
 showActionLinks ($a_set)
 show edit links More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

 $show_learning_progress
 
 $current_filter = array()
 
- Protected Attributes inherited from ilParticipantTableGUI
 $participants = null
 
 $current_filter = array()
 
 $rep_object
 
- Protected Attributes inherited from ilTable2GUI
 $ctrl
 
 $tpl
 
 $parent_obj
 
 $parent_cmd
 
 $close_command = ""
 
 $top_anchor = "il_table_top"
 
 $filters = array()
 
 $optional_filters = array()
 
 $filter_cmd = 'applyFilter'
 
 $reset_cmd = 'resetFilter'
 
 $filter_cols = 5
 
 $ext_sort = false
 
 $ext_seg = false
 
 $context = ""
 
 $mi_sel_buttons = []
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $rows_selector_off = false
 
 $nav_determined = false
 
 $limit_determined = false
 
 $filters_determined = false
 
 $columns_determined = false
 
 $open_form_tag = true
 
 $close_form_tag = true
 
 $export_formats = []
 
 $export_mode
 
 $print_mode
 
 $enable_command_for_all
 
 $restore_filter
 
 $restore_filter_values
 
 $default_filter_visibility = false
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 
 $select_all_on_top = false
 
 $sel_buttons = []
 
- Protected Attributes inherited from ilTableGUI
 $tpl
 
 $lng
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- 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
 $title
 
 $icon
 
 $icon_alt
 
 $help_page
 
 $help_icon
 
 $help_icon_alt
 
 $header_names
 
 $header_vars
 
 $linkbar_vars
 
 $data
 
 $column_count
 
 $column_width
 
 $max_count
 
 $limit
 
 $max_limit = false
 
 $offset
 
 $order_column
 
 $order_direction
 
 $footer_style
 
 $footer_previous
 
 $footer_next
 
 $lang_support = true
 
 $global_tpl
 
 $form_name
 
 $select_all_checkbox
 
 $action_buttons
 
 $prefix
 
 $base = ""
 
 $enabled
 
 $styles
 
- Static Protected Attributes inherited from ilParticipantTableGUI
static $export_allowed = false
 
static $confirmation_required = true
 
static $accepted_ids = null
 
static $all_columns = null
 
static $has_odf_definitions = false
 

Detailed Description

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 20 of file class.ilLearningSequenceParticipantsTableGUI.php.

29 {
30 $this->parent_gui = $parent_gui;
31 $this->rep_object = $ls_object;
32 $this->show_learning_progress = $show_learning_progress;
33
34 $this->obj_user_tracking = $obj_user_tracking;
35 $this->privacy_settings = $privacy_settings;
36 $this->lng = $lng;
37 $this->access = $access;
38 $this->rbac_review = $rbac_review;
39 $this->settings = $settings;
40
41 $this->lng->loadLanguageModule('lso');
42 $this->lng->loadLanguageModule('trac');
43 $this->lng->loadLanguageModule('rbac');
44 $this->lng->loadLanguageModule('mmbr');
45 $this->lng->loadLanguageModule('user');
46 $this->lng->loadLanguageModule('ps');
47
48 $this->participants = $ls_object->getLSParticipants();
49
50 $this->setPrefix('participants');
51
52 $this->setId('lso_' . $this->getRepositoryObject()->getId());
53 parent::__construct($parent_gui, 'participants');
54
55 $this->initSettings();
56 $this->initForm();
57 }
setPrefix($a_prefix)
set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort...
getId()
Get element id.
setId($a_val)
Set id.
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
settings()
Definition: settings.php:2

References ilTableGUI\$lng, $show_learning_progress, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\getId(), ilObjLearningSequence\getLSParticipants(), ilParticipantTableGUI\getRepositoryObject(), initForm(), ilParticipantTableGUI\initSettings(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), and settings().

+ Here is the call graph for this function:

Member Function Documentation

◆ fillRow()

ilLearningSequenceParticipantsTableGUI::fillRow (   $a_set)

Standard Version of Fill Row.

Most likely to be overwritten by derived class.

Parameters
array$a_setdata array

Reimplemented from ilTable2GUI.

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

104 {
105 $this->tpl->setVariable('VAL_ID', $set['usr_id']);
106 $this->tpl->setVariable('VAL_NAME', $set['lastname'] . ', ' . $set['firstname']);
107 $this->tpl->setVariable('VAL_LOGIN', $set['login']);
108
109 if (
110 !$this->access->checkAccessOfUser($set['usr_id'], 'read', '', $this->getRepositoryObject()->getRefId()) &&
111 is_array($info = $this->access->getInfo())
112 ) {
113 $this->tpl->setCurrentBlock('access_warning');
114 $this->tpl->setVariable('PARENT_ACCESS', $info[0]['text']);
115 $this->tpl->parseCurrentBlock();
116 }
117
118 if (!ilObjUser::_lookupActive($set['usr_id'])) {
119 $this->tpl->setCurrentBlock('access_warning');
120 $this->tpl->setVariable('PARENT_ACCESS', $this->lng->txt('usr_account_inactive'));
121 $this->tpl->parseCurrentBlock();
122 }
123
124 foreach ($this->getSelectedColumns() as $field) {
125 switch ($field) {
126 case 'prtf':
127 $tmp = array();
128 if (is_array($set['prtf'])) {
129 foreach ($set['prtf'] as $prtf_url => $prtf_txt) {
130 $tmp[] = '<a href="' . $prtf_url . '">' . $prtf_txt . '</a>';
131 }
132 }
133 $this->tpl->setCurrentBlock('custom_fields');
134 $this->tpl->setVariable('VAL_CUST', (string) implode('<br />', $tmp));
135 $this->tpl->parseCurrentBlock();
136 break;
137 case 'roles':
138 $this->tpl->setCurrentBlock('custom_fields');
139 $this->tpl->setVariable('VAL_CUST', (string) $set['roles_label']);
140 $this->tpl->parseCurrentBlock();
141 break;
142 case 'org_units':
143 $this->tpl->setCurrentBlock('custom_fields');
144 $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($set['usr_id']));
145 $this->tpl->parseCurrentBlock();
146 break;
147 default:
148 $this->tpl->setCurrentBlock('custom_fields');
149 $this->tpl->setVariable('VAL_CUST', isset($set[$field]) ? (string) $set[$field] : '');
150 $this->tpl->parseCurrentBlock();
151 break;
152 }
153 }
154
155 $this->tpl->setVariable('VAL_POSTNAME', 'participants');
156
157 if (
158 $this->obj_user_tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS) &&
160
161 ) {
162 $this->tpl->setVariable('FIRST_ACCESS', $this->getFirstAccess((int) $set['usr_id']));
163 $this->tpl->setVariable('LAST_ACCESS', $this->getLastAccess((int) $set['usr_id']));
164 }
165
166 $this->tpl->setVariable('COMPLETED_STEPS', $this->getCompletedSteps((int) $set['usr_id']));
167 $this->tpl->setVariable('LAST_VISITED_STEP', $this->getLastVisitedStep((int) $set['usr_id']));
168
169 if ($this->getParticipants()->isAdmin($set['usr_id'])) {
170 $this->tpl->setVariable('VAL_NOTIFICATION_ID', $set['usr_id']);
171 $this->tpl->setVariable(
172 'VAL_NOTIFICATION_CHECKED',
173 $set['notification'] ? 'checked="checked"' : ''
174 );
175 }
176
177 $this->showActionLinks($set);
178 $this->tpl->setVariable('VAL_LOGIN', $set['login']);
179 }
getLastVisitedStep(int $user_id)
Different to the concept we decide to use the title of the object instead of its actually number in t...
static _enabledLearningProgress()
check wether learing progress is enabled or not
static _lookupActive($a_usr_id)
Check user account active.
showActionLinks($a_set)
show edit links
getSelectedColumns()
Get selected columns.

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

+ Here is the call graph for this function:

◆ getCompletedSteps()

ilLearningSequenceParticipantsTableGUI::getCompletedSteps ( int  $user_id)
protected

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

210 {
211 $passed = 0;
212 $learner_items = array();
213
214 $learner_items = $this->getRepositoryObject()->getLSLearnerItems(
215 $user_id
216 );
217
218 $completion_states = $this->rep_object->getLPCompletionStates();
219
220 foreach ($learner_items as $learner_item) {
221 if (in_array($learner_item->getLearningProgressStatus(), $completion_states)) {
222 $passed++;
223 }
224 }
225
226 return $passed . " / " . count($learner_items);
227 }

References ilParticipantTableGUI\getRepositoryObject().

Referenced by fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getExportFieldsInfo()

ilLearningSequenceParticipantsTableGUI::getExportFieldsInfo ( )
protected

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

408 {
410 $this->getRepositoryObject()->getType()
411 );
412 }
static _getInstanceByType($a_type)
Get Singleton Instance.

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

Referenced by getSelectableColumns().

+ 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 181 of file class.ilLearningSequenceParticipantsTableGUI.php.

182 {
183 $data = $this->getRepositoryObject()->getStateDB()->getFirstAccessFor(
184 (int) $this->getRepositoryObject()->getRefId(),
185 array($user_id)
186 );
187
188 if ($data[$user_id] === -1) {
189 return "-";
190 }
191
192 return $data[$user_id];
193 }

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

Referenced by fillRow().

+ 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 195 of file class.ilLearningSequenceParticipantsTableGUI.php.

196 {
197 $data = $this->getRepositoryObject()->getStateDB()->getLastAccessFor(
198 (int) $this->getRepositoryObject()->getRefId(),
199 array($user_id)
200 );
201
202 if ($data[$user_id] === -1) {
203 return "-";
204 }
205
206 return $data[$user_id];
207 }

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

Referenced by fillRow().

+ 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 234 of file class.ilLearningSequenceParticipantsTableGUI.php.

235 {
236 $data = $this->getRepositoryObject()->getStateDB()->getCurrentItemsFor(
237 (int) $this->getRepositoryObject()->getRefId(),
238 array($user_id)
239 );
240
241 if ($data[$user_id] === -1) {
242 return "-";
243 }
244
245 return $this->getTitleFor((int) $data[$user_id]);
246 }

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

Referenced by fillRow().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilLearningSequenceParticipantsTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

Reimplemented from ilParticipantTableGUI.

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

374 {
375 $ef = $this->getExportFieldsInfo();
376 $columns = array();
377 $columns = $ef->getSelectableFieldsInfo(
378 $this->getRepositoryObject()->getId()
379 );
380
381 if ($this->settings->get('user_portfolios')) {
382 $columns['prtf'] = array(
383 'txt' => $this->lng->txt('obj_prtf'),
384 'default' => false
385 );
386 }
387
388 $columns = array_merge(
389 array(
390 'roles' => array(
391 'txt' => $this->lng->txt('objs_role'),
392 'default' => true
393 )
394 ),
395 array(
396 'org_units' => array(
397 'txt' => $this->lng->txt("org_units"),
398 'default' => false
399 )
400 ),
402 );
403
404 return $columns;
405 }
if(! $in) $columns
Definition: Utf8Test.php:45

References $columns, getExportFieldsInfo(), ilTable2GUI\getId(), ilParticipantTableGUI\getRepositoryObject(), and settings().

Referenced by initForm().

+ 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 248 of file class.ilLearningSequenceParticipantsTableGUI.php.

248 : string
249 {
251 }
static _lookupObjId($a_id)
static _lookupTitle($a_id)
lookup object title

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

Referenced by getLastVisitedStep().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initForm()

ilLearningSequenceParticipantsTableGUI::initForm ( )
protected

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

60 {
61 $this->setFormName('participants');
62 $this->setDefaultOrderField('roles');
63 $this->setRowTemplate("tpl.show_participants_row.html", "Modules/LearningSequence");
64 $this->setShowRowsSelector(true);
65 $this->setSelectAllCheckbox('participants');
66
67 $this->addColumn('', 'f', "1");
68 $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
69 $this->addColumn($this->lng->txt('login'), 'login');
70
71 $all_cols = $this->getSelectableColumns();
72 foreach ($this->getSelectedColumns() as $col) {
73 $this->addColumn($all_cols[$col]['txt'], $col);
74 }
75
76 if (
77 $this->obj_user_tracking->hasExtendedData(ilObjUserTracking::EXTENDED_DATA_LAST_ACCESS) &&
79
80 ) {
81 $this->addColumn($this->lng->txt('first_access'), "first_access");
82 $this->addColumn($this->lng->txt('last_access'), "last_access");
83 }
84 $this->addColumn($this->lng->txt('completed_steps'), "completed_steps");
85 $this->addColumn($this->lng->txt('last_visited_step'), "last_visited_step");
86 $this->addColumn($this->lng->txt('lso_notification'), 'notification');
87 $this->addColumn($this->lng->txt(''), 'optional');
88
89 $this->enable('sort');
90 $this->enable('header');
91 $this->enable('numinfo');
92 $this->enable('select_all');
93
94 $this->initFilter();
95
96 $this->addMultiCommand('editParticipants', $this->lng->txt('edit'));
97 $this->addMultiCommand('confirmDeleteParticipants', $this->lng->txt('remove'));
98 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
99 $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
100 $this->addCommandButton('updateParticipantsStatus', $this->lng->txt('save'));
101 }
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setSelectAllCheckbox($a_select_all_checkbox, $a_select_all_on_top=false)
Set the name of the checkbox that should be toggled with a select all button.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
addColumn( $a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="", $a_tooltip_with_html=false)
Add a column to the header.
setFormName($a_formname="")
Set Form name.
addCommandButton($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
Add Command button.
enable($a_module_name)
enables particular modules of table

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

Referenced by __construct().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parse()

ilLearningSequenceParticipantsTableGUI::parse ( )

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

254 {
255 $this->determineOffsetAndOrder(true);
256
257 $ls_participants = $this->participants->getParticipants();
258
259 $ls_participants = $this->access->filterUserIdsByRbacOrPositionOfCurrentUser(
260 'manage_members',
261 'manage_members',
262 $this->getRepositoryObject()->getRefId(),
263 $ls_participants
264 );
265
266 if (!$ls_participants) {
267 $this->setData(array());
268 return;
269 }
270
271 $lso_user_data = $this->parent_gui->readMemberData(
272 $ls_participants,
273 $this->getSelectedColumns()
274 );
275
276 $additional_fields = $this->getSelectedColumns();
277 unset($additional_fields['prtf']);
278 unset($additional_fields['roles']);
279 unset($additional_fields['org_units']);
280
281 $udf_ids = $usr_data_fields = $odf_ids = array();
282 foreach ($additional_fields as $field) {
283 if (substr($field, 0, 3) == 'udf') {
284 $udf_ids[] = substr($field, 4);
285 continue;
286 }
287
288 if (substr($field, 0, 3) == 'odf') {
289 $odf_ids[] = substr($field, 4);
290 continue;
291 }
292
293 $usr_data_fields[] = $field;
294 }
295
297 $this->getOrderField(),
298 $this->getOrderDirection(),
299 0,
300 9999,
301 $this->current_filter['login'],
302 '',
303 null,
304 false,
305 false,
306 0,
307 0,
308 null,
309 $usr_data_fields,
310 $ls_participants
311 );
312
313 $user_data = array();
314 $filtered_user_ids = array();
315 $local_roles = $this->parent_gui->getLocalRoles();
316
317 foreach ($usr_data['set'] as $ud) {
318 $user_id = $ud['usr_id'];
319
320 if ($this->current_filter['roles']) {
321 if (!$this->rbac_review->isAssigned($user_id, $this->current_filter['roles'])) {
322 continue;
323 }
324 }
325
326 if ($this->current_filter['org_units']) {
327 $org_unit = $this->current_filter['org_units'];
328 $title = ilObjectFactory::getInstanceByRefId($org_unit)->getTitle();
329 $user_units = (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($user_id);
330 if (strpos($user_units, $title) === false) {
331 continue;
332 }
333 }
334
335 $filtered_user_ids[] = $user_id;
336 $user_data[$user_id] = array_merge($ud, (array) $lso_user_data[$user_id]);
337
338 $roles = array();
339 foreach ($local_roles as $role_id => $role_name) {
340 if ($this->rbac_review->isAssigned($user_id, $role_id)) {
341 $roles[] = $role_name;
342 }
343 }
344
345 $user_data[$user_id]['name'] = $user_data[$user_id]['lastname'] . ', ' . $user_data[$user_id]['firstname'];
346 $user_data[$user_id]['roles_label'] = implode('<br />', $roles);
347 $user_data[$user_id]['roles'] = $this->participants->setRoleOrderPosition($user_id);
348 }
349
350 // Custom user data fields
351 if ($udf_ids) {
352 $data = ilUserDefinedData::lookupData($ls_participants, $udf_ids);
353 foreach ($data as $usr_id => $fields) {
354 if (!$this->checkAcceptance($usr_id)) {
355 continue;
356 }
357
358 foreach ($fields as $field_id => $value) {
359 $user_data[$usr_id]['udf_' . $field_id] = $value;
360 }
361 }
362 }
363
364 $user_data = ilUtil::sortArray(
365 $user_data,
366 'name',
367 $this->getOrderDirection()
368 );
369
370 return $this->setData($user_data);
371 }
static getInstanceByRefId($a_ref_id, $stop_on_error=true)
get an instance of an Ilias object by reference id
checkAcceptance($a_usr_id)
Check acceptance.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
setData($a_data)
set table data @access public
getOrderDirection()
Get order direction.
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
static getUserListData( $a_order_field, $a_order_dir, $a_offset, $a_limit, $a_string_filter="", $a_activation_filter="", $a_last_login_filter=null, $a_limited_access_filter=false, $a_no_courses_filter=false, $a_course_group_filter=0, $a_role_filter=0, $a_user_folder_filter=null, $a_additional_fields='', $a_user_filter=null, $a_first_letter="", $a_authentication_filter=null)
Get data for user administration list.
static sortArray( $array, $a_array_sortby, $a_array_sortorder=0, $a_numeric=false, $a_keep_keys=false)
sortArray

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

+ Here is the call graph for this function:

Field Documentation

◆ $current_filter

ilLearningSequenceParticipantsTableGUI::$current_filter = array()
protected

◆ $show_learning_progress

ilLearningSequenceParticipantsTableGUI::$show_learning_progress
protected

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

Referenced by __construct().


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