ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilSessionParticipantsTableGUI Class Reference

Description of class class. More...

+ Inheritance diagram for ilSessionParticipantsTableGUI:
+ Collaboration diagram for ilSessionParticipantsTableGUI:

Public Member Functions

 __construct ($a_parent_gui, ilObjSession $a_parent_obj, $a_parent_cmd)
 
 init ()
 Init table. More...
 
 initFilter ()
 Init filter. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 parse ()
 parse table More...
 
 fillRow ($a_set)
 fill row 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

 getRepositoryObject ()
 
 isRegistrationEnabled ()
 Check if registration is enabled. More...
 
 getParticipants ()
 Get participants. More...
 
 collectParticipants ()
 Collect participants. More...
 
 matchesFilterCriteria ($a_user_info)
 Check if user is filtered. More...
 
 getParentLocalRoles ()
 Get local roles of parent object. 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...
 

Static Protected Attributes

static $all_columns = null
 

Private Attributes

 $rep_object = null
 
 $parent_ref_id = 0
 
 $member_ref_id = 0
 
 $logger = null
 
 $participants = null
 

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

Detailed Description

Description of class class.

Author
Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

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

Constructor & Destructor Documentation

◆ __construct()

ilSessionParticipantsTableGUI::__construct (   $a_parent_gui,
ilObjSession  $a_parent_obj,
  $a_parent_cmd 
)
Parameters
object$a_parent_gui
ilObjSession$a_parent_obj
string$a_parent_cmd
Exceptions

InvalidArgumentException

Definition at line 55 of file class.ilSessionParticipantsTableGUI.php.

56 {
57 $this->logger = $GLOBALS['DIC']->logger()->sess();
58
59 $this->rep_object = $a_parent_obj;
60
61 include_once './Services/Membership/classes/class.ilParticipants.php';
62 $this->participants = ilParticipants::getInstance($this->getRepositoryObject()->getRefId());
63
64 $this->setId('session_part_' . $this->getRepositoryObject()->getId());
65 parent::__construct($a_parent_gui, $a_parent_cmd);
66
67 $this->parent_ref_id = $GLOBALS['DIC']->repositoryTree()->getParentId(
68 $this->getRepositoryObject()->getRefId()
69 );
70
71 $tree = $GLOBALS['DIC']->repositoryTree();
72 if ($member_ref = $tree->checkForParentType($this->parent_ref_id, 'grp')) {
73 $this->member_ref_id = $member_ref;
74 } elseif ($member_ref = $tree->checkForParentType($this->parent_ref_id, 'crs')) {
75 $this->member_ref_id = $member_ref;
76 } else {
77 throw new \InvalidArgumentException("Error in tree structure. Session has no parent course/group ref_id: " . $this->getRepositoryObject()->getRefId());
78 }
79 }
static getInstance($a_ref_id)
Get instance by ref_id.
getId()
Get element id.
setId($a_val)
Set id.
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.

References $GLOBALS, $tree, ilTable2GUI\getId(), ilParticipants\getInstance(), getRepositoryObject(), and ilTable2GUI\setId().

+ Here is the call graph for this function:

Member Function Documentation

◆ collectParticipants()

ilSessionParticipantsTableGUI::collectParticipants ( )
protected

Collect participants.

Returns
int[] array of parent course/group participants

Definition at line 290 of file class.ilSessionParticipantsTableGUI.php.

291 {
292 $part = ilParticipants::getInstance($this->member_ref_id);
293 if (!$part instanceof ilParticipants) {
294 return $this->getParticipants()->getParticipants();
295 }
296 return $part->getParticipants();
297 }

References ilParticipants\getInstance(), and getParticipants().

Referenced by parse().

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

◆ fillRow()

ilSessionParticipantsTableGUI::fillRow (   $a_set)

fill row

@access public

Parameters
arraydata set

Reimplemented from ilTable2GUI.

Definition at line 343 of file class.ilSessionParticipantsTableGUI.php.

344 {
345 $this->tpl->setVariable('VAL_POSTNAME', 'participants');
346
347 if ($this->isRegistrationEnabled()) {
348 $this->tpl->setCurrentBlock('registered_col');
349 $this->tpl->setVariable('VAL_ID', $a_set['id']);
350 $this->tpl->setVariable('REG_CHECKED', $a_set['registered'] ? 'checked="checked"' : '');
351 $this->tpl->parseCurrentBlock();
352 }
353
354 foreach ($this->getSelectedColumns() as $field) {
355 switch ($field) {
356 case 'roles':
357 $this->tpl->setCurrentBlock('custom_fields');
358 $this->tpl->setVariable('VAL_CUST', (string) $a_set['roles']);
359 $this->tpl->parseCurrentBlock();
360 break;
361
362 }
363 }
364 $this->tpl->setVariable('VAL_ID', $a_set['id']);
365 $this->tpl->setVariable('LASTNAME', $a_set['lastname']);
366 $this->tpl->setVariable('FIRSTNAME', $a_set['firstname']);
367 $this->tpl->setVariable('LOGIN', $a_set['login']);
368 $this->tpl->setVariable('MARK', $a_set['mark']);
369 $this->tpl->setVariable('COMMENT', $a_set['comment']);
370 $this->tpl->setVariable('PART_CHECKED', $a_set['participated'] ? 'checked="checked"' : '');
371 $this->tpl->setVariable('CONTACT_CHECKED', $a_set['contact'] ? 'checked="checked"' : '');
372 }
isRegistrationEnabled()
Check if registration is enabled.
getSelectedColumns()
Get selected columns.

References ilTable2GUI\getSelectedColumns(), and isRegistrationEnabled().

+ Here is the call graph for this function:

◆ getParentLocalRoles()

ilSessionParticipantsTableGUI::getParentLocalRoles ( )
protected

Get local roles of parent object.

Definition at line 377 of file class.ilSessionParticipantsTableGUI.php.

378 {
379 $part = null;
380 $type = ilObject::_lookupType($this->member_ref_id, true);
381 switch ($type) {
382 case 'crs':
383 case 'grp':
384 $part = ilParticipants::getInstance($this->member_ref_id);
385 // no break
386 default:
387
388 }
389 if (!$part instanceof ilParticipants) {
390 return [];
391 }
392
393 $review = $GLOBALS['DIC']->rbac()->review();
394
395 $local_parent_roles = $review->getLocalRoles($this->member_ref_id);
396 $this->logger->dump($local_parent_roles);
397
398 $local_roles_info = [];
399 foreach ($local_parent_roles as $index => $role_id) {
400 $local_roles_info[$role_id] = ilObjRole::_getTranslation(
401 ilObject::_lookupTitle($role_id)
402 );
403 }
404 return $local_roles_info;
405 }
static _getTranslation($a_role_title)
static _lookupTitle($a_id)
lookup object title
static _lookupType($a_id, $a_reference=false)
lookup object type
$index
Definition: metadata.php:60
$type

References $GLOBALS, $index, $type, ilObjRole\_getTranslation(), ilObject\_lookupTitle(), ilObject\_lookupType(), and ilParticipants\getInstance().

Referenced by initFilter(), and parse().

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

◆ getParticipants()

ilSessionParticipantsTableGUI::getParticipants ( )
protected

Get participants.

Returns
ilSessionParticipants

Definition at line 104 of file class.ilSessionParticipantsTableGUI.php.

References $participants.

Referenced by collectParticipants(), and parse().

+ Here is the caller graph for this function:

◆ getRepositoryObject()

ilSessionParticipantsTableGUI::getRepositoryObject ( )
protected
Returns
ilObjSession

Definition at line 85 of file class.ilSessionParticipantsTableGUI.php.

References $rep_object.

Referenced by __construct(), initFilter(), and isRegistrationEnabled().

+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilSessionParticipantsTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

Reimplemented from ilTable2GUI.

Definition at line 216 of file class.ilSessionParticipantsTableGUI.php.

217 {
218 global $DIC;
219
220 $ilSetting = $DIC['ilSetting'];
221
222
223 self::$all_columns['roles'] = array(
224 'txt' => $this->lng->txt('objs_role'),
225 'default' => true
226 );
227
228 return self::$all_columns;
229 }
global $ilSetting
Definition: privfeed.php:17
global $DIC
Definition: saml.php:7

References $all_columns, $DIC, and $ilSetting.

Referenced by init().

+ Here is the caller graph for this function:

◆ init()

ilSessionParticipantsTableGUI::init ( )

Init table.

Definition at line 113 of file class.ilSessionParticipantsTableGUI.php.

114 {
115 $this->lng->loadLanguageModule('sess');
116 $this->lng->loadLanguageModule('crs');
117 $this->lng->loadLanguageModule('trac');
118 $this->lng->loadLanguageModule('mmbr');
119
120 $this->setFormName('participants');
121
122 $this->initFilter();
123
124
125 $this->setSelectAllCheckbox('participants', true);
126 $this->setShowRowsSelector(true);
127
128 $this->enable('sort');
129 $this->enable('header');
130 $this->enable('numinfo');
131 $this->enable('select_all');
132
133
134 $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), $this->getParentCmd()));
135
136 $this->setRowTemplate("tpl.sess_members_row.html", "Modules/Session");
137
138 $this->addColumn('', 'f', '1', true);
139 $this->addColumn($this->lng->txt('name'), 'name', '20%');
140 $this->addColumn($this->lng->txt('login'), 'login', '10%');
141
142 $all_cols = $this->getSelectableColumns();
143 foreach ($this->getSelectedColumns() as $col) {
144 $this->addColumn($all_cols[$col]['txt'], $col);
145 }
146
147
148 if ($this->isRegistrationEnabled()) {
149 $this->addColumn($this->lng->txt('event_tbl_registered'), 'registered');
150 $this->setDefaultOrderField('registered');
151 $this->setDefaultOrderDirection('desc');
152 } else {
153 $this->setDefaultOrderField('name');
154 }
155 $this->addColumn($this->lng->txt('event_tbl_participated'), 'participated');
156 $this->addColumn($this->lng->txt('sess_contact'), 'contact');
157 $this->addColumn($this->lng->txt('trac_mark'), 'mark');
158 $this->addColumn($this->lng->txt('trac_comment'), 'comment');
159
160
161 $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
162 $this->lng->loadLanguageModule('user');
163 $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
164
165
166 $this->addCommandButton('updateMembers', $this->lng->txt('save'));
167 }
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.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
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 ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ilTableGUI\enable(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), isRegistrationEnabled(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowRowsSelector().

+ Here is the call graph for this function:

◆ initFilter()

ilSessionParticipantsTableGUI::initFilter ( )

Init filter.

Overwrite this to initialize all filter input property objects.

Reimplemented from ilTable2GUI.

Definition at line 169 of file class.ilSessionParticipantsTableGUI.php.

170 {
172 'login',
174 false,
175 $this->lng->txt('name')
176 );
177 $this->current_filter['login'] = $login->getValue();
178
179
180 if ($this->isColumnSelected('roles')) {
181 $role = $this->addFilterItemByMetaType(
182 'roles',
184 false,
185 $this->lng->txt('objs_' . ilObject::_lookupType(ilObject::_lookupObjId($this->member_ref_id)) . '_role')
186 );
187
188 $options = array();
189 $options[0] = $this->lng->txt('all_roles');
190 $role->setOptions($options + $this->getParentLocalRoles());
191 $this->current_filter['roles'] = $role->getValue();
192 }
193
194 if ($this->getRepositoryObject()->enabledRegistration()) {
195 $reg = $this->addFilterItemByMetaType(
196 'filter_registration',
198 false,
199 $this->lng->txt('sess_part_filter_registered')
200 );
201 $this->current_filter['filter_registration'] = (bool) $reg->getChecked();
202 }
203 $participated = $this->addFilterItemByMetaType(
204 'filter_participated',
206 false,
207 $this->lng->txt('sess_part_filter_participated')
208 );
209 $this->current_filter['filter_participated'] = (bool) $participated->getChecked();
210 }
static _lookupObjId($a_id)
getParentLocalRoles()
Get local roles of parent object.
addFilterItemByMetaType($id, $type=self::FILTER_TEXT, $a_optional=false, $caption=null)
Add filter by standard type.
isColumnSelected($a_col)
Is given column selected?
$login
Definition: cron.php:13

References $login, PHPMailer\PHPMailer\$options, ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_CHECKBOX, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, getParentLocalRoles(), getRepositoryObject(), and ilTable2GUI\isColumnSelected().

Referenced by init().

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

◆ isRegistrationEnabled()

ilSessionParticipantsTableGUI::isRegistrationEnabled ( )
protected

Check if registration is enabled.

Returns
bool

Definition at line 94 of file class.ilSessionParticipantsTableGUI.php.

95 {
96 return $this->getRepositoryObject()->enabledRegistration();
97 }

References getRepositoryObject().

Referenced by fillRow(), and init().

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

◆ matchesFilterCriteria()

ilSessionParticipantsTableGUI::matchesFilterCriteria (   $a_user_info)
protected

Check if user is filtered.

Parameters
type$a_user_info

Definition at line 304 of file class.ilSessionParticipantsTableGUI.php.

