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

Protected Member Functions

 getRepositoryObject ()
 
 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.

@access public

Parameters

return

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

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 // begin-patch clipboard
110 $this->lng->loadLanguageModule('user');
111 $this->addMultiCommand('addToClipboard', $this->lng->txt('clipboard_add_btn'));
112 // end-patch clipboard
113
114
115 $this->setPrefix('subscribers');
116 $this->setSelectAllCheckbox('subscribers', true);
117 $this->setRowTemplate("tpl.show_subscribers_row.html", "Services/Membership");
118
119 if ($show_content) {
120 $this->enable('sort');
121 $this->enable('header');
122 $this->enable('numinfo');
123 $this->enable('select_all');
124 } else {
125 $this->disable('content');
126 $this->disable('header');
127 $this->disable('footer');
128 $this->disable('numinfo');
129 $this->disable('select_all');
130 }
131
132 $this->setExternalSegmentation(true);
133
134 include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
135 self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getRepositoryObject()->getId());
136 }
static _hasFields($a_container_id)
Check if there are any define fields.
getSelectableColumns()
Get selectable columns.
getSelectedColumns()
Get selected columns.
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...
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.
getId()
Get element id.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
addMultiCommand($a_cmd, $a_text)
Add Command button.
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.
setExternalSegmentation($a_val)
Set external segmentation.
setId($a_val)
Set id.
setFormName($a_formname="")
Set Form name.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
disable($a_module_name)
diesables particular modules of table
enable($a_module_name)
enables particular modules of table
global $ilCtrl
Definition: ilias.php:18
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
$DIC
Definition: xapitoken.php:46

References $DIC, $ilCtrl, ilTableGUI\$lng, $rep_object, $show_subject, ILIAS\GlobalScreen\Provider\__construct(), 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().

+ Here is the call graph for this function:

Member Function Documentation

◆ checkAcceptance()

ilSubscriberTableGUI::checkAcceptance ( )
protected

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

448 {
449 return true;
450 }

Referenced by readSubscriberData().

+ Here is the caller graph for this function:

◆ fillRow()

ilSubscriberTableGUI::fillRow (   $a_set)

fill row

@access public

Parameters

return

Reimplemented from ilTable2GUI.

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

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

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().

+ Here is the call graph for this function:

◆ getRepositoryObject()

ilSubscriberTableGUI::getRepositoryObject ( )
protected
Returns
ilObject

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

142 {
143 return $this->rep_object;
144 }

References $rep_object.

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

+ Here is the caller graph for this function:

◆ getSelectableColumns()

ilSubscriberTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

Reimplemented from ilTable2GUI.

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

151 {
152 if (self::$all_columns) {
153 return self::$all_columns;
154 }
155
156 if ($this->getRepositoryObject()->getType() == 'sess') {
157 self::$all_columns['login'] = [
158 'txt' => $this->lng->txt('login'),
159 'width' => '15%',
160 'default' => 1
161 ];
162 return self::$all_columns;
163 }
164
165
166 include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
168 self::$all_columns = $ef->getSelectableFieldsInfo($this->getRepositoryObject()->getId());
169
170 // #25215
171 if (
172 is_array(self::$all_columns) &&
173 array_key_exists('consultation_hour', self::$all_columns)
174 ) {
175 unset(self::$all_columns['consultation_hour']);
176 }
177 return self::$all_columns;
178 }
static _getInstanceByType($a_type)
Get Singleton Instance.

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

Referenced by __construct().

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

◆ getShowSubject()

ilSubscriberTableGUI::getShowSubject ( )

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

458 {
459 return $this->show_subject;
460 }

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

@access protected

Parameters
int[]subscriber ids
Returns

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

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

References ilTableGUI\$data, $GLOBALS, $name, 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().

+ Here is the call graph for this function:

◆ setShowSubject()

ilSubscriberTableGUI::setShowSubject (   $a_value)

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

453 {
454 $this->show_subject = (bool) $a_value;
455 }

Referenced by __construct().

+ 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 268 of file class.ilSubscriberTableGUI.php.

269 {
270 if (!self::$has_odf_definitions) {
271 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
272 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
273 $this->tpl->setVariable('MAIL_LINK', $link);
274 $this->tpl->setVariable('MAIL_TITLE', $this->lng->txt('crs_mem_send_mail'));
275 return true;
276 }
277
278 // show action menu
279 include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
280 $list = new ilAdvancedSelectionListGUI();
281 $list->setSelectionHeaderClass('small');
282 $list->setItemLinkClass('small');
283 $list->setId('actl_' . $a_set['usr_id'] . '_' . $this->getId());
284 $list->setListTitle($this->lng->txt('actions'));
285
286 $this->ctrl->setParameterByClass(get_class($this->getParentObject()), 'member_id', $a_set['usr_id']);
287 $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
288 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_mem_send_mail');
289 $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()), 'sendMailToSelectedUsers');
290 $list->addItem($trans, '', $link, 'sendMailToSelectedUsers');
291
292 $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui', 'member_id', $a_set['usr_id']);
293 $trans = $this->lng->txt($this->getRepositoryObject()->getType() . '_cdf_edit_member');
294 $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui', 'editMember'));
295
296 $this->tpl->setVariable('ACTION_USER', $list->getHTML());
297 }
User interface class for advanced drop-down selection lists.

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

Referenced by fillRow().

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

Referenced by getSelectableColumns().

◆ $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: