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

GUI class for course/group subscriptions. More...

+ Inheritance diagram for ilSubscriberTableGUI:
+ Collaboration diagram for ilSubscriberTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $rep_object, $show_content=true, $show_subject=true)
 Constructor. More...
 
 getSelectableColumns ()
 Get selectable columns. More...
 
 fillRow ($a_set)
 fill row More...
 
 showActionLinks ($a_set)
 Show action links (mail ; edit crs|grp data) More...
 
 readSubscriberData (array $a_subscriber_ids)
 read data More...
 
 setShowSubject ($a_value)
 
 getShowSubject ()
 
- 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)
 
 getData ()
 
 dataExists ()
 
 setPrefix ($a_prefix)
 
 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 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)
 
- Public Member Functions inherited from ilTableGUI
 __construct ($a_data=0, $a_global_tpl=true)
 Constructor. More...
 
 setTemplate ($a_tpl)
 set template public More...
 
getTemplateObject ()
 
 setData ($a_data)
 set table data public More...
 
 getData ()
 
 setTitle ($a_title, $a_icon=0, $a_icon_alt=0)
 set table title public More...
 
 setHelp ($a_help_page, $a_help_icon, $a_help_icon_alt=0)
 set table help page public More...
 
 setHeaderNames ($a_header_names)
 set table header names public More...
 
 getColumnCount ()
 Returns the column count based on the number of the header row columns public. More...
 
 setHeaderVars ($a_header_vars, $a_header_params=0)
 set table header vars public More...
 
 setColumnWidth ($a_column_width)
 set table column widths public More...
 
 setOneColumnWidth ($a_column_width, $a_column_number)
 set one table column width 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) public More...
 
 setOffset ($a_offset)
 set dataset offset public More...
 
 getOffset ()
 Get offset. More...
 
 setOrderColumn ($a_order_column=0, $a_default_column=0)
 set order column public More...
 
 getOrderColumn ()
 Get order column. More...
 
 setOrderDirection ($a_order_direction)
 set order direction public More...
 
 getOrderDirection ()
 Get order direction. More...
 
 setFooter ($a_style, $a_previous=0, $a_next=0)
 set order direction 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 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 ()
 
 checkAcceptance ()
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. More...
 
 isFilterVisible ()
 Check if filter is visible: manually shown (session, db) or default value set. More...
 
 isAdvMDFilter (ilAdvancedMDRecordGUI $a_gui, $a_element)
 Check if filter element is based on adv md. More...
 
 fillRow ($a_set)
 Standard Version of Fill Row. More...
 
 getFilterValue (ilFormPropertyGUI $a_item)
 Get current filter value. More...
 
 SetFilterValue (ilFormPropertyGUI $a_item, $a_value)
 Set current filter value. More...
 
 fillMetaExcel (ilExcel $a_excel, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel (ilExcel $a_excel, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $a_set)
 Excel Version of Fill Row. More...
 
 fillMetaCSV ($a_csv)
 Add meta information to csv export. More...
 
 fillHeaderCSV ($a_csv)
 CSV Version of Fill Header. More...
 
 fillRowCSV ($a_csv, $a_set)
 CSV Version of Fill Row. More...
 

Protected Attributes

 $subscribers = array()
 
 $rep_object = null
 
 $show_subject = true
 
- 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
 

Static Protected Attributes

static $all_columns = null
 
static $has_odf_definitions = false
 

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
 

Detailed Description

GUI class for course/group subscriptions.

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

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

Constructor & Destructor Documentation

◆ __construct()

ilSubscriberTableGUI::__construct (   $a_parent_obj,
  $rep_object,
  $show_content = true,
  $show_subject = true 
)

Constructor.

public

Parameters

Definition at line 56 of file class.ilSubscriberTableGUI.php.

References $DIC, $ilCtrl, ilTableGUI\$lng, $rep_object, $show_subject, ilCourseDefinedFieldDefinition\_hasFields(), ilTable2GUI\addColumn(), ilTable2GUI\addMultiCommand(), ilTableGUI\disable(), ilTableGUI\enable(), ilTable2GUI\getId(), getRepositoryObject(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), getShowSubject(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), and setShowSubject().

57  {
58  global $DIC;
59 
60  $lng = $DIC['lng'];
61  $ilCtrl = $DIC['ilCtrl'];
62 
63  $this->lng = $lng;
64  $this->lng->loadLanguageModule('grp');
65  $this->lng->loadLanguageModule('crs');
66  $this->ctrl = $ilCtrl;
67 
68  $this->rep_object = $rep_object;
69 
71 
72  $this->setId('crs_sub_' . $this->getRepositoryObject()->getId());
73  parent::__construct($a_parent_obj, 'participants');
74 
75  $this->setFormName('subscribers');
76  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj, 'participants'));
77 
78  $this->addColumn('', 'f', "1%", true);
79  $this->addColumn($this->lng->txt('name'), 'lastname', '20%');
80 
81  $all_cols = $this->getSelectableColumns();
82  foreach ($this->getSelectedColumns() as $col) {
83  $this->addColumn(
84  $all_cols[$col]['txt'],
85  $col,
86  array_key_exists('width', $all_cols[$col]) ? $all_cols[$col]['width'] : null
87  );
88  }
89 
90 
91  if ($this->getShowSubject()) {
92  $this->addColumn($this->lng->txt('application_date'), 'sub_time', "20%");
93  $this->addColumn($this->lng->txt('subject'), 'subject', '60%');
94  } else {
95  $this->addColumn($this->lng->txt('application_date'), 'sub_time', "60%");
96  }
97 
98  $this->addColumn('', 'mail', '20%');
99 
100  if ($this->getRepositoryObject()->getType() == "sess") {
101  $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('sess_accept_request'));
102  } else {
103  $this->addMultiCommand('confirmAssignSubscribers', $this->lng->txt('assign'));
104  }
105 
106  $this->addMultiCommand('confirmRefuseSubscribers', $this->lng->txt('refuse'));
107  $this->addMultiCommand('sendMailToSelectedUsers', $this->lng->txt('crs_mem_send_mail'));
108 
109 
110  $this->setPrefix('subscribers');
111  $this->setSelectAllCheckbox('subscribers', true);
112  $this->setRowTemplate("tpl.show_subscribers_row.html", "Services/Membership");
113 
114  if ($show_content) {
115  $this->enable('sort');
116  $this->enable('header');
117  $this->enable('numinfo');
118  $this->enable('select_all');
119  } else {
120  $this->disable('content');
121  $this->disable('header');
122  $this->disable('footer');
123  $this->disable('numinfo');
124  $this->disable('select_all');
125  }
126 
127  $this->setExternalSegmentation(true);
128 
129  include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
130  self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
131  }
global $DIC
Definition: saml.php:7
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
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.
addMultiCommand($a_cmd, $a_text)
Add Command button.
enable($a_module_name)
enables particular modules of table
setPrefix($a_prefix)
getSelectedColumns()
Get selected columns.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
static _hasFields($a_container_id)
Check if there are any define fields.
getSelectableColumns()
Get selectable columns.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
disable($a_module_name)
diesables particular modules of table
setFormName($a_formname="")
Set Form name.
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.
getId()
Get element id.
+ Here is the call graph for this function:

Member Function Documentation

◆ checkAcceptance()

ilSubscriberTableGUI::checkAcceptance ( )
protected

Definition at line 442 of file class.ilSubscriberTableGUI.php.

Referenced by readSubscriberData().

443  {
444  return true;
445  }
+ Here is the caller graph for this function:

◆ fillRow()

ilSubscriberTableGUI::fillRow (   $a_set)

fill row

public

Parameters

Definition at line 183 of file class.ilSubscriberTableGUI.php.

References $DIC, $ilUser, ilTableGUI\$prefix, ilObjCourseGrouping\_checkGroupingDependencies(), ilObject\_lookupTitle(), ilDatePresentation\formatDate(), ilObjCourseGrouping\getAssignedObjects(), getRepositoryObject(), ilTable2GUI\getSelectedColumns(), getShowSubject(), IL_CAL_DATE, IL_CAL_UNIX, and showActionLinks().

184  {
185  global $DIC;
186 
187  $ilUser = $DIC['ilUser'];
188 
189 
190  include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
193  $prefix = $this->getRepositoryObject()->getType();
194  $this->tpl->setVariable(
195  'ALERT_MSG',
196  sprintf(
197  $this->lng->txt($prefix . '_lim_assigned'),
198  ilObject::_lookupTitle(current($ids))
199  )
200  );
201  }
202 
203  $this->tpl->setVariable('VAL_ID', $a_set['usr_id']);
204  $this->tpl->setVariable('VAL_NAME', $a_set['lastname'] . ', ' . $a_set['firstname']);
205 
206  foreach ($this->getSelectedColumns() as $field) {
207  switch ($field) {
208  case 'gender':
209  $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
210  $this->tpl->setCurrentBlock('custom_fields');
211  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
212  $this->tpl->parseCurrentBlock();
213  break;
214 
215  case 'birthday':
216  $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
217  $this->tpl->setCurrentBlock('custom_fields');
218  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
219  $this->tpl->parseCurrentBlock();
220  break;
221 
222  case 'odf_last_update':
223  $this->tpl->setVariable('VAL_CUST', (string) $a_set['odf_info_txt']);
224  break;
225 
226  case 'org_units':
227  $this->tpl->setCurrentBlock('custom_fields');
228  include_once './Modules/OrgUnit/classes/PathStorage/class.ilOrgUnitPathStorage.php';
229  $this->tpl->setVariable('VAL_CUST', (string) ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($a_set['usr_id']));
230  $this->tpl->parseCurrentBlock();
231  break;
232 
233  default:
234  $this->tpl->setCurrentBlock('custom_fields');
235  $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
236  $this->tpl->parseCurrentBlock();
237  break;
238  }
239  }
240 
241 
242  $this->tpl->setVariable('VAL_SUBTIME', ilDatePresentation::formatDate(new ilDateTime($a_set['sub_time'], IL_CAL_UNIX)));
243 
244 
245  $this->showActionLinks($a_set);
246 
247 
248  if ($this->getShowSubject()) {
249  if (strlen($a_set['subject'])) {
250  $this->tpl->setCurrentBlock('subject');
251  $this->tpl->setVariable('VAL_SUBJECT', '"' . $a_set['subject'] . '"');
252  $this->tpl->parseCurrentBlock();
253  } else {
254  $this->tpl->touchBlock('subject');
255  }
256  }
257  }
global $DIC
Definition: saml.php:7
static getAssignedObjects()
Alway call checkGroupingDependencies before.
static _lookupTitle($a_id)
lookup object title
const IL_CAL_UNIX
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
showActionLinks($a_set)
Show action links (mail ; edit crs|grp data)
Class for single dates.
Date and time handling
$ilUser
Definition: imgupload.php:18
getSelectedColumns()
Get selected columns.
static _checkGroupingDependencies(&$container_obj, $a_user_id=null)
const IL_CAL_DATE
+ Here is the call graph for this function:

◆ getRepositoryObject()

ilSubscriberTableGUI::getRepositoryObject ( )
protected
Returns
ilObject

Definition at line 136 of file class.ilSubscriberTableGUI.php.

References $rep_object.

Referenced by __construct(), fillRow(), getSelectableColumns(), readSubscriberData(), and showActionLinks().

137  {
138  return $this->rep_object;
139  }
+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilSubscriberTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

Definition at line 145 of file class.ilSubscriberTableGUI.php.

References ilExportFieldsInfo\_getInstanceByType(), ilTable2GUI\getId(), and getRepositoryObject().

Referenced by __construct().

146  {
147  if (self::$all_columns) {
148  return self::$all_columns;
149  }
150 
151  if ($this->getRepositoryObject()->getType() == 'sess') {
152  self::$all_columns['login'] = [
153  'txt' => $this->lng->txt('login'),
154  'width' => '15%',
155  'default' => 1
156  ];
157  return self::$all_columns;
158  }
159 
160 
161  include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
163  self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
164 
165  // #25215
166  if (
167  is_array(self::$all_columns) &&
168  array_key_exists('consultation_hour', self::$all_columns)
169  ) {
170  unset(self::$all_columns['consultation_hour']);
171  }
172  return self::$all_columns;
173  }
static _getInstanceByType($a_type)
Get Singleton Instance.
getId()
Get element id.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getShowSubject()

ilSubscriberTableGUI::getShowSubject ( )

Definition at line 452 of file class.ilSubscriberTableGUI.php.

References $show_subject.

Referenced by __construct(), and fillRow().

+ Here is the caller graph for this function:

◆ readSubscriberData()

ilSubscriberTableGUI::readSubscriberData ( array  $a_subscriber_ids)

read data

protected

Parameters
int[]subscriber ids
Returns

Definition at line 302 of file class.ilSubscriberTableGUI.php.

References ilTableGUI\$data, $GLOBALS, $name, $user, ilPrivacySettings\_getInstance(), ilCourseUserData\_getValuesByObjId(), ilObjUser\_lookupName(), checkAcceptance(), ilTable2GUI\determineOffsetAndOrder(), ilDatePresentation\formatDate(), ilTable2GUI\getId(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\getParentObject(), getRepositoryObject(), ilTable2GUI\getSelectedColumns(), ilUserQuery\getUserListData(), IL_CAL_UNIX, ilUserDefinedData\lookupData(), ilObjectCustomUserFieldHistory\lookupEntriesByObjectId(), ilParticipants\lookupSubscribersData(), ilTable2GUI\setData(), and ilTableGUI\setMaxCount().

303  {
304  $subscriber_data = ilParticipants::lookupSubscribersData($this->getRepositoryObject()->getId());
305  $sub_ids = [];
306  foreach ($a_subscriber_ids as $usr_id) {
307  $sub_ids[] = $usr_id;
308  $sub_data[$usr_id] = $subscriber_data[$usr_id];
309  }
310 
311  $this->determineOffsetAndOrder();
312 
313  include_once './Services/User/classes/class.ilUserQuery.php';
314 
315  $additional_fields = $this->getSelectedColumns();
316  unset($additional_fields["firstname"]);
317  unset($additional_fields["lastname"]);
318  unset($additional_fields["last_login"]);
319  unset($additional_fields["access_until"]);
320  unset($additional_fields['org_units']);
321 
322  $udf_ids = $usr_data_fields = $odf_ids = array();
323  foreach ($additional_fields as $field) {
324  if (substr($field, 0, 3) == 'udf') {
325  $udf_ids[] = substr($field, 4);
326  continue;
327  }
328  if (substr($field, 0, 3) == 'odf') {
329  $odf_ids[] = substr($field, 4);
330  continue;
331  }
332 
333  $usr_data_fields[] = $field;
334  }
335 
336  $usr_data = ilUserQuery::getUserListData(
337  $this->getOrderField(),
338  $this->getOrderDirection(),
339  $this->getOffset(),
340  $this->getLimit(),
341  '',
342  '',
343  null,
344  false,
345  false,
346  0,
347  0,
348  null,
349  $usr_data_fields,
350  $sub_ids
351  );
352 
353  foreach ((array) $usr_data['set'] as $user) {
354  $usr_ids[] = $user['usr_id'];
355  }
356 
357  // merge course data
358  $course_user_data = $this->getParentObject()->readMemberData($usr_ids, array());
359  $a_user_data = array();
360  foreach ((array) $usr_data['set'] as $ud) {
361  $a_user_data[$ud['usr_id']] = array_merge($ud, (array) $course_user_data[$ud['usr_id']]);
362  }
363 
364  // Custom user data fields
365  if ($udf_ids) {
366  include_once './Services/User/classes/class.ilUserDefinedData.php';
367  $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
368  foreach ($data as $usr_id => $fields) {
369  if (!$this->checkAcceptance($usr_id)) {
370  continue;
371  }
372 
373  foreach ($fields as $field_id => $value) {
374  $a_user_data[$usr_id]['udf_' . $field_id] = $value;
375  }
376  }
377  }
378  // Object specific user data fields
379  if ($odf_ids) {
380  include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
382  foreach ($data as $usr_id => $fields) {
383  // #7264: as we get data for all course members filter against user data
384  if (!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids)) {
385  continue;
386  }
387 
388  foreach ($fields as $field_id => $value) {
389  $a_user_data[$usr_id]['odf_' . $field_id] = $value;
390  }
391  }
392 
393  // add last edit date
394  include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
395  foreach (ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getRepositoryObject()->getId()) as $usr_id => $edit_info) {
396  if (!isset($a_user_data[$usr_id])) {
397  continue;
398  }
399 
400  include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
401  if ($usr_id == $edit_info['update_user']) {
402  $a_user_data[$usr_id]['odf_last_update'] = '';
403  $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['DIC']['lng']->txt('cdf_edited_by_self');
404  if (ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getRepositoryObject()->getType())) {
405  $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
406  $a_user_data[$usr_id]['odf_info_txt'] .= (', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
407  }
408  } else {
409  $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
410  $a_user_data[$usr_id]['odf_last_update'] .= ('_' . $edit_info['editing_time']->get(IL_CAL_UNIX));
411 
412  $name = ilObjUser::_lookupName($edit_info['update_user']);
413  $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'] . ' ' . $name['lastname'] . ', ' . ilDatePresentation::formatDate($edit_info['editing_time']));
414  }
415  }
416  }
417 
418  foreach ($usr_data['set'] as $user) {
419  // Check acceptance
420  if (!$this->checkAcceptance($user['usr_id'])) {
421  continue;
422  }
423  // DONE: accepted
424  foreach ($usr_data_fields as $field) {
425  $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
426  }
427  }
428 
429  // Waiting list subscription
430  foreach ($sub_data as $usr_id => $usr_data) {
431  if (!in_array($usr_id, $usr_ids)) {
432  continue;
433  }
434  $a_user_data[$usr_id]['sub_time'] = $usr_data['time'];
435  $a_user_data[$usr_id]['subject'] = $usr_data['subject'];
436  }
437 
438  $this->setMaxCount(count($sub_ids));
439  return $this->setData($a_user_data);
440  }
static _lookupName($a_user_id)
lookup user name
static _getValuesByObjId($a_obj_id)
Get values by obj_id (for all users)
const IL_CAL_UNIX
getOrderDirection()
Get order direction.
static formatDate(ilDateTime $date, $a_skip_day=false, $a_include_wd=false, $include_seconds=false)
Format a date public.
getParentObject()
Get parent object.
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
getOffset()
Get offset.
getSelectedColumns()
Get selected columns.
$user
Definition: migrateto20.php:57
static lookupSubscribersData($a_obj_id)
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
static _getInstance()
Get instance of ilPrivacySettings.
setMaxCount($a_max_count)
set max.
getId()
Get element id.
static lookupEntriesByObjectId($a_obj_id)
Get entries by obj_id type $ilDB.
static getUserListData( $a_order_field, $a_order_dir, $a_offset, $a_limit, $a_string_filter="", $a_activation_filter="", $a_last_login_filter=null, $a_limited_access_filter=false, $a_no_courses_filter=false, $a_course_group_filter=0, $a_role_filter=0, $a_user_folder_filter=null, $a_additional_fields='', $a_user_filter=null, $a_first_letter="", $a_authentication_filter=null)
Get data for user administration list.
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.
+ Here is the call graph for this function:

◆ setShowSubject()

ilSubscriberTableGUI::setShowSubject (   $a_value)

Definition at line 447 of file class.ilSubscriberTableGUI.php.

Referenced by __construct().

448  {
449  $this->show_subject = (bool) $a_value;
450  }
+ Here is the caller graph for this function:

◆ showActionLinks()

ilSubscriberTableGUI::showActionLinks (   $a_set)

Show action links (mail ; edit crs|grp data)

Parameters
type$a_set

Definition at line 263 of file class.ilSubscriberTableGUI.php.

References $list, ilTable2GUI\getId(), ilTable2GUI\getParentObject(), and getRepositoryObject().

Referenced by fillRow().

264  {
265  if (!self::$has_odf_definitions) {
266  $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
267  $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
268  $this->tpl->setVariable('MAIL_LINK', $link);
269  $this->tpl->setVariable('MAIL_TITLE', $this->lng->txt('crs_mem_send_mail'));
270  return true;
271  }
272 
273  // show action menu
274  include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
276  $list->setSelectionHeaderClass('small');
277  $list->setItemLinkClass('small');
278  $list->setId('actl_' . $a_set['usr_id'] . '_' . $this->getId());
279  $list->setListTitle($this->lng->txt('actions'));
280 
281  $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
282  $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
283  $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_mem_send_mail');
284  $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
285  $list->addItem($trans, '', $link, 'sendMailToSelectedUsers');
286 
287  $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui', 'member_id', $a_set['usr_id']);
288  $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_cdf_edit_member');
289  $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui', 'editMember'));
290 
291  $this->tpl->setVariable('ACTION_USER', $list->getHTML());
292  }
if(isset($_REQUEST['delete'])) $list
Definition: registry.php:41
getParentObject()
Get parent object.
User interface class for advanced drop-down selection lists.
getId()
Get element id.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $all_columns

ilSubscriberTableGUI::$all_columns = null
staticprotected

Definition at line 44 of file class.ilSubscriberTableGUI.php.

◆ $has_odf_definitions

ilSubscriberTableGUI::$has_odf_definitions = false
staticprotected

Definition at line 45 of file class.ilSubscriberTableGUI.php.

◆ $rep_object

ilSubscriberTableGUI::$rep_object = null
protected

Definition at line 42 of file class.ilSubscriberTableGUI.php.

Referenced by __construct(), and getRepositoryObject().

◆ $show_subject

ilSubscriberTableGUI::$show_subject = true
protected

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

Referenced by __construct(), and getShowSubject().

◆ $subscribers

ilSubscriberTableGUI::$subscribers = array()
protected

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


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