ILIAS  trunk Revision v11.0_alpha-1749-g1a06bdef097
All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Modules Pages
ilSessionParticipantsTableGUI Class Reference
+ Inheritance diagram for ilSessionParticipantsTableGUI:
+ Collaboration diagram for ilSessionParticipantsTableGUI:

Public Member Functions

 __construct (object $a_parent_gui, ilObjSession $a_parent_obj, string $a_parent_cmd)
 
 init ()
 
 initFilter ()
 
 getSelectableColumns ()
 
 parse ()
 
- Public Member Functions inherited from ilTable2GUI
 __construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")
 
 setOpenFormTag (bool $a_val)
 
 getOpenFormTag ()
 
 setCloseFormTag (bool $a_val)
 
 getCloseFormTag ()
 
 determineLimit ()
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 determineSelectedColumns ()
 
 isColumnSelected (string $col)
 
 getSelectedColumns ()
 
 resetOffset (bool $a_in_determination=false)
 
 initFilter ()
 
 getParentObject ()
 
 getParentCmd ()
 
 setTopAnchor (string $a_val)
 
 getTopAnchor ()
 
 setNoEntriesText (string $a_text)
 
 getNoEntriesText ()
 
 setIsDataTable (bool $a_val)
 
 getIsDataTable ()
 
 setEnableTitle (bool $a_enabletitle)
 
 getEnableTitle ()
 
 setEnableHeader (bool $a_enableheader)
 
 getEnableHeader ()
 
 setEnableNumInfo (bool $a_val)
 
 getEnableNumInfo ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setDescription (string $a_val)
 
 getDescription ()
 
 setOrderField (string $a_order_field)
 
 getOrderField ()
 
 setData (array $a_data)
 
 getData ()
 
 dataExists ()
 
 setPrefix (string $a_prefix)
 
 getPrefix ()
 
 addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)
 
 addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
 Add filter by standard type. More...
 
 getFilterItems (bool $a_optionals=false)
 
 getFilterItemByPostVar (string $a_post_var)
 
 setFilterCols (int $a_val)
 
 getFilterCols ()
 
 setDisableFilterHiding (bool $a_val=true)
 
 getDisableFilterHiding ()
 
 isFilterSelected (string $a_col)
 Is given filter selected? More...
 
 getSelectedFilters ()
 
 determineSelectedFilters ()
 
 setCustomPreviousNext (string $a_prev_link, string $a_next_link)
 
 setFormAction (string $a_form_action, bool $a_multipart=false)
 
 getFormAction ()
 
 setFormName (string $a_name="")
 
 getFormName ()
 
 setId (string $a_val)
 
 getId ()
 
 setDisplayAsBlock (bool $a_val)
 
 getDisplayAsBlock ()
 
 setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)
 
 setExternalSorting (bool $a_val)
 
 getExternalSorting ()
 
 setFilterCommand (string $a_val, string $a_caption="")
 
 getFilterCommand ()
 
 setResetCommand (string $a_val, string $a_caption="")
 
 getResetCommand ()
 
 setExternalSegmentation (bool $a_val)
 
 getExternalSegmentation ()
 
 setRowTemplate (string $a_template, string $a_template_dir="")
 Set row template. More...
 
 setDefaultOrderField (string $a_defaultorderfield)
 
 getDefaultOrderField ()
 
 setDefaultOrderDirection (string $a_defaultorderdirection)
 
 getDefaultOrderDirection ()
 
 setDefaultFilterVisiblity (bool $a_status)
 
 getDefaultFilterVisibility ()
 
 clearCommandButtons ()
 
 addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
 
 addCommandButtonInstance (ilButtonBase $a_button)
 
 addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')
 
 setCloseCommand (string $a_link)
 
 addMultiCommand (string $a_cmd, string $a_text)
 
 addHiddenInput (string $a_name, string $a_value)
 
 addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")
 
 setTopCommands (bool $a_val)
 
 getTopCommands ()
 
 addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)
 
 getNavParameter ()
 
 setOrderLink (string $key, string $order_dir)
 
 fillHeader ()
 
 determineOffsetAndOrder (bool $a_omit_offset=false)
 
 storeNavParameter ()
 
 getHTML ()
 Get HTML. More...
 
 numericOrdering (string $a_field)
 Should this field be sorted numeric? More...
 
 render ()
 
 writeFilterToSession ()
 
 resetFilter ()
 
 fillFooter ()
 
 getLinkbar (string $a_num)
 
 fillHiddenRow ()
 
 fillActionRow ()
 
 setHeaderHTML (string $html)
 
 storeProperty (string $type, string $value)
 
 loadProperty (string $type)
 
 getCurrentState ()
 get current settings for order, limit, columns and filter More...
 
 setContext (string $id)
 
 getContext ()
 
 setShowRowsSelector (bool $a_value)
 Toggle rows-per-page selector. More...
 
 getShowRowsSelector ()
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Member Functions

 getRepositoryObject ()
 
 isRegistrationEnabled ()
 
 getParticipants ()
 
 collectParticipants ()
 
 matchesFilterCriteria (array $a_user_info)
 
 fillRow (array $a_set)
 
 getParentLocalRoles ()
 
