ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilRepositoryUserResultTableGUI Class Reference

TableGUI class user search results. More...

+ Inheritance diagram for ilRepositoryUserResultTableGUI:
+ Collaboration diagram for ilRepositoryUserResultTableGUI:

Public Member Functions

 __construct ($a_parent_obj, $a_parent_cmd, $a_admin_mode=false, $a_type=self::TYPE_STANDARD)
 Constructor. More...
 
 numericOrdering ($a_field)
 enable numeric ordering for relevance More...
 
 getType ()
 Get search context type. More...
 
 setLuceneResult (ilLuceneSearchResult $res)
 Set lucene result For parsing relevances. More...
 
 getLuceneResult ()
 Get lucene result. More...
 
 setUserLimitations ($a_limitations)
 allow user limitations like inactive and access limitations More...
 
 getUserLimitations ()
 allow user limitations like inactive and access limitations More...
 
 getSelectableColumns ()
 Get all selectable columns. More...
 
 initMultiCommands ($a_commands)
 Init multi commands. More...
 
 parseUserIds ($a_user_ids)
 Parse user data. More...
 
 getRelevanceHTML ($a_rel)
 Get relevance html. More...
 
- 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)
 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)
 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 (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
 ilTableGUI ($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)
 

Data Fields

const TYPE_STANDARD = 1
 
const TYPE_GLOBAL_SEARCH = 2
 
- 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
 

Protected Attributes

 $lucene_result = null
 
 $admin_mode
 
 $type
 
 $user_limitations = 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
 
 $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
 
 $sortable_fields = array()
 
 $prevent_double_submission = true
 
 $row_selector_label
 

Static Protected Attributes

static $all_selectable_cols = NULL
 

Additional Inherited Members

- Static Public Member Functions inherited from ilTable2GUI
static getAllCommandLimit ()
 Get maximum number of entries to enable actions for all. More...
 
- Protected Member Functions inherited from ilTable2GUI
 prepareOutput ()
 Anything that must be done before HTML is generated. 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 ($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...
 

Detailed Description

TableGUI class user search results.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

Definition at line 15 of file class.ilRepositoryUserResultTableGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilRepositoryUserResultTableGUI::__construct (   $a_parent_obj,
  $a_parent_cmd,
  $a_admin_mode = false,
  $a_type = self::TYPE_STANDARD 
)

Constructor.

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

32 {
33 global $ilCtrl, $lng, $ilAccess, $lng, $ilUser;
34
35 $this->admin_mode = (bool)$a_admin_mode;
36 $this->type = $a_type;
37
38 $this->setId("rep_search_".$ilUser->getId());
39 parent::__construct($a_parent_obj, $a_parent_cmd);
40
41
42 $this->setFormAction($ilCtrl->getFormAction($this->parent_obj));
43 $this->setTitle($this->lng->txt('search_results'));
44 $this->setEnableTitle(true);
45 $this->setShowRowsSelector(true);
46
47
48 if($this->getType() == self::TYPE_STANDARD)
49 {
50 $this->setRowTemplate("tpl.rep_search_usr_result_row.html", "Services/Search");
51 $this->addColumn("", "", "1", true);
52 $this->enable('select_all');
53 $this->setSelectAllCheckbox("user[]");
54 $this->setDefaultOrderField("login");
55 $this->setDefaultOrderDirection("asc");
56 }
57 else
58 {
59 $this->setRowTemplate("tpl.global_search_usr_result_row.html", "Services/Search");
60 $this->addColumn('', '', "110px");
61 }
62
63 $all_cols = $this->getSelectableColumns();
64 foreach($this->getSelectedColumns() as $col)
65 {
66 $this->addColumn($all_cols[$col]['txt'], $col);
67 }
68
69 if($this->getType() == self::TYPE_STANDARD)
70 {
71
72 }
73 else
74 {
75 $this->addColumn($this->lng->txt('lucene_relevance_short'),'relevance');
76 if(ilBuddySystem::getInstance()->isEnabled())
77 {
78 $this->addColumn('', '');
79 }
80 $this->setDefaultOrderField("relevance");
81 $this->setDefaultOrderDirection("desc");
82 }
83
84 }
getSelectedColumns()
Get selected columns.
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.
setShowRowsSelector($a_value)
Toggle rows-per-page selector.
setTitle($a_title, $a_icon=0, $a_icon_alt=0)
Set title and title icon.
setEnableTitle($a_enabletitle)
Set Enable Title.
setRowTemplate($a_template, $a_template_dir="")
Set row template.
setDefaultOrderField($a_defaultorderfield)
Set Default order field.
setSelectAllCheckbox($a_select_all_checkbox)
Set the name of the checkbox that should be toggled with a select all button.
setId($a_val)
Set id.
setFormAction($a_form_action, $a_multipart=false)
Set Form action parameter.
setDefaultOrderDirection($a_defaultorderdirection)
Set Default order direction.
enable($a_module_name)
enables particular modules of table
global $ilCtrl
Definition: ilias.php:18
global $lng
Definition: privfeed.php:40
global $ilUser
Definition: imgupload.php:15

References $ilCtrl, $ilUser, $lng, ilTable2GUI\addColumn(), ilTableGUI\enable(), ilBuddySystem\getInstance(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), getType(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), and ilTable2GUI\setTitle().

+ Here is the call graph for this function:

Member Function Documentation

◆ getLuceneResult()

ilRepositoryUserResultTableGUI::getLuceneResult ( )

Get lucene result.

Returns
ilLuceneSearchResult

Definition at line 123 of file class.ilRepositoryUserResultTableGUI.php.

References $lucene_result.

Referenced by parseUserIds().

+ Here is the caller graph for this function:

◆ getRelevanceHTML()

ilRepositoryUserResultTableGUI::getRelevanceHTML (   $a_rel)

Get relevance html.

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

453 {
454 $tpl = new ilTemplate('tpl.lucene_relevance.html',true,true,'Services/Search');
455
456 include_once "Services/UIComponent/ProgressBar/classes/class.ilProgressBar.php";
458 $pbar->setCurrent($a_rel);
459
460 $tpl->setCurrentBlock('relevance');
461 $tpl->setVariable('REL_PBAR', $pbar->render());
462 $tpl->parseCurrentBlock();
463
464 return $tpl->get();
465 }
global $tpl
Definition: ilias.php:8
static getInstance()
Factory.
special template class to simplify handling of ITX/PEAR

References $tpl, and ilProgressBar\getInstance().

+ Here is the call graph for this function:

◆ getSelectableColumns()

ilRepositoryUserResultTableGUI::getSelectableColumns ( )

Get all selectable columns.

Returns
array

@global ilRbacReview $rbacreview

Reimplemented from ilTable2GUI.

Definition at line 154 of file class.ilRepositoryUserResultTableGUI.php.

155 {
156 global $rbacreview, $ilUser;
157
158 if(!self::$all_selectable_cols)
159 {
160 include_once './Services/Search/classes/class.ilUserSearchOptions.php';
161 $columns = ilUserSearchOptions::getSelectableColumnInfo($rbacreview->isAssigned($ilUser->getId(), SYSTEM_ROLE_ID));
162
163 if($this->admin_mode)
164 {
165 // #11293
166 $columns['access_until'] = array('txt' => $this->lng->txt('access_until'));
167 $columns['last_login'] = array('txt' => $this->lng->txt('last_login'));
168 }
169
170 self::$all_selectable_cols = $columns;
171 }
173 }
if(! $in) $columns
Definition: Utf8Test.php:46
static getSelectableColumnInfo($a_admin=false)
Get info of searchable fields for selectable columns in table gui.

References $all_selectable_cols, $columns, $ilUser, and ilUserSearchOptions\getSelectableColumnInfo().

Referenced by __construct().

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

◆ getType()

ilRepositoryUserResultTableGUI::getType ( )

Get search context type.

Returns
string

Definition at line 104 of file class.ilRepositoryUserResultTableGUI.php.

References $type.

Referenced by __construct(), and parseUserIds().

+ Here is the caller graph for this function:

◆ getUserLimitations()

ilRepositoryUserResultTableGUI::getUserLimitations ( )

allow user limitations like inactive and access limitations

Returns
bool

Definition at line 142 of file class.ilRepositoryUserResultTableGUI.php.

References $user_limitations.

Referenced by parseUserIds().

+ Here is the caller graph for this function:

◆ initMultiCommands()

ilRepositoryUserResultTableGUI::initMultiCommands (   $a_commands)

Init multi commands.

Returns

Definition at line 179 of file class.ilRepositoryUserResultTableGUI.php.

180 {
181 if(!count($a_commands))
182 {
183 $this->addMultiCommand('addUser', $this->lng->txt('btn_add'));
184 return true;
185 }
186 $this->addMultiItemSelectionButton('member_type', $a_commands, 'addUser', $this->lng->txt('btn_add'));
187 return true;
188 }
addMultiCommand($a_cmd, $a_text)
Add Command button.
addMultiItemSelectionButton($a_sel_var, $a_options, $a_cmd, $a_text, $a_default_selection='')
Add Selection List + Command button for selected items.

References ilTable2GUI\addMultiCommand(), and ilTable2GUI\addMultiItemSelectionButton().

+ Here is the call graph for this function:

◆ numericOrdering()

ilRepositoryUserResultTableGUI::numericOrdering (   $a_field)

enable numeric ordering for relevance

Parameters
type$a_field
Returns
boolean

Reimplemented from ilTable2GUI.

Definition at line 91 of file class.ilRepositoryUserResultTableGUI.php.

92 {
93 if($a_field == 'relevance')
94 {
95 return true;
96 }
97 return parent::numericOrdering($a_field);
98 }

◆ parseUserIds()

ilRepositoryUserResultTableGUI::parseUserIds (   $a_user_ids)

Parse user data.

Returns
Parameters
array$a_user_ids

Definition at line 309 of file class.ilRepositoryUserResultTableGUI.php.

310 {
311 if(!$a_user_ids)
312 {
313 $this->setData(array());
314 return true;
315 }
316
317 $additional_fields = $this->getSelectedColumns();
318
319 $parse_access = false;
320 if(isset($additional_fields['access_until']))
321 {
322 $parse_access = true;
323 unset($additional_fields['access_until']);
324 }
325
326 $udf_ids = $usr_data_fields = $odf_ids = array();
327 foreach($additional_fields as $field)
328 {
329 if(substr($field, 0, 3) == 'udf')
330 {
331 $udf_ids[] = substr($field,4);
332 continue;
333 }
334 $usr_data_fields[] = $field;
335 }
336 include_once './Services/User/classes/class.ilUserQuery.php';
337 /* $usr_data = ilUserQuery::getUserListData(
338 'login',
339 'ASC',
340 0,
341 999999,
342 '',
343 '',
344 null,
345 false,
346 false,
347 0,
348 0,
349 null,
350 $usr_data_fields,
351 $a_user_ids
352 );*/
353
354 $u_query = new ilUserQuery();
355 $u_query->setOrderField('login');
356 $u_query->setOrderDirection('ASC');
357 $u_query->setLimit(999999);
358 include_once './Services/Search/classes/class.ilSearchSettings.php';
359
360 if(!ilSearchSettings::getInstance()->isInactiveUserVisible() && $this->getUserLimitations())
361 {
362 $u_query->setActionFilter("activ");
363 }
364
365 if(!ilSearchSettings::getInstance()->isLimitedUserVisible() && $this->getUserLimitations())
366 {
367 $u_query->setAccessFilter(true);
368 }
369
370 $u_query->setAdditionalFields($usr_data_fields);
371 $u_query->setUserFilter($a_user_ids);
372
373 $usr_data = $u_query->query();
374
375
376 if($this->admin_mode && $parse_access)
377 {
378 // see ilUserTableGUI
379 $current_time = time();
380 foreach($usr_data['set'] as $k => $user)
381 {
382 if ($user['active'])
383 {
384 if ($user["time_limit_unlimited"])
385 {
386 $txt_access = $this->lng->txt("access_unlimited");
387 $usr_data["set"][$k]["access_class"] = "smallgreen";
388 }
389 elseif ($user["time_limit_until"] < $current_time)
390 {
391 $txt_access = $this->lng->txt("access_expired");
392 $usr_data["set"][$k]["access_class"] = "smallred";
393 }
394 else
395 {
396 $txt_access = ilDatePresentation::formatDate(new ilDateTime($user["time_limit_until"],IL_CAL_UNIX));
397 $usr_data["set"][$k]["access_class"] = "small";
398 }
399 }
400 else
401 {
402 $txt_access = $this->lng->txt("inactive");
403 $usr_data["set"][$k]["access_class"] = "smallred";
404 }
405 $usr_data["set"][$k]["access_until"] = $txt_access;
406 }
407 }
408
409 // Custom user data fields
410 if($udf_ids)
411 {
412 include_once './Services/User/classes/class.ilUserDefinedData.php';
413 $data = ilUserDefinedData::lookupData($a_user_ids, $udf_ids);
414
415 $users = array();
416 $counter = 0;
417 foreach($usr_data['set'] as $set)
418 {
419 $users[$counter] = $set;
420 foreach($udf_ids as $udf_field)
421 {
422 $users[$counter]['udf_'.$udf_field] = $data[$set['usr_id']][$udf_field];
423 }
424 ++$counter;
425 }
426 }
427 else
428 {
429 $users = $usr_data['set'];
430 }
431
432 if($this->getType() == self::TYPE_GLOBAL_SEARCH)
433 {
434 if($this->getLuceneResult() instanceof ilLuceneSearchResult)
435 {
436 foreach($users as $counter => $ud)
437 {
438 $users[$counter]['relevance'] = $this->getLuceneResult()->getRelevance($ud['usr_id']);
439 }
440 }
441 }
442
443
444
445 $this->setData($users);
446 }
const IL_CAL_UNIX
static formatDate(ilDateTime $date)
Format a date @access public.
@classDescription Date and time handling
Search result implementing iterator interface.
getUserLimitations()
allow user limitations like inactive and access limitations
setData($a_data)
set table data @access public
static lookupData($a_user_ids, $a_field_ids)
Lookup data.
User query class.

References ilTableGUI\$data, ilDatePresentation\formatDate(), ilSearchSettings\getInstance(), getLuceneResult(), ilTable2GUI\getSelectedColumns(), getType(), getUserLimitations(), IL_CAL_UNIX, ilUserDefinedData\lookupData(), and ilTable2GUI\setData().

+ Here is the call graph for this function:

◆ setLuceneResult()

ilRepositoryUserResultTableGUI::setLuceneResult ( ilLuceneSearchResult  $res)

Set lucene result For parsing relevances.

Parameters
ilLuceneSearchResult$res

Definition at line 114 of file class.ilRepositoryUserResultTableGUI.php.

115 {
116 $this->lucene_result = $res;
117 }

References $res.

◆ setUserLimitations()

ilRepositoryUserResultTableGUI::setUserLimitations (   $a_limitations)

allow user limitations like inactive and access limitations

Parameters
bool$a_limitations

Definition at line 133 of file class.ilRepositoryUserResultTableGUI.php.

134 {
135 $this->user_limitations = (bool) $a_limitations;
136 }

Field Documentation

◆ $admin_mode

ilRepositoryUserResultTableGUI::$admin_mode
protected

Definition at line 24 of file class.ilRepositoryUserResultTableGUI.php.

◆ $all_selectable_cols

ilRepositoryUserResultTableGUI::$all_selectable_cols = NULL
staticprotected

Definition at line 23 of file class.ilRepositoryUserResultTableGUI.php.

Referenced by getSelectableColumns().

◆ $lucene_result

ilRepositoryUserResultTableGUI::$lucene_result = null
protected

Definition at line 20 of file class.ilRepositoryUserResultTableGUI.php.

Referenced by getLuceneResult().

◆ $type

ilRepositoryUserResultTableGUI::$type
protected

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

Referenced by getType().

◆ $user_limitations

ilRepositoryUserResultTableGUI::$user_limitations = true
protected

Definition at line 26 of file class.ilRepositoryUserResultTableGUI.php.

Referenced by getUserLimitations().

◆ TYPE_GLOBAL_SEARCH

const ilRepositoryUserResultTableGUI::TYPE_GLOBAL_SEARCH = 2

◆ TYPE_STANDARD

const ilRepositoryUserResultTableGUI::TYPE_STANDARD = 1

Definition at line 17 of file class.ilRepositoryUserResultTableGUI.php.


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