ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f870
All Data Structures Namespaces Files Functions Variables Modules Pages
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, $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 ()
 read data More...
 
 setShowSubject ($a_value)
 
 getShowSubject ()
 
- Public Member Functions inherited from ilTable2GUI
 __construct ($a_parent_obj, $a_parent_cmd="", $a_template_context="")
 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)
 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...
 
 clearCommandButtons ()
 
 addCommandButton ($a_cmd, $a_text, $a_onclick='', $a_id="", $a_class=null)
 Add Command button. More...
 
 addCommandButtonInstance (ilButton $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="")
 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...
 
- Public Member Functions inherited from ilTableGUI
 ilTableGUI ($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

 checkAcceptance ()
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($worksheet, &$a_row)
 Add meta information to excel export. More...
 
 fillHeaderExcel ($worksheet, &$a_row)
 Excel Version of Fill Header. More...
 
 fillRowExcel ($a_worksheet, &$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()
 
 $show_subject = true
 
- Protected Attributes inherited from ilTable2GUI
 $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 = null
 
 $disable_filter_hiding = false
 
 $selected_filter = false
 
 $top_commands = true
 
 $selectable_columns = array()
 
 $selected_column = array()
 
 $show_templates = false
 
 $show_rows_selector = true
 
 $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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

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 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,
  $show_content = true,
  $show_subject = true 
)

Constructor.

public

Parameters

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

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

52  {
53  global $lng,$ilCtrl;
54 
55  $this->lng = $lng;
56  $this->lng->loadLanguageModule('grp');
57  $this->lng->loadLanguageModule('crs');
58  $this->ctrl = $ilCtrl;
59 
61 
62  $this->setId('crs_sub_'. $a_parent_obj->object->getId());
63  parent::__construct($a_parent_obj,'members');
64 
65  $this->setFormName('subscribers');
66  $this->setFormAction($this->ctrl->getFormAction($a_parent_obj,'members'));
67 
68  $this->addColumn('','f',"1");
69  $this->addColumn($this->lng->txt('name'),'lastname','20%');
70 
71  $all_cols = $this->getSelectableColumns();
72  foreach($this->getSelectedColumns() as $col)
73  {
74  $this->addColumn($all_cols[$col]['txt'], $col);
75  }
76 
77  $this->addColumn($this->lng->txt('application_date'),'sub_time',"10%");
78 
79  if($this->getShowSubject())
80  $this->addColumn($this->lng->txt('subject'),'subject','15%');
81 
82  $this->addColumn('','mail','10%');
83 
84  $this->addMultiCommand('confirmAssignSubscribers',$this->lng->txt('assign'));
85  $this->addMultiCommand('confirmRefuseSubscribers',$this->lng->txt('refuse'));
86  $this->addMultiCommand('sendMailToSelectedUsers',$this->lng->txt('crs_mem_send_mail'));
87 
88 
89  $this->setPrefix('subscribers');
90  $this->setSelectAllCheckbox('subscribers');
91  $this->setRowTemplate("tpl.show_subscribers_row.html","Services/Membership");
92 
93  if($show_content)
94  {
95  $this->enable('sort');
96  $this->enable('header');
97  $this->enable('numinfo');
98  $this->enable('select_all');
99  }
100  else
101  {
102  $this->disable('content');
103  $this->disable('header');
104  $this->disable('footer');
105  $this->disable('numinfo');
106  $this->disable('select_all');
107  }
108 
109  $this->setExternalSegmentation(true);
110 
111  include_once('Modules/Course/classes/Export/class.ilCourseDefinedFieldDefinition.php');
112  self::$has_odf_definitions = ilCourseDefinedFieldDefinition::_hasFields($this->getParentObject()->object->getId());
113 
114  }
setFormName($a_formname)
Set Form name.
setExternalSegmentation($a_val)
Set external segmentation.
getParentObject()
Get parent object.
setId($a_val)
Set id.
global $ilCtrl
Definition: ilias.php:18
addColumn($a_text, $a_sort_field="", $a_width="", $a_is_checkbox_action_column=false, $a_class="", $a_tooltip="")
Add a column to the header.
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
global $lng
Definition: privfeed.php:40
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
+ Here is the call graph for this function:

Member Function Documentation

◆ checkAcceptance()

ilSubscriberTableGUI::checkAcceptance ( )
protected

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

Referenced by readSubscriberData().

428  {
429  return true;
430  }
+ Here is the caller graph for this function:

◆ fillRow()

ilSubscriberTableGUI::fillRow (   $a_set)

fill row

public

Parameters

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

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

142  {
143  global $ilUser;
144 
145 
146  include_once './Modules/Course/classes/class.ilObjCourseGrouping.php';
147  if(!ilObjCourseGrouping::_checkGroupingDependencies($this->getParentObject()->object,$a_set['usr_id']) and
149  {
150  $prefix = $this->getParentObject()->object->getType();
151  $this->tpl->setVariable('ALERT_MSG',
152  sprintf($this->lng->txt($prefix.'_lim_assigned'),
153  ilObject::_lookupTitle(current($ids))
154  ));
155 
156  }
157 
158  $this->tpl->setVariable('VAL_ID',$a_set['usr_id']);
159  $this->tpl->setVariable('VAL_NAME',$a_set['lastname'].', '.$a_set['firstname']);
160 
161  foreach($this->getSelectedColumns() as $field)
162  {
163  switch($field)
164  {
165  case 'gender':
166  $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
167  $this->tpl->setCurrentBlock('custom_fields');
168  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
169  $this->tpl->parseCurrentBlock();
170  break;
171 
172  case 'birthday':
173  $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
174  $this->tpl->setCurrentBlock('custom_fields');
175  $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
176  $this->tpl->parseCurrentBlock();
177  break;
178 
179  case 'odf_last_update':
180  $this->tpl->setVariable('VAL_CUST',(string) $a_set['odf_info_txt']);
181  break;
182 
183 
184  default:
185  $this->tpl->setCurrentBlock('custom_fields');
186  $this->tpl->setVariable('VAL_CUST', isset($a_set[$field]) ? (string) $a_set[$field] : '');
187  $this->tpl->parseCurrentBlock();
188  break;
189  }
190  }
191 
192 
193  $this->tpl->setVariable('VAL_SUBTIME',ilDatePresentation::formatDate(new ilDateTime($a_set['sub_time'],IL_CAL_UNIX)));
194 
195 
196  $this->showActionLinks($a_set);
197 
198 
199  if($this->getShowSubject())
200  {
201 
202  if(strlen($a_set['subject']))
203  {
204  $this->tpl->setCurrentBlock('subject');
205  $this->tpl->setVariable('VAL_SUBJECT','"'.$a_set['subject'].'"');
206  $this->tpl->parseCurrentBlock();
207  }
208  else
209  {
210  $this->tpl->touchBlock('subject');
211  }
212 
213  }
214  }
static getAssignedObjects()
Alway call checkGroupingDependencies before.
static _lookupTitle($a_id)
lookup object title
const IL_CAL_UNIX
getParentObject()
Get parent object.
showActionLinks($a_set)
Show action links (mail ; edit crs|grp data)
Class for single dates.
static formatDate(ilDateTime $date)
Format a date public.
Date and time handling
getSelectedColumns()
Get selected columns.
_checkGroupingDependencies(&$container_obj, $a_user_id=null)
const IL_CAL_DATE
global $ilUser
Definition: imgupload.php:15
+ Here is the call graph for this function:

◆ getSelectableColumns()

ilSubscriberTableGUI::getSelectableColumns ( )

Get selectable columns.

Returns

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

References ilExportFieldsInfo\_getInstanceByType(), and ilTable2GUI\getParentObject().

Referenced by __construct().

121  {
122  if(self::$all_columns)
123  {
124  return self::$all_columns;
125  }
126 
127  include_once './Services/PrivacySecurity/classes/class.ilExportFieldsInfo.php';
128  $ef = ilExportFieldsInfo::_getInstanceByType($this->getParentObject()->object->getType());
129  self::$all_columns = $ef->getSelectableFieldsInfo($this->getParentObject()->object->getId());
130  return self::$all_columns;
131  }
getParentObject()
Get parent object.
static _getInstanceByType($a_type)
Get Singleton Instance.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getShowSubject()

ilSubscriberTableGUI::getShowSubject ( )

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

References $show_subject.

Referenced by __construct(), and fillRow().

+ Here is the caller graph for this function:

◆ readSubscriberData()

ilSubscriberTableGUI::readSubscriberData ( )

read data

protected

Parameters

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

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

262  {
263  include_once './Services/Membership/classes/class.ilParticipants.php';
264 
265  $sub_data = ilParticipants::lookupSubscribersData($this->getParentObject()->object->getId());
266 
267  $sub_ids = array();
268  foreach($sub_data as $usr_id => $usr_data)
269  {
270  $sub_ids[] = $usr_id;
271  }
272 
273  $this->determineOffsetAndOrder();
274 
275  include_once './Services/User/classes/class.ilUserQuery.php';
276 
277  $additional_fields = $this->getSelectedColumns();
278  unset($additional_fields["firstname"]);
279  unset($additional_fields["lastname"]);
280  unset($additional_fields["last_login"]);
281  unset($additional_fields["access_until"]);
282 
283  $udf_ids = $usr_data_fields = $odf_ids = array();
284  foreach($additional_fields as $field)
285  {
286  if(substr($field, 0, 3) == 'udf')
287  {
288  $udf_ids[] = substr($field, 4);
289  continue;
290  }
291  if(substr($field, 0, 3) == 'odf')
292  {
293  $odf_ids[] = substr($field, 4);
294  continue;
295  }
296 
297  $usr_data_fields[] = $field;
298  }
299 
300  $usr_data = ilUserQuery::getUserListData(
301  $this->getOrderField(),
302  $this->getOrderDirection(),
303  $this->getOffset(),
304  $this->getLimit(),
305  '',
306  '',
307  null,
308  false,
309  false,
310  0,
311  0,
312  null,
313  $usr_data_fields,
314  $sub_ids
315  );
316 
317  foreach((array) $usr_data['set'] as $user)
318  {
319  $usr_ids[] = $user['usr_id'];
320  }
321 
322  // merge course data
323  $course_user_data = $this->getParentObject()->readMemberData($usr_ids,$this->type == 'admin');
324  $a_user_data = array();
325  foreach((array) $usr_data['set'] as $ud)
326  {
327  $a_user_data[$ud['usr_id']] = array_merge($ud,(array) $course_user_data[$ud['usr_id']]);
328  }
329 
330  // Custom user data fields
331  if($udf_ids)
332  {
333  include_once './Services/User/classes/class.ilUserDefinedData.php';
334  $data = ilUserDefinedData::lookupData($usr_ids, $udf_ids);
335  foreach($data as $usr_id => $fields)
336  {
337  if(!$this->checkAcceptance($usr_id))
338  {
339  continue;
340  }
341 
342  foreach($fields as $field_id => $value)
343  {
344  $a_user_data[$usr_id]['udf_' . $field_id] = $value;
345  }
346  }
347  }
348  // Object specific user data fields
349  if($odf_ids)
350  {
351  include_once './Modules/Course/classes/Export/class.ilCourseUserData.php';
352  $data = ilCourseUserData::_getValuesByObjId($this->getParentObject()->object->getId());
353  foreach($data as $usr_id => $fields)
354  {
355  // #7264: as we get data for all course members filter against user data
356  if(!$this->checkAcceptance($usr_id) || !in_array($usr_id, $usr_ids))
357  {
358  continue;
359  }
360 
361  foreach($fields as $field_id => $value)
362  {
363  $a_user_data[$usr_id]['odf_' . $field_id] = $value;
364  }
365  }
366 
367  // add last edit date
368  include_once './Services/Membership/classes/class.ilObjectCustomUserFieldHistory.php';
369  foreach(ilObjectCustomUserFieldHistory::lookupEntriesByObjectId($this->getParentObject()->object->getId()) as $usr_id => $edit_info)
370  {
371  if(!isset($a_user_data[$usr_id]))
372  {
373  continue;
374  }
375 
376  include_once './Services/PrivacySecurity/classes/class.ilPrivacySettings.php';
377  if($usr_id == $edit_info['update_user'])
378  {
379  $a_user_data[$usr_id]['odf_last_update'] = '';
380  $a_user_data[$usr_id]['odf_info_txt'] = $GLOBALS['lng']->txt('cdf_edited_by_self');
381  if(ilPrivacySettings::_getInstance()->enabledAccessTimesByType($this->getParentObject()->object->getType()))
382  {
383  $a_user_data[$usr_id]['odf_last_update'] .= ('_'.$edit_info['editing_time']->get(IL_CAL_UNIX));
384  $a_user_data[$usr_id]['odf_info_txt'] .= (', '.ilDatePresentation::formatDate($edit_info['editing_time']));
385  }
386  }
387  else
388  {
389  $a_user_data[$usr_id]['odf_last_update'] = $edit_info['update_user'];
390  $a_user_data[$usr_id]['odf_last_update'] .= ('_'.$edit_info['editing_time']->get(IL_CAL_UNIX));
391 
392  $name = ilObjUser::_lookupName($edit_info['update_user']);
393  $a_user_data[$usr_id]['odf_info_txt'] = ($name['firstname'].' '.$name['lastname'].', '.ilDatePresentation::formatDate($edit_info['editing_time']));
394  }
395  }
396  }
397 
398  foreach($usr_data['set'] as $user)
399  {
400  // Check acceptance
401  if(!$this->checkAcceptance($user['usr_id']))
402  {
403  continue;
404  }
405  // DONE: accepted
406  foreach($usr_data_fields as $field)
407  {
408  $a_user_data[$user['usr_id']][$field] = $user[$field] ? $user[$field] : '';
409  }
410  }
411 
412  // Waiting list subscription
413  foreach($sub_data as $usr_id => $usr_data)
414  {
415  if(!in_array($usr_id, $usr_ids))
416  {
417  continue;
418  }
419  $a_user_data[$usr_id]['sub_time'] = $usr_data['time'];
420  $a_user_data[$usr_id]['subject'] = $usr_data['subject'];
421  }
422 
423  $this->setMaxCount(count($sub_ids));
424  return $this->setData($a_user_data);
425  }
static _lookupName($a_user_id)
lookup user name
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="")
Get data for user administration list.
static _getValuesByObjId($a_obj_id)
Get values by obj_id (for all users)
const IL_CAL_UNIX
getOrderDirection()
Get order direction.
getParentObject()
Get parent object.
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
$GLOBALS['ct_recipient']
getOffset()
Get offset.
static formatDate(ilDateTime $date)
Format a date public.
getSelectedColumns()
Get selected columns.
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.
static lookupEntriesByObjectId($a_obj_id)
Get entries by obj_id type $ilDB.
+ Here is the call graph for this function:

◆ setShowSubject()

ilSubscriberTableGUI::setShowSubject (   $a_value)

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

Referenced by __construct().

433  {
434  $this->show_subject = (bool)$a_value;
435  }
+ 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 220 of file class.ilSubscriberTableGUI.php.

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

Referenced by fillRow().

221  {
222  if(!self::$has_odf_definitions)
223  {
224  $this->ctrl->setParameterByClass(get_class($this->getParentObject()),'member_id',$a_set['usr_id']);
225  $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()),'sendMailToSelectedUsers');
226  $this->tpl->setVariable('MAIL_LINK',$link);
227  $this->tpl->setVariable('MAIL_TITLE',$this->lng->txt('crs_mem_send_mail'));
228  return TRUE;
229  }
230 
231  // show action menu
232  include_once './Services/UIComponent/AdvancedSelectionList/classes/class.ilAdvancedSelectionListGUI.php';
233  $list = new ilAdvancedSelectionListGUI();
234  $list->setSelectionHeaderClass('small');
235  $list->setItemLinkClass('small');
236  $list->setId('actl_'.$a_set['usr_id'].'_'.$this->getId());
237  $list->setListTitle($this->lng->txt('actions'));
238 
239  $this->ctrl->setParameterByClass(get_class($this->getParentObject()),'member_id',$a_set['usr_id']);
240  $this->ctrl->setParameter($this->parent_obj, 'member_id', $a_set['usr_id']);
241  $trans = $this->lng->txt($this->getParentObject()->object->getType().'_mem_send_mail');
242  $link = $this->ctrl->getLinkTargetByClass(get_class($this->getParentObject()),'sendMailToSelectedUsers');
243  $list->addItem($trans, '', $link,'sendMailToSelectedUsers');
244 
245  $this->ctrl->setParameterByClass('ilobjectcustomuserfieldsgui','member_id',$a_set['usr_id']);
246  $trans = $this->lng->txt($this->getParentObject()->object->getType().'_cdf_edit_member');
247  $list->addItem($trans, '', $this->ctrl->getLinkTargetByClass('ilobjectcustomuserfieldsgui','editMember'));
248 
249  $this->tpl->setVariable('ACTION_USER',$list->getHTML());
250 
251  }
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 39 of file class.ilSubscriberTableGUI.php.

◆ $has_odf_definitions

ilSubscriberTableGUI::$has_odf_definitions = FALSE
staticprotected

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

◆ $show_subject

ilSubscriberTableGUI::$show_subject = true
protected

Definition at line 41 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: