ILIAS  release_9 Revision v9.13-25-g2c18ec4c24f
ilSessionParticipantsTableGUI Class Reference

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

+ 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 ()
 
 setShowTemplates (bool $a_value)
 
 getShowTemplates ()
 
 restoreTemplate (string $a_name)
 Restore state from template. More...
 
 saveTemplate (string $a_name)
 Save current state as template. More...
 
 deleteTemplate (string $a_name)
 
 getLimit ()
 
 getOffset ()
 
 setExportFormats (array $formats)
 Set available export formats. More...
 
 setPrintMode (bool $a_value=false)
 
 getPrintMode ()
 
 getExportMode ()
 
 exportData (int $format, bool $send=false)
 Export and optionally send current table data. More...
 
 setEnableAllCommand (bool $a_value)
 
 setRowSelectorLabel (string $row_selector_label)
 
 getRowSelectorLabel ()
 
 setPreventDoubleSubmission (bool $a_val)
 
 getPreventDoubleSubmission ()
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 
- Public Member Functions inherited from ilTableGUI
 __construct (array $a_data=[], bool $a_global_tpl=true)
 
 setTemplate (ilTemplate $a_tpl)
 
 getTemplateObject ()
 
 setData (array $a_data)
 Set table data. More...
 
 getData ()
 
 setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")
 
 setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")
 
 setHeaderNames (array $a_header_names)
 
 getColumnCount ()
 
 setHeaderVars (array $a_header_vars, array $a_header_params=[])
 
 setColumnWidth (array $a_column_width)
 set table column widths More...
 
 setOneColumnWidth (string $a_column_width, int $a_column_number)
 
 setMaxCount (int $a_max_count)
 set max. More...
 
 setLimit (int $a_limit=0, int $a_default_limit=0)
 set max. More...
 
 getLimit ()
 
 setPrefix (string $a_prefix)
 set prefix for sort and offset fields (if you have two or more tables on a page that you want to sort separately) More...
 
 setOffset (int $a_offset)
 set dataset offset More...
 
 getOffset ()
 
 setOrderColumn (string $a_order_column="", string $a_default_column="")
 
 getOrderColumn ()
 
 setOrderDirection (string $a_order_direction)
 
 getOrderDirection ()
 
 setFooter (string $a_style, string $a_previous="", string $a_next="")
 
 enable (string $a_module_name)
 
 disable (string $a_module_name)
 
 sortData ()
 
 render ()
 
 renderHeader ()
 
 setOrderLink (string $key, string $order_dir)
 
 setStyle (string $a_element, string $a_style)
 
 getStyle (string $a_element)
 
 setBase (string $a_base)
 
 getBase ()
 
 getFormName ()
 get the name of the parent form More...
 
 setFormName (string $a_name="cmd")
 
 getSelectAllCheckbox ()
 get the name of the checkbox that should be toggled with a select all button More...
 
 setSelectAllCheckbox (string $a_select_all_checkbox)
 
 clearActionButtons ()
 
 addActionButton (string $btn_name, string $btn_value)
 

Protected Member Functions

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

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

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

39  {
40  global $DIC;
41 
42  $this->logger = $DIC->logger()->sess();
43  $this->tree = $DIC->repositoryTree();
44  $this->rbac = $DIC->rbac();
45 
46  $this->rep_object = $a_parent_obj;
47 
48  $this->participants = ilParticipants::getInstance($this->getRepositoryObject()->getRefId());
49 
50  $this->setId('session_part_' . $this->getRepositoryObject()->getId());
51  parent::__construct($a_parent_gui, $a_parent_cmd);
52 
53  $this->parent_ref_id = $this->tree->getParentId(
54  $this->getRepositoryObject()->getRefId()
55  );
56 
57  /*
58  * TODO this exact logic is also in ilSessionMembershipGUI and ilMembershipGUI,
59  * should be centralized.
60  */
61  if ($member_ref = $this->tree->checkForParentType($this->parent_ref_id, 'grp')) {
62  $this->member_ref_id = $member_ref;
63  } elseif ($member_ref = $this->tree->checkForParentType($this->parent_ref_id, 'crs')) {
64  $this->member_ref_id = $member_ref;
65  } else {
66  throw new \InvalidArgumentException("Error in tree structure. Session has no parent course/group ref_id: " . $this->getRepositoryObject()->getRefId());
67  }
68  }
static getInstance(int $a_ref_id)
setId(string $a_val)
global $DIC
Definition: feed.php:28
__construct(VocabulariesInterface $vocabularies)
+ 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 268 of file class.ilSessionParticipantsTableGUI.php.

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

Referenced by parse().

268  : array
269  {
270  $direct_participants = $this->getParticipants()
271  ->getEventParticipants()
272  ->getParticipants();
273  $direct_participants = array_keys($direct_participants);
274 
275  $part = ilParticipants::getInstance($this->member_ref_id);
276  if (!$part instanceof ilParticipants) {
277  return $direct_participants;
278  }
279 
280  return array_unique(array_merge(
281  $direct_participants,
282  $part->getParticipants()
283  ));
284  }
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 315 of file class.ilSessionParticipantsTableGUI.php.

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

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

◆ getParentLocalRoles()

ilSessionParticipantsTableGUI::getParentLocalRoles ( )
protected

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

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

Referenced by initFilter(), and parse().

359  : array
360  {
361  $part = null;
362  $type = ilObject::_lookupType($this->member_ref_id, true);
363  switch ($type) {
364  case 'crs':
365  case 'grp':
366  $part = ilParticipants::getInstance($this->member_ref_id);
367  // no break
368  default:
369  }
370  if (!$part instanceof ilParticipants) {
371  return [];
372  }
373 
374  $review = $this->rbac->review();
375  $local_parent_roles = $review->getLocalRoles($this->member_ref_id);
376  $local_roles_info = [];
377  foreach ($local_parent_roles as $index => $role_id) {
378  $local_roles_info[$role_id] = ilObjRole::_getTranslation(
379  ilObject::_lookupTitle($role_id)
380  );
381  }
382  return $local_roles_info;
383  }
static getInstance(int $a_ref_id)
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 80 of file class.ilSessionParticipantsTableGUI.php.

References $participants.

Referenced by collectParticipants(), and parse().

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

◆ getRepositoryObject()

ilSessionParticipantsTableGUI::getRepositoryObject ( )
protected

Definition at line 70 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 194 of file class.ilSessionParticipantsTableGUI.php.

References ILIAS\Repository\lng().

Referenced by init().

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

◆ init()

ilSessionParticipantsTableGUI::init ( )

Definition at line 85 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().

85  : void
86  {
87  $this->lng->loadLanguageModule('sess');
88  $this->lng->loadLanguageModule('crs');
89  $this->lng->loadLanguageModule('trac');
90  $this->lng->loadLanguageModule('mmbr');
91 
92  $this->setFormName('participants');
93 
94  $this->initFilter();
95 
96 
97  $this->setSelectAllCheckbox('participants', true);
98  $this->setShowRowsSelector(true);
99 
100  $this->enable('sort');
101  $this->enable('header');
102  $this->enable('numinfo');
103  $this->enable('select_all');
104 
105 
106  $this->setFormAction($this->ctrl->getFormAction($this->getParentObject(), $this->getParentCmd()));
107 
108  $this->setRowTemplate("tpl.sess_members_row.html", "Modules/Session");
109 
110  $this->addColumn('', 'f', '1', true);
111  $this->addColumn($this->lng->txt('name'), 'name', '20%');
112  $this->addColumn($this->lng->txt('login'), 'login', '10%');
113 
114  $all_cols = $this->getSelectableColumns();
115  foreach ($this->getSelectedColumns() as $col) {
116  $this->addColumn($all_cols[$col]['txt'], $col);
117  }
118 
119 
120  if ($this->isRegistrationEnabled()) {
121  $this->addColumn($this->lng->txt('event_tbl_registered'), 'registered');
122  $this->setDefaultOrderField('registered');
123  $this->setDefaultOrderDirection('desc');
124  } else {
125  $this->setDefaultOrderField('name');
126  }
127 
128  $this->addColumn($this->lng->txt('event_tbl_participated'), 'participated');
129 
130  if ($this->isRegistrationEnabled()) {
131  $this->addColumn($this->lng->txt('sess_part_table_excused'), 'excused');
132  }
133 
134  $this->addColumn($this->lng->txt('sess_contact'), 'contact');
135  if (true === $this->getRepositoryObject()->isRegistrationNotificationEnabled()) {
136  $this->addColumn($this->lng->txt('notification'), 'notification_checked');
137  }
138 
139  $this->addColumn($this->lng->txt('trac_mark'), 'mark');
140  $this->addColumn($this->lng->txt('trac_comment'), 'comment');
141 
142 
143  $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('mmbr_btn_mail_selected_users'));
144  $this->lng->loadLanguageModule('user');
145  $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
146 
147 
148  $this->addCommandButton('updateMembers', $this->lng->txt('save'));
149  }
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 151 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().