305 {
306 foreach ($this->current_filter as $filter => $filter_value) {
307 if (!$filter_value) {
308 continue;
309 }
310 switch ($filter) {
311 case 'roles':
312 if (!in_array($filter_value, $a_user_info['role_ids'])) {
313 return false;
314 }
315 break;
316
317 case 'filter_participated':
318 if (!$a_user_info['participated']) {
319 return false;
320 }
321 break;
322
323 case 'filter_registration':
324 if (!$a_user_info['registered']) {
325 return false;
326 }
327 break;
328 }
329
330
331 $this->logger->info('Filter: ' . $filter . ' -> ' . $filter_value);
332 }
333 return true;
334 }

Referenced by parse().

+ Here is the caller graph for this function:

◆ parse()

ilSessionParticipantsTableGUI::parse ( )

parse table

@access public

Returns

Definition at line 238 of file class.ilSessionParticipantsTableGUI.php.

239 {
240 $all_participants = [];
241 $all_possible_participants = $this->collectParticipants();
242 if ($all_possible_participants) {
243 // user filter
244 $user_query = new ilUserQuery();
245 $user_query->setLimit(50000);
246 $user_query->setUserFilter($all_possible_participants);
247 $user_query->setTextFilter((string) $this->current_filter['login']);
248 $res = $user_query->query();
249 $all_participants = $res['set'];
250 }
251
252 foreach ($all_participants as $counter => $participant) {
253 $usr_data = $this->getParticipants()->getEventParticipants()->getUser($participant['usr_id']);
254
255 $tmp_data = [];
256 $tmp_data['id'] = $participant['usr_id'];
257
258 $tmp_data['name'] = $participant['lastname'];
259 $tmp_data['lastname'] = $participant['lastname'];
260 $tmp_data['firstname'] = $participant['firstname'];
261 $tmp_data['login'] = $participant['login'];
262 $tmp_data['mark'] = $usr_data['mark'];
263 $tmp_data['comment'] = $usr_data['comment'];
264 $tmp_data['participated'] = $this->getParticipants()->getEventParticipants()->hasParticipated($participant['usr_id']);
265 $tmp_data['registered'] = $this->getParticipants()->getEventParticipants()->isRegistered($participant['usr_id']);
266 $tmp_data['contact'] = $this->getParticipants()->isContact($participant['usr_id']);
267
268 $roles = array();
269 $local_roles = $this->getParentLocalRoles();
270 foreach ($local_roles as $role_id => $role_name) {
271 // @todo fix performance
272 if ($GLOBALS['DIC']['rbacreview']->isAssigned($participant['usr_id'], $role_id)) {
273 $tmp_data['role_ids'][] = $role_id;
274 $roles[] = $role_name;
275 }
276 }
277 $tmp_data['roles'] = implode('<br />', $roles);
278
279 if ($this->matchesFilterCriteria($tmp_data)) {
280 $part[] = $tmp_data;
281 }
282 }
283 $this->setData($part ? $part : array());
284 }
matchesFilterCriteria($a_user_info)
Check if user is filtered.
setData($a_data)
set table data @access public
User query class.
foreach($_POST as $key=> $value) $res

References $GLOBALS, $res, collectParticipants(), getParentLocalRoles(), getParticipants(), matchesFilterCriteria(), and ilTable2GUI\setData().

+ Here is the call graph for this function:

Field Documentation

◆ $all_columns

ilSessionParticipantsTableGUI::$all_columns = null
staticprotected

Definition at line 15 of file class.ilSessionParticipantsTableGUI.php.

Referenced by getSelectableColumns().

◆ $logger

ilSessionParticipantsTableGUI::$logger = null
private

Definition at line 40 of file class.ilSessionParticipantsTableGUI.php.

◆ $member_ref_id

ilSessionParticipantsTableGUI::$member_ref_id = 0
private

Definition at line 33 of file class.ilSessionParticipantsTableGUI.php.

◆ $parent_ref_id

ilSessionParticipantsTableGUI::$parent_ref_id = 0
private

Definition at line 27 of file class.ilSessionParticipantsTableGUI.php.

◆ $participants

ilSessionParticipantsTableGUI::$participants = null
private

Definition at line 46 of file class.ilSessionParticipantsTableGUI.php.

Referenced by getParticipants().

◆ $rep_object

ilSessionParticipantsTableGUI::$rep_object = null
private

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

Referenced by getRepositoryObject().


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