- 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...
 

Static Protected Attributes

static array $all_columns = []
 

Private Attributes

ilLogger $logger
 
ilTree $tree
 
ILIAS DI RBACServices $rbac
 
ilObjSession $rep_object
 
ilParticipants $participants
 
int $parent_ref_id = 0
 
int $member_ref_id = 0
 
array $current_filter = []
 

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
 
- Protected Attributes inherited from ilTable2GUI
string $requested_nav_par2 = ""
 
string $requested_nav_par = ""
 
string $requested_nav_par1 = ""
 
ILIAS Table TableGUIRequest $table_request = null
 
array $selected_columns = []
 
ilCtrl $ctrl
 
object $parent_obj = null
 
string $parent_cmd = ""
 
string $close_command = ""
 
string $top_anchor = "il_table_top"
 
array $filters = array()
 
array $optional_filters = array()
 
string $filter_cmd = 'applyFilter'
 
string $reset_cmd = 'resetFilter'
 
int $filter_cols = 5
 
bool $ext_sort = false
 
bool $ext_seg = false
 
string $context = ""
 
array $mi_sel_buttons = []
 
bool $disable_filter_hiding = false
 
bool $top_commands = true
 
array $selectable_columns = array()
 
array $selected_column = array()
 
bool $show_rows_selector = true
 
bool $rows_selector_off = false
 
bool $nav_determined = false
 
bool $limit_determined = false
 
bool $filters_determined = false
 
bool $columns_determined = false
 
bool $open_form_tag = true
 
bool $close_form_tag = true
 
array $export_formats = []
 
int $export_mode = 0
 
bool $print_mode = false
 
bool $enable_command_for_all = false
 
bool $restore_filter = false
 
array $restore_filter_values = []
 
bool $default_filter_visibility = false
 
array $sortable_fields = array()
 
bool $prevent_double_submission = true
 
string $row_selector_label = ""
 
bool $select_all_on_top = false
 
array $sel_buttons = []
 
string $nav_value = ''
 
string $noentriestext = ''
 
string $css_row = ''
 
bool $display_as_block = false
 
string $description = ''
 
string $id = ""
 
bool $custom_prev_next = false
 
string $reset_cmd_txt = ""
 
string $defaultorderfield = ""
 
string $defaultorderdirection = ""
 
array $column = []
 
bool $datatable = false
 
bool $num_info = false
 
bool $form_multipart = false
 
array $row_data = []
 
string $order_field = ""
 
array $selected_filter = []
 
string $form_action = ""
 
string $formname = ""
 
string $sort_order = ""
 
array $buttons = []
 
array $multi = []
 
array $hidden_inputs = []
 
array $header_commands = []
 
string $row_template = ""
 
string $row_template_dir = ""
 
string $filter_cmd_txt = ""
 
string $custom_prev = ""
 
string $custom_next = ""
 
array $raw_post_data = null
 
ilGlobalTemplateInterface $main_tpl
 
- Protected Attributes inherited from ilTableGUI
string $sort_order
 
string $link_params
 
array $header_params
 
 $tpl
 
ilLanguage $lng
 

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\getId(), ilParticipants\getInstance(), getRepositoryObject(), ILIAS\Repository\logger(), ILIAS\Repository\rbac(), and ilTable2GUI\setId().

38  {
39  global $DIC;
40 
41  $this->logger = $DIC->logger()->sess();
42  $this->tree = $DIC->repositoryTree();
43  $this->rbac = $DIC->rbac();
44 
45  $this->rep_object = $a_parent_obj;
46 
47  $this->participants = ilParticipants::getInstance($this->getRepositoryObject()->getRefId());
48 
49  $this->setId('session_part_' . $this->getRepositoryObject()->getId());
50  parent::__construct($a_parent_gui, $a_parent_cmd);
51 
52  $this->parent_ref_id = $this->tree->getParentId(
53  $this->getRepositoryObject()->getRefId()
54  );
55 
56  /*
57  * TODO this exact logic is also in ilSessionMembershipGUI and ilMembershipGUI,
58  * should be centralized.
59  */
60  if ($member_ref = $this->tree->checkForParentType($this->parent_ref_id, 'grp')) {
61  $this->member_ref_id = $member_ref;
62  } elseif ($member_ref = $this->tree->checkForParentType($this->parent_ref_id, 'crs')) {
63  $this->member_ref_id = $member_ref;
64  } else {
65  throw new \InvalidArgumentException("Error in tree structure. Session has no parent course/group ref_id: " . $this->getRepositoryObject()->getRefId());
66  }
67  }
static getInstance(int $a_ref_id)
setId(string $a_val)
global $DIC
Definition: shib_login.php:22
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ collectParticipants()

ilSessionParticipantsTableGUI::collectParticipants ( )
protected
Returns
int[] array of parent course/group participants

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

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

Referenced by parse().

267  : array
268  {
269  $direct_participants = $this->getParticipants()
270  ->getEventParticipants()
271  ->getParticipants();
272  $direct_participants = array_keys($direct_participants);
273 
274  $part = ilParticipants::getInstance($this->member_ref_id);
275  if (!$part instanceof ilParticipants) {
276  return $direct_participants;
277  }
278 
279  return array_unique(array_merge(
280  $direct_participants,
281  $part->getParticipants()
282  ));
283  }
static getInstance(int $a_ref_id)
Base class for course and group participants.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilSessionParticipantsTableGUI::fillRow ( array  $a_set)
protected

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

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

314  : void
315  {
316  $this->tpl->setVariable('VAL_POSTNAME', 'participants');
317 
318  if ($this->isRegistrationEnabled()) {
319  $this->tpl->setCurrentBlock('registered_col');
320  $this->tpl->setVariable('VAL_ID', $a_set['id']);
321  $this->tpl->setVariable('REG_CHECKED', $a_set['registered'] ? 'checked="checked"' : '');
322  $this->tpl->parseCurrentBlock();
323  }
324 
325  foreach ($this->getSelectedColumns() as $field) {
326  if ($field == 'roles') {
327  $this->tpl->setCurrentBlock('custom_fields');
328  $this->tpl->setVariable('VAL_CUST', (string) $a_set['roles']);
329  $this->tpl->parseCurrentBlock();
330  }
331  }
332 
333  if (true === $a_set['show_notification']) {
334  $this->tpl->setCurrentBlock('notification_column');
335  $this->tpl->setVariable('VAL_ID', $a_set['id']);
336  $this->tpl->setVariable('NOTIFICATION_CHECKED', $a_set['notification_checked'] ? 'checked="checked"' : '');
337 
338  $enableCheckbox = $a_set['notification_checkbox_enabled'];
339 
340  $this->tpl->setVariable('NOTIFICATION_ENABLED', $enableCheckbox ? '' : 'disabled');
341  $this->tpl->parseCurrentBlock();
342  }
343 
344  $this->tpl->setVariable('VAL_ID', $a_set['id']);
345  $this->tpl->setVariable('LASTNAME', $a_set['lastname']);
346  $this->tpl->setVariable('FIRSTNAME', $a_set['firstname']);
347  $this->tpl->setVariable('LOGIN', $a_set['login']);
348  $this->tpl->setVariable('MARK', $a_set['mark']);
349  $this->tpl->setVariable('COMMENT', $a_set['comment']);
350  $this->tpl->setVariable('PART_CHECKED', $a_set['participated'] ? 'checked="checked"' : '');
351  $this->tpl->setVariable('CONTACT_CHECKED', $a_set['contact'] ? 'checked="checked"' : '');
352  $this->tpl->setVariable('PART_CHECKED', $a_set['participated'] ? 'checked="checked"' : '');
353  if ($this->isRegistrationEnabled()) {
354  $this->tpl->setVariable('EXCUSED_CHECKED', $a_set['excused'] ? 'checked="checked"' : '');
355  }
356  }
+ Here is the call graph for this function:

◆ getParentLocalRoles()

ilSessionParticipantsTableGUI::getParentLocalRoles ( )
protected

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

References ilObjRole\_getTranslation(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilParticipants\getInstance(), null, and ILIAS\Repository\rbac().

Referenced by initFilter(), and parse().

358  : array
359  {
360  $part = null;
361  $type = ilObject::_lookupType($this->member_ref_id, true);
362  switch ($type) {
363  case 'crs':
364  case 'grp':
365  $part = ilParticipants::getInstance($this->member_ref_id);
366  // no break
367  default:
368  }
369  if (!$part instanceof ilParticipants) {
370  return [];
371  }
372 
373  $review = $this->rbac->review();
374  $local_parent_roles = $review->getLocalRoles($this->member_ref_id);
375  $local_roles_info = [];
376  foreach ($local_parent_roles as $index => $role_id) {
377  $local_roles_info[$role_id] = ilObjRole::_getTranslation(
378  ilObject::_lookupTitle($role_id)
379  );
380  }
381  return $local_roles_info;
382  }
static getInstance(int $a_ref_id)
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
static _lookupTitle(int $obj_id)
static _getTranslation(string $a_role_title)
Base class for course and group participants.
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getParticipants()

ilSessionParticipantsTableGUI::getParticipants ( )
protected

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

References $participants.

Referenced by collectParticipants(), and parse().

80  {
81  return $this->participants;
82  }
Base class for course and group participants.
+ Here is the caller graph for this function:

◆ getRepositoryObject()

ilSessionParticipantsTableGUI::getRepositoryObject ( )
protected

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

References $rep_object.

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

+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilSessionParticipantsTableGUI::getSelectableColumns ( )

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

References ILIAS\Repository\lng().

Referenced by init().

193  : array
194  {
195  self::$all_columns['roles'] = array(
196  'txt' => $this->lng->txt('objs_role'),
197  'default' => true
198  );
199 
200  return self::$all_columns;
201  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ init()

ilSessionParticipantsTableGUI::init ( )

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

References ilTable2GUI\addColumn(), ilTable2GUI\addCommandButton(), ilTable2GUI\addMultiCommand(), ILIAS\Repository\ctrl(), ilTableGUI\enable(), ilTable2GUI\getParentCmd(), getRepositoryObject(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), initFilter(), isRegistrationEnabled(), ILIAS\Repository\lng(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and ilTable2GUI\setShowRowsSelector().

84  : void
85  {
86  $this->lng->loadLanguageModule('sess');
87  $this->lng->loadLanguageModule('crs');
88  $this->lng->loadLanguageModule('trac');
89  $this->lng->loadLanguageModule('mmbr');
90 
91  $this->setFormName('participants');
92 
93  $this->initFilter();
94 
95 
96  $this->setSelectAllCheckbox('participants', true);
97  $this->setShowRowsSelector(true);
98 
99  $this->enable('sort');
100  $this->enable('header');
101  $this->enable('numinfo');
102  $this->enable('select_all');
103 
104 
105  $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), $this->getParentCmd()));
106 
107  $this->setRowTemplate("tpl.sess_members_row.html", "components/ILIAS/Session");
108 
109  $this->addColumn('', 'f', '1', true);
110  $this->addColumn($this->lng->txt('name'), 'name', '20%');
111  $this->addColumn($this->lng->txt('login'), 'login', '10%');
112 
113  $all_cols = $this->getSelectableColumns();
114  foreach ($this->getSelectedColumns() as $col) {
115  $this->addColumn($all_cols[$col]['txt'], $col);
116  }
117 
118 
119  if ($this->isRegistrationEnabled()) {
120  $this->addColumn($this->lng->txt('event_tbl_registered'), 'registered');
121  $this->setDefaultOrderField('registered');
122  $this->setDefaultOrderDirection('desc');
123  } else {
124  $this->setDefaultOrderField('name');
125  }
126 
127  $this->addColumn($this->lng->txt('event_tbl_participated'), 'participated');
128 
129  if ($this->isRegistrationEnabled()) {
130  $this->addColumn($this->lng->txt('sess_part_table_excused'), 'excused');
131  }
132 
133  $this->addColumn($this->lng->txt('sess_contact'), 'contact');
134  if (true === $this->getRepositoryObject()->isRegistrationNotificationEnabled()) {
135  $this->addColumn($this->lng->txt('notification'), 'notification_checked');
136  }
137 
138  $this->addColumn($this->lng->txt('trac_mark'), 'mark');
139  $this->addColumn($this->lng->txt('trac_comment'), 'comment');
140 
141 
142  $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
143  $this->lng->loadLanguageModule('user');
144  $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
145 
146 
147  $this->addCommandButton('updateMembers', $this->lng->txt('save'));
148  }
enable(string $a_module_name)
setFormAction(string $a_form_action, bool $a_multipart=false)
addCommandButton(string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")
setSelectAllCheckbox(string $a_select_all_checkbox, bool $a_select_all_on_top=false)
setFormName(string $a_name="")
setShowRowsSelector(bool $a_value)
Toggle rows-per-page selector.
setDefaultOrderField(string $a_defaultorderfield)
setRowTemplate(string $a_template, string $a_template_dir="")
Set row template.
setDefaultOrderDirection(string $a_defaultorderdirection)
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)
addMultiCommand(string $a_cmd, string $a_text)
+ Here is the call graph for this function:

◆ initFilter()

ilSessionParticipantsTableGUI::initFilter ( )

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

References ilObject\_lookupObjId(), ilObject\_lookupType(), ilTable2GUI\addFilterItemByMetaType(), ilTable2GUI\FILTER_CHECKBOX, ilTable2GUI\FILTER_SELECT, ilTable2GUI\FILTER_TEXT, getParentLocalRoles(), getRepositoryObject(), ilTable2GUI\isColumnSelected(), and ILIAS\Repository\lng().

Referenced by init().

150  : void
151  {
152  $login = $this->addFilterItemByMetaType(
153  'login',
155  false,
156  $this->lng->txt('name')
157  );
158  $this->current_filter['login'] = $login->getValue();
159 
160 
161  if ($this->isColumnSelected('roles')) {
162  $role = $this->addFilterItemByMetaType(
163  'roles',
165  false,
166  $this->lng->txt('objs_' . ilObject::_lookupType(ilObject::_lookupObjId($this->member_ref_id)) . '_role')
167  );
168 
169  $options = [];
170  $options[0] = $this->lng->txt('all_roles');
171  $role->setOptions($options + $this->getParentLocalRoles());
172  $this->current_filter['roles'] = $role->getValue();
173  }
174 
175  if ($this->getRepositoryObject()->enabledRegistration()) {
176  $reg = $this->addFilterItemByMetaType(
177  'filter_registration',
179  false,
180  $this->lng->txt('sess_part_filter_registered')
181  );
182  $this->current_filter['filter_registration'] = $reg->getChecked();
183  }
184  $participated = $this->addFilterItemByMetaType(
185  'filter_participated',
187  false,
188  $this->lng->txt('sess_part_filter_participated')
189  );
190  $this->current_filter['filter_participated'] = $participated->getChecked();
191  }
static _lookupObjId(int $ref_id)
isColumnSelected(string $col)
addFilterItemByMetaType(string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
Add filter by standard type.
static _lookupType(int $id, bool $reference=false)
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isRegistrationEnabled()

ilSessionParticipantsTableGUI::isRegistrationEnabled ( )
protected

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

References getRepositoryObject().

Referenced by fillRow(), and init().

74  : bool
75  {
76  return $this->getRepositoryObject()->enabledRegistration();
77  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ matchesFilterCriteria()

ilSessionParticipantsTableGUI::matchesFilterCriteria ( array  $a_user_info)
protected

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

Referenced by parse().

285  : bool
286  {
287  foreach ($this->current_filter as $filter => $filter_value) {
288  if (!$filter_value) {
289  continue;
290  }
291  switch ($filter) {
292  case 'roles':
293  if (!in_array($filter_value, ($a_user_info['role_ids'] ?? []))) {
294  return false;
295  }
296  break;
297 
298  case 'filter_participated':
299  if (!($a_user_info['participated'] ?? false)) {
300  return false;
301  }
302  break;
303 
304  case 'filter_registration':
305  if (!($a_user_info['registered'] ?? false)) {
306  return false;
307  }
308  break;
309  }
310  }
311  return true;
312  }
+ Here is the caller graph for this function:

◆ parse()

ilSessionParticipantsTableGUI::parse ( )

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

References $res, collectParticipants(), getParentLocalRoles(), getParticipants(), getRepositoryObject(), matchesFilterCriteria(), ilSessionConstants\NOTIFICATION_INHERIT_OPTION, null, ILIAS\Repository\rbac(), and ilTable2GUI\setData().

203  : void
204  {
205  $all_participants = [];
206  $all_possible_participants = $this->collectParticipants();
207  if ($all_possible_participants !== []) {
208  // user filter
209  $user_query = new ilUserQuery();
210  $user_query->setLimit(50000);
211  $user_query->setUserFilter($all_possible_participants);
212  $user_query->setTextFilter((string) $this->current_filter['login']);
213  $res = $user_query->query();
214  $all_participants = $res['set'];
215  }
216 
217  $part = [];
218  foreach ($all_participants as $counter => $participant) {
219  $usr_data = $this->getParticipants()->getEventParticipants()->getUser((int) $participant['usr_id']);
220  $tmp_data = [];
221  $tmp_data['id'] = $participant['usr_id'];
222 
223  $tmp_data['name'] = $participant['lastname'];
224  $tmp_data['lastname'] = $participant['lastname'];
225  $tmp_data['firstname'] = $participant['firstname'];
226  $tmp_data['login'] = $participant['login'];
227  $tmp_data['mark'] = $usr_data['mark'] ?? null;
228  $tmp_data['comment'] = $usr_data['comment'] ?? null;
229  $tmp_data['participated'] = $this->getParticipants()->getEventParticipants()->hasParticipated((int) $participant['usr_id']);
230  $tmp_data['registered'] = $this->getParticipants()->getEventParticipants()->isRegistered((int) $participant['usr_id']);
231  $tmp_data['excused'] = $this->getParticipants()->getEventParticipants()->isExcused((int) $participant['usr_id']);
232  $tmp_data['contact'] = $this->getParticipants()->isContact((int) $participant['usr_id']);
233 
234  $notificationShown = false;
235  if (true === $this->getRepositoryObject()->isRegistrationNotificationEnabled()) {
236  $notificationShown = true;
237  $notificationCheckboxEnabled = true;
238  if (ilSessionConstants::NOTIFICATION_INHERIT_OPTION === $this->getRepositoryObject()->getRegistrationNotificationOption()) {
239  $notificationCheckboxEnabled = false;
240  }
241  $tmp_data['notification_checkbox_enabled'] = $notificationCheckboxEnabled;
242  $tmp_data['notification_checked'] = $usr_data['notification_enabled'] ?? false;
243  }
244  $tmp_data['show_notification'] = $notificationShown;
245 
246  $roles = [];
247  $local_roles = $this->getParentLocalRoles();
248  foreach ($local_roles as $role_id => $role_name) {
249  // @todo fix performance
250  if ($this->rbac->review()->isAssigned((int) $participant['usr_id'], $role_id)) {
251  $tmp_data['role_ids'][] = $role_id;
252  $roles[] = $role_name;
253  }
254  }
255  $tmp_data['roles'] = implode('<br />', $roles);
256 
257  if ($this->matchesFilterCriteria($tmp_data)) {
258  $part[] = $tmp_data;
259  }
260  }
261  $this->setData($part);
262  }
setData(array $a_data)
$res
Definition: ltiservices.php:66
while($session_entry=$r->fetchRow(ilDBConstants::FETCHMODE_ASSOC)) return null
+ Here is the call graph for this function:

Field Documentation

◆ $all_columns

array ilSessionParticipantsTableGUI::$all_columns = []
staticprotected

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

◆ $current_filter

array ilSessionParticipantsTableGUI::$current_filter = []
private

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

◆ $logger

ilLogger ilSessionParticipantsTableGUI::$logger
private

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

◆ $member_ref_id

int ilSessionParticipantsTableGUI::$member_ref_id = 0
private

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

◆ $parent_ref_id

int ilSessionParticipantsTableGUI::$parent_ref_id = 0
private

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

◆ $participants

ilParticipants ilSessionParticipantsTableGUI::$participants
private

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

Referenced by getParticipants().

◆ $rbac

ILIAS DI RBACServices ilSessionParticipantsTableGUI::$rbac
private

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

◆ $rep_object

ilObjSession ilSessionParticipantsTableGUI::$rep_object
private

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

Referenced by getRepositoryObject().

◆ $tree

ilTree ilSessionParticipantsTableGUI::$tree
private

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


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