151  : void
152  {
153  $login = $this->addFilterItemByMetaType(
154  'login',
156  false,
157  $this->lng->txt('name')
158  );
159  $this->current_filter['login'] = $login->getValue();
160 
161 
162  if ($this->isColumnSelected('roles')) {
163  $role = $this->addFilterItemByMetaType(
164  'roles',
166  false,
167  $this->lng->txt('objs_' . ilObject::_lookupType(ilObject::_lookupObjId($this->member_ref_id)) . '_role')
168  );
169 
170  $options = [];
171  $options[0] = $this->lng->txt('all_roles');
172  $role->setOptions($options + $this->getParentLocalRoles());
173  $this->current_filter['roles'] = $role->getValue();
174  }
175 
176  if ($this->getRepositoryObject()->enabledRegistration()) {
177  $reg = $this->addFilterItemByMetaType(
178  'filter_registration',
180  false,
181  $this->lng->txt('sess_part_filter_registered')
182  );
183  $this->current_filter['filter_registration'] = $reg->getChecked();
184  }
185  $participated = $this->addFilterItemByMetaType(
186  'filter_participated',
188  false,
189  $this->lng->txt('sess_part_filter_participated')
190  );
191  $this->current_filter['filter_participated'] = $participated->getChecked();
192  }
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 75 of file class.ilSessionParticipantsTableGUI.php.

References getRepositoryObject().

Referenced by fillRow(), and init().

75  : bool
76  {
77  return $this->getRepositoryObject()->enabledRegistration();
78  }
+ 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 286 of file class.ilSessionParticipantsTableGUI.php.

Referenced by parse().

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

◆ parse()

ilSessionParticipantsTableGUI::parse ( )

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

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

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

Field Documentation

◆ $all_columns

array ilSessionParticipantsTableGUI::$all_columns = []
staticprotected

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

◆ $current_filter

array ilSessionParticipantsTableGUI::$current_filter = []
private

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

◆ $logger

ilLogger ilSessionParticipantsTableGUI::$logger
private

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

◆ $member_ref_id

int ilSessionParticipantsTableGUI::$member_ref_id = 0
private

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

◆ $parent_ref_id

int ilSessionParticipantsTableGUI::$parent_ref_id = 0
private

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

◆ $participants

ilParticipants ilSessionParticipantsTableGUI::$participants
private

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

Referenced by getParticipants().

◆ $rbac

ILIAS DI RBACServices ilSessionParticipantsTableGUI::$rbac
private

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

◆ $rep_object

ilObjSession ilSessionParticipantsTableGUI::$rep_object
private

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

Referenced by getRepositoryObject().

◆ $tree

ilTree ilSessionParticipantsTableGUI::$tree
private

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


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