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

Class ilMStListUsersTableGUI. More...

+ Inheritance diagram for ilMStListUsersTableGUI:
+ Collaboration diagram for ilMStListUsersTableGUI:

Public Member Functions

 __construct (ilMStListUsersGUI $parent_obj, $parent_cmd=ilMStListUsersGUI::CMD_INDEX)
 
 initFilter ()
 
 getSelectableColumns ()
 
 fillRow ($my_staff_user)
 
- 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

 parseData ()
 
 fillRowExcel (ilExcel $a_excel, &$a_row, $my_staff_user)
 
 fillRowCSV ($a_csv, $my_staff_user)
 
 getFieldValuesForExport (ilMStListUser $my_staff_user)
 
- 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

 $filter = array()
 
 $access
 
- 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
 

Private Member Functions

 addColumns ()
 
 getProfileBackUrl ()
 Get profile back url. More...
 

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

Constructor & Destructor Documentation

◆ __construct()

ilMStListUsersTableGUI::__construct ( ilMStListUsersGUI  $parent_obj,
  $parent_cmd = ilMStListUsersGUI::CMD_INDEX 
)
Parameters
ilMStListUsersGUI$parent_obj
string$parent_cmd

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

References $DIC, ilTable2GUI\$parent_cmd, addColumns(), ilMyStaffAccess\getInstance(), initFilter(), parseData(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDisableFilterHiding(), ilTable2GUI\setEnableNumInfo(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExportFormats(), ilTable2GUI\setFilterCols(), ilTable2GUI\setFormAction(), ilTable2GUI\setFormName(), ilTable2GUI\setId(), ilTable2GUI\setPrefix(), ilTable2GUI\setRowTemplate(), and ilTable2GUI\setShowRowsSelector().

26  {
27  global $DIC;
28 
29  $this->access = ilMyStaffAccess::getInstance();
30 
31  $this->setPrefix('myst_lu');
32  $this->setFormName('myst_lu');
33  $this->setId('myst_lu');
34 
35  parent::__construct($parent_obj, $parent_cmd, '');
36 
37  $this->setRowTemplate('tpl.list_users_row.html', "Services/MyStaff");
38  $this->setFormAction($DIC->ctrl()->getFormAction($parent_obj));
39  $this->setDefaultOrderDirection('desc');
40 
41  $this->setShowRowsSelector(true);
42 
43  $this->setEnableTitle(true);
44  $this->setDisableFilterHiding(true);
45  $this->setEnableNumInfo(true);
46 
47  $this->setExportFormats(array( self::EXPORT_EXCEL, self::EXPORT_CSV ));
48 
49  $this->setFilterCols(4);
50  $this->initFilter();
51  $this->addColumns();
52 
53  $this->parseData();
54  }
setExportFormats(array $formats)
Set available export formats.
global $DIC
Definition: saml.php:7
setEnableNumInfo($a_val)
Set enable num info.
setFilterCols($a_val)
Set filter columns.
setId($a_val)
Set id.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
setDisableFilterHiding($a_val=true)
Set disable filter hiding.
setPrefix($a_prefix)
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setFormName($a_formname="")
Set Form name.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setEnableTitle($a_enabletitle)
Set Enable Title.
+ Here is the call graph for this function:

Member Function Documentation

◆ addColumns()

ilMStListUsersTableGUI::addColumns ( )
private

Definition at line 158 of file class.ilMStListUsersTableGUI.php.

References $DIC, ilTable2GUI\addColumn(), ilTable2GUI\getExportMode(), getSelectableColumns(), and ilTable2GUI\isColumnSelected().

Referenced by __construct().

159  {
160  global $DIC;
161 
162  //User Profile Picture
163  if (!$this->getExportMode()) {
164  $this->addColumn('');
165  }
166 
167  foreach ($this->getSelectableColumns() as $k => $v) {
168  if ($this->isColumnSelected($k)) {
169  if (isset($v['sort_field'])) {
170  $sort = $v['sort_field'];
171  } else {
172  $sort = null;
173  }
174  $this->addColumn($v['txt'], $sort, $v['width']);
175  }
176  }
177  //Actions
178  if (!$this->getExportMode()) {
179  $this->addColumn($DIC->language()->txt('actions'));
180  }
181  }
global $DIC
Definition: saml.php:7
isColumnSelected($a_col)
Is given column selected?
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.
getExportMode()
Was export activated?
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ fillRow()

ilMStListUsersTableGUI::fillRow (   $my_staff_user)
Parameters
ilMStListUser$my_staff_user

Definition at line 187 of file class.ilMStListUsersTableGUI.php.

References $DIC, $f, ilMStListUsersGUI\CMD_GET_ACTIONS, getSelectableColumns(), and ilTable2GUI\isColumnSelected().

188  {
189  global $DIC;
190 
191  $propGetter = Closure::bind(function ($prop) {
192  return $this->$prop;
193  }, $my_staff_user, $my_staff_user);
194 
195  //Avatar
196  $this->tpl->setCurrentBlock('user_profile_picture');
197  $f = $DIC->ui()->factory();
198  $renderer = $DIC->ui()->renderer();
199  $il_obj_user = $my_staff_user->returnIlUserObj();
200  $avatar = $f->image()->standard($il_obj_user->getPersonalPicturePath('small'), $il_obj_user->getPublicName());
201  $this->tpl->setVariable('user_profile_picture', $renderer->render($avatar));
202  $this->tpl->parseCurrentBlock();
203 
204  foreach ($this->getSelectableColumns() as $k => $v) {
205  if ($this->isColumnSelected($k)) {
206  switch ($k) {
207  case 'org_units':
208  $this->tpl->setCurrentBlock('td');
209  $this->tpl->setVariable('VALUE', strval(ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($my_staff_user->getUsrId())));
210  $this->tpl->parseCurrentBlock();
211  break;
212  case 'gender':
213  $this->tpl->setCurrentBlock('td');
214  $this->tpl->setVariable('VALUE', $DIC->language()->txt('gender_' . $my_staff_user->getGender()));
215  $this->tpl->parseCurrentBlock();
216  break;
217  case 'interests_general':
218  $this->tpl->setCurrentBlock('td');
219  $this->tpl->setVariable('VALUE', ($my_staff_user->returnIlUserObj()
220  ->getGeneralInterestsAsText() ? $my_staff_user->returnIlUserObj()->getGeneralInterestsAsText() : ' '));
221  $this->tpl->parseCurrentBlock();
222  break;
223  case 'interests_help_offered':
224  $this->tpl->setCurrentBlock('td');
225  $this->tpl->setVariable('VALUE', ($my_staff_user->returnIlUserObj()
226  ->getOfferingHelpAsText() ? $my_staff_user->returnIlUserObj()->getOfferingHelpAsText() : ' '));
227  $this->tpl->parseCurrentBlock();
228  break;
229  case 'interests_help_looking':
230  $this->tpl->setCurrentBlock('td');
231  $this->tpl->setVariable('VALUE', ($my_staff_user->returnIlUserObj()
232  ->getLookingForHelpAsText() ? $my_staff_user->returnIlUserObj()->getLookingForHelpAsText() : ' '));
233  $this->tpl->parseCurrentBlock();
234  break;
235  default:
236  if ($propGetter($k) !== null) {
237  $this->tpl->setCurrentBlock('td');
238  $this->tpl->setVariable('VALUE', (is_array($propGetter($k)) ? implode(", ", $propGetter($k)) : $propGetter($k)));
239  $this->tpl->parseCurrentBlock();
240  } else {
241  $this->tpl->setCurrentBlock('td');
242  $this->tpl->setVariable('VALUE', ' ');
243  $this->tpl->parseCurrentBlock();
244  }
245  break;
246  }
247  }
248  }
249 
250  $actions = new ilAdvancedSelectionListGUI();
251  $actions->setListTitle($DIC->language()->txt("actions"));
252  $actions->setAsynch(true);
253  $actions->setId($my_staff_user->getUsrId());
254 
255  $DIC->ctrl()->setParameterByClass(ilMStListUsersGUI::class, 'mst_lus_usr_id', $my_staff_user->getUsrId());
256 
257  $actions->setAsynchUrl(str_replace("\\", "\\\\", $DIC->ctrl()
258  ->getLinkTarget($this->parent_obj, ilMStListUsersGUI::CMD_GET_ACTIONS, "", true)));
259  $this->tpl->setVariable('ACTIONS', $actions->getHTML());
260  $this->tpl->parseCurrentBlock();
261  }
global $DIC
Definition: saml.php:7
isColumnSelected($a_col)
Is given column selected?
User interface class for advanced drop-down selection lists.
+ Here is the call graph for this function:

◆ fillRowCSV()

ilMStListUsersTableGUI::fillRowCSV (   $a_csv,
  $my_staff_user 
)
protected
Parameters
ilCSVWriter$a_csv
ilMStListUser$my_staff_user

Definition at line 296 of file class.ilMStListUsersTableGUI.php.

References getFieldValuesForExport().

297  {
298  foreach ($this->getFieldValuesForExport($my_staff_user) as $k => $v) {
299  $a_csv->addColumn($v);
300  }
301  $a_csv->addRow();
302  }
getFieldValuesForExport(ilMStListUser $my_staff_user)
+ Here is the call graph for this function:

◆ fillRowExcel()

ilMStListUsersTableGUI::fillRowExcel ( ilExcel  $a_excel,
$a_row,
  $my_staff_user 
)
protected
Parameters
ilExcel$a_excelexcel wrapper
int$a_row
ilMStListUser$my_staff_user

Definition at line 282 of file class.ilMStListUsersTableGUI.php.

References getFieldValuesForExport(), and ilExcel\setCell().

283  {
284  $col = 0;
285  foreach ($this->getFieldValuesForExport($my_staff_user) as $k => $v) {
286  $a_excel->setCell($a_row, $col, $v);
287  $col++;
288  }
289  }
getFieldValuesForExport(ilMStListUser $my_staff_user)
setCell($a_row, $a_col, $a_value, $a_datatype=null)
Set cell value.
+ Here is the call graph for this function:

◆ getFieldValuesForExport()

ilMStListUsersTableGUI::getFieldValuesForExport ( ilMStListUser  $my_staff_user)
protected
Parameters
ilMStListUser$my_staff_user
Returns
array

Definition at line 310 of file class.ilMStListUsersTableGUI.php.

References $DIC, ilMStListUser\getGender(), ilTable2GUI\getSelectedColumns(), ilMStListUser\getUsrId(), and ilMStListUser\returnIlUserObj().

Referenced by fillRowCSV(), and fillRowExcel().

311  {
312  global $DIC;
313 
314  $propGetter = Closure::bind(function ($prop) {
315  return $this->$prop;
316  }, $my_staff_user, $my_staff_user);
317 
318  $field_values = array();
319 
320  foreach ($this->getSelectedColumns() as $k => $v) {
321  switch ($k) {
322  case 'org_units':
323  $field_values[$k] = ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits($my_staff_user->getUsrId());
324  break;
325  case 'gender':
326  $field_values[$k] = $DIC->language()->txt('gender_' . $my_staff_user->getGender());
327  break;
328  case 'interests_general':
329  $field_values[$k] = $my_staff_user->returnIlUserObj()->getGeneralInterestsAsText();
330  break;
331  case 'interests_help_offered':
332  $field_values[$k] = $my_staff_user->returnIlUserObj()->getOfferingHelpAsText();
333  break;
334  case 'interests_help_looking':
335  $field_values[$k] = $my_staff_user->returnIlUserObj()->getLookingForHelpAsText();
336  break;
337  default:
338  $field_values[$k] = strip_tags($propGetter($k));
339  break;
340  }
341  }
342 
343  return $field_values;
344  }
global $DIC
Definition: saml.php:7
getSelectedColumns()
Get selected columns.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getProfileBackUrl()

ilMStListUsersTableGUI::getProfileBackUrl ( )
private

Get profile back url.

Returns
string

Definition at line 269 of file class.ilMStListUsersTableGUI.php.

References $DIC, and ilMyStaffGUI\CMD_INDEX.

270  {
271  global $DIC;
272 
273  return rawurlencode($DIC->ctrl()->getLinkTargetByClass(strtolower(ilMyStaffGUI::class), ilMyStaffGUI::CMD_INDEX));
274  }
global $DIC
Definition: saml.php:7

◆ getSelectableColumns()

ilMStListUsersTableGUI::getSelectableColumns ( )
Returns
array

Definition at line 135 of file class.ilMStListUsersTableGUI.php.

References $cols, $key, and ilUserSearchOptions\getSelectableColumnInfo().

Referenced by addColumns(), and fillRow().

136  {
137  $arr_fields_without_table_sort = array(
138  'org_units',
139  'interests_general',
140  'interests_help_offered',
141  'interests_help_looking',
142  );
143  $cols = array();
144  foreach (ilUserSearchOptions::getSelectableColumnInfo() as $key => $col) {
145  $cols[$key] = $col;
146  if (!in_array($key, $arr_fields_without_table_sort)) {
147  $cols[$key]['sort_field'] = $key;
148  }
149  }
150 
151  return $cols;
152  }
static getSelectableColumnInfo($a_admin=false)
Get info of searchable fields for selectable columns in table gui.
$key
Definition: croninfo.php:18
$cols
Definition: xhr_table.php:11
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ initFilter()

ilMStListUsersTableGUI::initFilter ( )

Definition at line 99 of file class.ilMStListUsersTableGUI.php.

References $DIC, $nodes, PHPMailer\PHPMailer\$options, $path, $paths, $root, $tree, ilObjOrgUnitTree\_getInstance(), ilUserSearchOptions\_isEnabled(), ilTable2GUI\addFilterItem(), ilObjOrgUnit\getRootOrgRefId(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), and ilSelectInputGUI\setOptions().

Referenced by __construct().

100  {
101  global $DIC;
102 
103  // User name, login, email filter
104  $item = new ilTextInputGUI($DIC->language()->txt("login") . "/" . $DIC->language()->txt("email") . "/" . $DIC->language()
105  ->txt("name"), "user");
106  //$item->setDataSource($DIC->ctrl()->getLinkTarget($this->getParentObject(),"addUserAutoComplete", "", true));
107  //$item->setSize(20);
108  //$item->setSubmitFormOnEnter(true);
109  $this->addFilterItem($item);
110  $item->readFromSession();
111  $this->filter['user'] = $item->getValue();
112 
113  if (ilUserSearchOptions::_isEnabled('org_units')) {
116  $nodes = $tree->getAllChildren($root);
118  $options[0] = $DIC->language()->txt('mst_opt_all');
119  foreach ($paths as $org_ref_id => $path) {
120  $options[$org_ref_id] = $path;
121  }
122  $item = new ilSelectInputGUI($DIC->language()->txt('obj_orgu'), 'org_unit');
123  $item->setOptions($options);
124  $item->addCustomAttribute("style='width:100%'");
125  $this->addFilterItem($item);
126  $item->readFromSession();
127  $this->filter['org_unit'] = $item->getValue();
128  }
129  }
$path
Definition: aliased.php:25
This class represents a selection list property in a property form.
if($argc< 2) $paths
Definition: migrateto20.php:44
global $DIC
Definition: saml.php:7
addFilterItem($a_input_item, $a_optional=false)
Add filter item.
static getTextRepresentationOfOrgUnits($sort_by_title=true)
Get ref id path array.
This class represents a text property in a property form.
$root
Definition: sabredav.php:45
setOptions($a_options)
Set Options.
static getRootOrgRefId()
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ parseData()

ilMStListUsersTableGUI::parseData ( )
protected

Definition at line 60 of file class.ilMStListUsersTableGUI.php.

References ilTableGUI\$data, $DIC, PHPMailer\PHPMailer\$options, ilTable2GUI\determineLimit(), ilTable2GUI\determineOffsetAndOrder(), ilMStListUsers\getData(), ilTable2GUI\getLimit(), ilTable2GUI\getOffset(), ilTableGUI\getOrderDirection(), ilTable2GUI\getOrderField(), ilTable2GUI\setData(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setExternalSegmentation(), ilTable2GUI\setExternalSorting(), and ilTableGUI\setMaxCount().

Referenced by __construct().

61  {
62  global $DIC;
63 
64  $this->setExternalSorting(true);
65  $this->setExternalSegmentation(true);
66  $this->setDefaultOrderField('lastname');
67 
68  $this->determineLimit();
69  $this->determineOffsetAndOrder();
70 
71  //Permission Filter
72  $arr_usr_id = $this->access->getUsersForUser($DIC->user()->getId());
73 
74  $options = array(
75  'filters' => $this->filter,
76  'limit' => array(),
77  'count' => true,
78  'sort' => array(
79  'field' => $this->getOrderField(),
80  'direction' => $this->getOrderDirection(),
81  ),
82  );
83  $count = ilMStListUsers::getData($arr_usr_id, $options);
84  $options['limit'] = array(
85  'start' => intval($this->getOffset()),
86  'end' => intval($this->getLimit()),
87  );
88  $options['count'] = false;
89  $data = ilMStListUsers::getData($arr_usr_id, $options);
90 
91  $this->setMaxCount($count);
92  $this->setData($data);
93  }
setExternalSorting($a_val)
Set external sorting.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
global $DIC
Definition: saml.php:7
setExternalSegmentation($a_val)
Set external segmentation.
determineLimit()
Determine the limit.
static getData(array $arr_usr_ids=array(), array $options=array())
getOrderDirection()
Get order direction.
getOffset()
Get offset.
determineOffsetAndOrder($a_omit_offset=false)
Determine offset and order.
getLimit()
Get limit.
setMaxCount($a_max_count)
set max.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

Field Documentation

◆ $access

ilMStListUsersTableGUI::$access
protected

Definition at line 18 of file class.ilMStListUsersTableGUI.php.

◆ $filter

ilMStListUsersTableGUI::$filter = array()
protected

Definition at line 14 of file class.ilMStListUsersTableGUI.php.


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