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)

	getType ()

	setLuceneResult (ilLuceneSearchResult $res)

	getLuceneResult ()

	setUserLimitations (bool $a_limitations)

	getUserLimitations ()

	getSelectableColumns ()

	initMultiCommands (array $a_commands)

	parseUserIds (array $a_user_ids)

	getHTML ()

Public Member Functions inherited from ilTable2GUI
	__construct (?object $a_parent_obj, string $a_parent_cmd="", string $a_template_context="")

	setOpenFormTag (bool $a_val)

	getOpenFormTag ()

	setCloseFormTag (bool $a_val)

	getCloseFormTag ()

	determineLimit ()

	getSelectableColumns ()
	Get selectable columns. More...

	determineSelectedColumns ()

	isColumnSelected (string $col)

	getSelectedColumns ()

	resetOffset (bool $a_in_determination=false)

	initFilter ()

	getParentObject ()

	getParentCmd ()

	setTopAnchor (string $a_val)

	getTopAnchor ()

	setNoEntriesText (string $a_text)

	getNoEntriesText ()

	setIsDataTable (bool $a_val)

	getIsDataTable ()

	setEnableTitle (bool $a_enabletitle)

	getEnableTitle ()

	setEnableHeader (bool $a_enableheader)

	getEnableHeader ()

	setEnableNumInfo (bool $a_val)

	getEnableNumInfo ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setDescription (string $a_val)

	getDescription ()

	setOrderField (string $a_order_field)

	getOrderField ()

	setData (array $a_data)

	getData ()

	dataExists ()

	setPrefix (string $a_prefix)

	getPrefix ()

	addFilterItem (ilTableFilterItem $a_input_item, bool $a_optional=false)

	addFilterItemByMetaType (string $id, int $type=self::FILTER_TEXT, bool $a_optional=false, string $caption="")
	Add filter by standard type. More...

	getFilterItems (bool $a_optionals=false)

	getFilterItemByPostVar (string $a_post_var)

	setFilterCols (int $a_val)

	getFilterCols ()

	setDisableFilterHiding (bool $a_val=true)

	getDisableFilterHiding ()

	isFilterSelected (string $a_col)
	Is given filter selected? More...

	getSelectedFilters ()

	determineSelectedFilters ()

	setCustomPreviousNext (string $a_prev_link, string $a_next_link)

	setFormAction (string $a_form_action, bool $a_multipart=false)

	getFormAction ()

	setFormName (string $a_name="")

	getFormName ()

	setId (string $a_val)

	getId ()

	setDisplayAsBlock (bool $a_val)

	getDisplayAsBlock ()

	setSelectAllCheckbox (string $a_select_all_checkbox, bool $a_select_all_on_top=false)

	setExternalSorting (bool $a_val)

	getExternalSorting ()

	setFilterCommand (string $a_val, string $a_caption="")

	getFilterCommand ()

	setResetCommand (string $a_val, string $a_caption="")

	getResetCommand ()

	setExternalSegmentation (bool $a_val)

	getExternalSegmentation ()

	setRowTemplate (string $a_template, string $a_template_dir="")
	Set row template. More...

	setDefaultOrderField (string $a_defaultorderfield)

	getDefaultOrderField ()

	setDefaultOrderDirection (string $a_defaultorderdirection)

	getDefaultOrderDirection ()

	setDefaultFilterVisiblity (bool $a_status)

	getDefaultFilterVisibility ()

	clearCommandButtons ()

	addCommandButton (string $a_cmd, string $a_text, string $a_onclick='', string $a_id="", string $a_class="")

	addCommandButtonInstance (ilButtonBase $a_button)

	addMultiItemSelectionButton (string $a_sel_var, array $a_options, string $a_cmd, string $a_text, string $a_default_selection='')

	setCloseCommand (string $a_link)

	addMultiCommand (string $a_cmd, string $a_text)

	addHiddenInput (string $a_name, string $a_value)

	addHeaderCommand (string $a_href, string $a_text, string $a_target="", string $a_img="")

	setTopCommands (bool $a_val)

	getTopCommands ()

	addColumn (string $a_text, string $a_sort_field="", string $a_width="", bool $a_is_checkbox_action_column=false, string $a_class="", string $a_tooltip="", bool $a_tooltip_with_html=false)

	getNavParameter ()

	setOrderLink (string $key, string $order_dir)

	fillHeader ()

	determineOffsetAndOrder (bool $a_omit_offset=false)

	storeNavParameter ()

	getHTML ()
	Get HTML. More...

	numericOrdering (string $a_field)
	Should this field be sorted numeric? More...

	render ()

	writeFilterToSession ()

	resetFilter ()

	fillFooter ()

	getLinkbar (string $a_num)

	fillHiddenRow ()

	fillActionRow ()

	setHeaderHTML (string $html)

	storeProperty (string $type, string $value)

	loadProperty (string $type)

	getCurrentState ()
	get current settings for order, limit, columns and filter More...

	setContext (string $id)

	getContext ()

	setShowRowsSelector (bool $a_value)
	Toggle rows-per-page selector. More...

	getShowRowsSelector ()

	getLimit ()

	getOffset ()

	setExportFormats (array $formats)
	Set available export formats. More...

	setPrintMode (bool $a_value=false)

	getPrintMode ()

	getExportMode ()

	exportData (int $format, bool $send=false)
	Export and optionally send current table data. More...

	setEnableAllCommand (bool $a_value)

	setRowSelectorLabel (string $row_selector_label)

	getRowSelectorLabel ()

	setPreventDoubleSubmission (bool $a_val)

	getPreventDoubleSubmission ()

	setLimit (int $a_limit=0, int $a_default_limit=0)

Public Member Functions inherited from ilTableGUI
	__construct (array $a_data=[], bool $a_global_tpl=true)

	setTemplate (ilTemplate $a_tpl)

	getTemplateObject ()

	setData (array $a_data)
	Set table data. More...

	getData ()

	setTitle (string $a_title, string $a_icon="", string $a_icon_alt="")

	setHelp (string $a_help_page, string $a_help_icon, string $a_help_icon_alt="")

	setHeaderNames (array $a_header_names)

	getColumnCount ()

	setHeaderVars (array $a_header_vars, array $a_header_params=[])

	setColumnWidth (array $a_column_width)
	set table column widths More...

	setOneColumnWidth (string $a_column_width, int $a_column_number)

	setMaxCount (int $a_max_count)
	set max. More...

	setLimit (int $a_limit=0, int $a_default_limit=0)
	set max. More...

	getLimit ()

	setPrefix (string $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) More...

	setOffset (int $a_offset)
	set dataset offset More...

	getOffset ()

	setOrderColumn (string $a_order_column="", string $a_default_column="")

	getOrderColumn ()

	setOrderDirection (string $a_order_direction)

	getOrderDirection ()

	setFooter (string $a_style, string $a_previous="", string $a_next="")

	enable (string $a_module_name)

	disable (string $a_module_name)

	sortData ()

	render ()

	renderHeader ()

	setOrderLink (string $key, string $order_dir)

	setStyle (string $a_element, string $a_style)

	getStyle (string $a_element)

	setBase (string $a_base)

	getBase ()

	getFormName ()
	get the name of the parent form More...

	setFormName (string $a_name="cmd")

	getSelectAllCheckbox ()
	get the name of the checkbox that should be toggled with a select all button More...

	setSelectAllCheckbox (string $a_select_all_checkbox)

	clearActionButtons ()

	addActionButton (string $btn_name, string $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	FILTER_CHECKBOX = 9

const	EXPORT_EXCEL = 1

const	EXPORT_CSV = 2

const	ACTION_ALL_LIMIT = 1000

Data Fields inherited from ilTableGUI
string	$title = ""

string	$icon = ""

string	$icon_alt = ""

string	$help_page = ""

string	$help_icon = ""

string	$help_icon_alt = ""

array	$header_names = []

array	$header_vars = []

array	$linkbar_vars = []

array	$data = []

int	$column_count = 0

array	$column_width = []

int	$max_count = 0

int	$limit = 0

bool	$max_limit = false

int	$offset = 0

string	$order_column = ""

string	$order_direction = ""

string	$footer_style = ""

string	$footer_previous = ""

string	$footer_next = ""

bool	$lang_support = true

bool	$global_tpl = false

string	$form_name = ""

string	$select_all_checkbox = ""

array	$action_buttons = []

string	$prefix = ""

string	$base = ""

array	$enabled

array	$styles

Protected Member Functions
	fillRow (array $a_set)

	applySortation (array $set)

	getPossibleSortations ()

	getDefaultSortation ()

Protected Member Functions inherited from ilTable2GUI
	getRequestedValues ()

	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, ilTableFilterItem $a_element)
	Check if filter element is based on adv md. More...

	fillRow (array $a_set)
	Standard Version of Fill Row. More...

	getFilterValue (ilTableFilterItem $a_item)
	Get current filter value. More...

	setFilterValue (ilTableFilterItem $a_item, $a_value)

	fillMetaExcel (ilExcel $a_excel, int &$a_row)
	Add meta information to excel export. More...

	fillHeaderExcel (ilExcel $a_excel, int &$a_row)
	Excel Version of Fill Header. More...

	fillRowExcel (ilExcel $a_excel, int &$a_row, array $a_set)
	Excel Version of Fill Row. More...

	fillMetaCSV (ilCSVWriter $a_csv)
	Add meta information to csv export. More...

	fillHeaderCSV (ilCSVWriter $a_csv)
	CSV Version of Fill Header. More...

	fillRowCSV (ilCSVWriter $a_csv, array $a_set)
	CSV Version of Fill Row. More...

Protected Attributes
bool	$admin_mode

int	$type

bool	$user_limitations = true

ilObjUser	$user

ilRbacReview	$review

UIServices	$ui

HTTP	$http

Refinery	$refinery

Protected Attributes inherited from ilTable2GUI
string	$requested_nav_par2 = ""

string	$requested_nav_par = ""

string	$requested_nav_par1 = ""

ILIAS Table TableGUIRequest	$table_request = null

array	$selected_columns = []

ilCtrl	$ctrl

object	$parent_obj = null

string	$parent_cmd = ""

string	$close_command = ""

string	$top_anchor = "il_table_top"

array	$filters = array()

array	$optional_filters = array()

string	$filter_cmd = 'applyFilter'

string	$reset_cmd = 'resetFilter'

int	$filter_cols = 5

bool	$ext_sort = false

bool	$ext_seg = false

string	$context = ""

array	$mi_sel_buttons = []

bool	$disable_filter_hiding = false

bool	$top_commands = true

array	$selectable_columns = array()

array	$selected_column = array()

bool	$show_rows_selector = true

bool	$rows_selector_off = false

bool	$nav_determined = false

bool	$limit_determined = false

bool	$filters_determined = false

bool	$columns_determined = false

bool	$open_form_tag = true

bool	$close_form_tag = true

array	$export_formats = []

int	$export_mode = 0

bool	$print_mode = false

bool	$enable_command_for_all = false

bool	$restore_filter = false

array	$restore_filter_values = []

bool	$default_filter_visibility = false

array	$sortable_fields = array()

bool	$prevent_double_submission = true

string	$row_selector_label = ""

bool	$select_all_on_top = false

array	$sel_buttons = []

string	$nav_value = ''

string	$noentriestext = ''

string	$css_row = ''

bool	$display_as_block = false

string	$description = ''

string	$id = ""

bool	$custom_prev_next = false

string	$reset_cmd_txt = ""

string	$defaultorderfield = ""

string	$defaultorderdirection = ""

array	$column = []

bool	$datatable = false

bool	$num_info = false

bool	$form_multipart = false

array	$row_data = []

string	$order_field = ""

array	$selected_filter = []

string	$form_action = ""

string	$formname = ""

string	$sort_order = ""

array	$buttons = []

array	$multi = []

array	$hidden_inputs = []

array	$header_commands = []

string	$row_template = ""

string	$row_template_dir = ""

string	$filter_cmd_txt = ""

string	$custom_prev = ""

string	$custom_next = ""

array	$raw_post_data = null

ilGlobalTemplateInterface	$main_tpl

Protected Attributes inherited from ilTableGUI
string	$sort_order

string	$link_params

array	$header_params

	$tpl

ilLanguage	$lng

Static Protected Attributes
static array	$all_selectable_cols = []

Private Attributes
ilLuceneSearchResult	$lucene_result = null

Additional Inherited Members
Static Public Member Functions inherited from ilTable2GUI
static	getAllCommandLimit ()

Static Public Member Functions inherited from ilTableGUI
static	linkbar (string $AScript, int $AHits, int $ALimit, int $AOffset, array $AParams=array(), array $ALayout=array(), string $prefix='')

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

Definition at line 32 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`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilTable2GUI\addColumn(), ILIAS\Repository\ctrl(), ilTableGUI\enable(), ilBuddySystem\getInstance(), getSelectableColumns(), ilTable2GUI\getSelectedColumns(), getType(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilTable2GUI\setDefaultOrderDirection(), ilTable2GUI\setDefaultOrderField(), ilTable2GUI\setEnableTitle(), ilTable2GUI\setExternalSorting(), ilTable2GUI\setFormAction(), ilTable2GUI\setId(), ilTable2GUI\setRowTemplate(), ilTable2GUI\setSelectAllCheckbox(), ilTable2GUI\setShowRowsSelector(), ilTable2GUI\setTitle(), ILIAS\Repository\ui(), and ILIAS\Repository\user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->review = $DIC->rbac()->review();
         $this->ui = $DIC->ui();
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
 
         $this->admin_mode = (bool) $a_admin_mode;
         $this->type = $a_type;
 
         $this->setId("rep_search_" . $this->user->getId());
         parent::__construct($a_parent_obj, $a_parent_cmd);
 
 
         $this->setFormAction($this->ctrl->getFormAction($this->parent_obj));
         $this->setTitle($this->lng->txt('search_results'));
         $this->setEnableTitle(true);
         $this->setShowRowsSelector(true);
 
 
         if ($this->getType() == self::TYPE_STANDARD) {
             $this->setRowTemplate("tpl.rep_search_usr_result_row.html", "components/ILIAS/Search");
             $this->addColumn("", "", "1", true);
             $this->enable('select_all');
             $this->setSelectAllCheckbox("user[]");
             $this->setDefaultOrderField("login");
             $this->setDefaultOrderDirection("asc");
         } else {
             $this->setRowTemplate("tpl.global_search_usr_result_row.html", "components/ILIAS/Search");
             $this->addColumn('', '', "110px");
             $this->setExternalSorting(true);
         }
 
         $all_cols = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $col) {
             $sort_field = '';
             if ($this->getType() == self::TYPE_STANDARD) {
                 $sort_field = $col;
             }
             $this->addColumn($all_cols[$col]['txt'], $sort_field);
         }
 
         if (
             $this->getType() != self::TYPE_STANDARD &&
             ilBuddySystem::getInstance()->isEnabled()
         ) {
             $this->addColumn('', '');
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ applySortation()

ilRepositoryUserResultTableGUI::applySortation ( array $set )

protected

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

References Vendor\Package\$a, Vendor\Package\$b, and getCurrentSortation().

Referenced by parseUserIds().

                                                  : array
     {
         $sort = $this->getCurrentSortation();
 
         if ($sort === 'relevance') {
             usort($set, function ($a, $b) {
                 return $b['relevance'] <=> $a['relevance'];
             });
             return $set;
         }
 
         if (str_ends_with($sort, '_asc')) {
             $col = substr($sort, 0, -4);
             usort($set, function ($a, $b) use ($col) {
                 return [$a[$col], $b['relevance'] ?? ''] <=> [$b[$col], $a['relevance'] ?? ''];
             });
         } elseif (str_ends_with($sort, '_desc')) {
             $col = substr($sort, 0, -5);
             usort($set, function ($a, $b) use ($col) {
                 return [$b[$col], $b['relevance'] ?? ''] <=> [$a[$col], $a['relevance'] ?? ''];
             });
         }
 
         return $set;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fillRow()

ilRepositoryUserResultTableGUI::fillRow ( array $a_set )

protected

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

References ilObjUser\_getPersonalPicturePath(), ILIAS\Repository\ctrl(), ilDatePresentation\formatDate(), ilBuddySystem\getInstance(), ilBuddySystemLinkButton\getInstanceByUserId(), ilUserUtil\getProfileLink(), ilTable2GUI\getSelectedColumns(), getType(), IL_CAL_DATE, IL_CAL_DATETIME, ILIAS\Repository\lng(), and ILIAS\Repository\user().

                                             : void
     {
         $this->tpl->setVariable("VAL_ID", $a_set["usr_id"]);
 
         $link = '';
         if ($this->getType() == self::TYPE_GLOBAL_SEARCH) {
             $link = ilUserUtil::getProfileLink((int) $a_set['usr_id']);
             if ($link) {
                 $this->tpl->setVariable('IMG_LINKED_TO_PROFILE', $link);
                 $this->tpl->setVariable(
                     'USR_IMG_SRC_LINKED',
                     ilObjUser::_getPersonalPicturePath((int) $a_set['usr_id'], 'xsmall')
                 );
             } else {
                 $this->tpl->setVariable(
                     'USR_IMG_SRC',
                     ilObjUser::_getPersonalPicturePath((int) $a_set['usr_id'], 'xsmall')
                 );
             }
         }
 
 
         foreach ($this->getSelectedColumns() as $field) {
             switch ($field) {
                 case 'gender':
                     $a_set['gender'] = $a_set['gender'] ? $this->lng->txt('gender_' . $a_set['gender']) : '';
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case 'birthday':
                     $a_set['birthday'] = $a_set['birthday'] ? ilDatePresentation::formatDate(new ilDate($a_set['birthday'], IL_CAL_DATE)) : $this->lng->txt('no_date');
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case 'access_until':
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('CUST_CLASS', ' ' . $a_set['access_class']);
                     $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case 'last_login':
                     $a_set['last_login'] = $a_set['last_login'] ? ilDatePresentation::formatDate(new ilDateTime($a_set['last_login'], IL_CAL_DATETIME)) : $this->lng->txt('no_date');
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', $a_set[$field]);
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case 'interests_general':
                 case 'interests_help_offered':
                 case 'interests_help_looking':
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', implode(', ', (array) $a_set[$field]));
                     $this->tpl->parseCurrentBlock();
                     break;
 
                 case 'org_units':
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable(
                         'VAL_CUST',
                         ilOrgUnitPathStorage::getTextRepresentationOfUsersOrgUnits((int) $a_set['usr_id'])
                     );
                     $this->tpl->parseCurrentBlock();
                     break;
 
 
                 case 'login':
                     if ($this->admin_mode) {
                         $this->ctrl->setParameterByClass("ilobjusergui", "ref_id", "7");
                         $this->ctrl->setParameterByClass("ilobjusergui", "obj_id", $a_set["usr_id"]);
                         $this->ctrl->setParameterByClass("ilobjusergui", "search", "1");
                         $link = $this->ctrl->getLinkTargetByClass(array("iladministrationgui", "ilobjusergui"), "view");
                         $a_set[$field] = "<a href=\"" . $link . "\">" . $a_set[$field] . "</a>";
                     } elseif ($this->getType() == self::TYPE_GLOBAL_SEARCH) {
                         $a_set[$field] = "<a href=\"" . $link . "\">" . $a_set[$field] . "</a>";
                     }
                     // fallthrough
 
                     // no break
                 default:
                     $this->tpl->setCurrentBlock('custom_fields');
                     $this->tpl->setVariable('VAL_CUST', (string) ($a_set[$field] ?: ''));
                     $this->tpl->parseCurrentBlock();
                     break;
             }
         }
 
         if ($this->getType() == self::TYPE_GLOBAL_SEARCH) {
             if (ilBuddySystem::getInstance()->isEnabled() && $a_set['usr_id'] != $this->user->getId()) {
                 $this->tpl->setVariable('CONTACT_ACTIONS', ilBuddySystemLinkButton::getInstanceByUserId((int) $a_set['usr_id'])->getHtml());
             } else {
                 $this->tpl->setVariable('CONTACT_ACTIONS', '');
             }
         }
     }

Here is the call graph for this function:

◆ getDefaultSortation()

ilRepositoryUserResultTableGUI::getDefaultSortation ( )

protected

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

References getLuceneResult(), and getType().

                                             : string
     {
         $lucene_enabled = ($this->getType() == self::TYPE_GLOBAL_SEARCH) &&
             ($this->getLuceneResult() instanceof ilLuceneSearchResult);
         return $lucene_enabled ? 'relevance' : 'login_asc';
     }

Here is the call graph for this function:

◆ getHTML()

ilRepositoryUserResultTableGUI::getHTML ( )

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

References buildSortationViewControl(), getType(), and ILIAS\Repository\ui().

                              : string
     {
         $html = parent::getHTML();
         if ($this->getType() == self::TYPE_GLOBAL_SEARCH) {
             $html = $this->ui->renderer()->render($this->buildSortationViewControl()) . $html;
         }
         return $html;
     }

Here is the call graph for this function:

◆ getLuceneResult()

ilRepositoryUserResultTableGUI::getLuceneResult ( )

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

References $lucene_result.

Referenced by getDefaultSortation(), and parseUserIds().

                                      : ilLuceneSearchResult
     {
         return $this->lucene_result;
     }

Here is the caller graph for this function:

◆ getPossibleSortations()

ilRepositoryUserResultTableGUI::getPossibleSortations ( )

protected

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

References getSelectableColumns(), ilTable2GUI\getSelectedColumns(), and ILIAS\Repository\lng().

                                               : array
     {
         $sorts = ['relevance' => $this->lng->txt('search_sort_relevance')];
         $all_cols = $this->getSelectableColumns();
         foreach ($this->getSelectedColumns() as $col) {
             $sorts[$col . '_asc'] = sprintf(
                 $this->lng->txt('search_sort_generic_asc'),
                 $all_cols[$col]['txt']
             );
             $sorts[$col . '_desc'] = sprintf(
                 $this->lng->txt('search_sort_generic_desc'),
                 $all_cols[$col]['txt']
             );
         }
         return $sorts;
     }

Here is the call graph for this function:

◆ getSelectableColumns()

ilRepositoryUserResultTableGUI::getSelectableColumns ( )

Returns: array

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

References ilUserSearchOptions\getSelectableColumnInfo(), ILIAS\Repository\lng(), and SYSTEM_ROLE_ID.

Referenced by __construct(), and getPossibleSortations().

                                           : array
     {
         if (!self::$all_selectable_cols) {
             $columns = ilUserSearchOptions::getSelectableColumnInfo($this->review->isAssigned($this->user->getId(), SYSTEM_ROLE_ID));
 
             if ($this->admin_mode) {
                 // #11293
                 $columns['access_until'] = array('txt' => $this->lng->txt('access_until'));
                 $columns['last_login'] = array('txt' => $this->lng->txt('last_login'));
             }
 
             self::$all_selectable_cols = $columns;
         }
         return self::$all_selectable_cols;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getType()

ilRepositoryUserResultTableGUI::getType ( )

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

References $type.

Referenced by __construct(), fillRow(), getDefaultSortation(), getHTML(), and parseUserIds().

                              : int
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUserLimitations()

ilRepositoryUserResultTableGUI::getUserLimitations ( )

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

References $user_limitations.

Referenced by parseUserIds().

                                         : bool
     {
         return $this->user_limitations;
     }

Here is the caller graph for this function:

◆ initMultiCommands()

ilRepositoryUserResultTableGUI::initMultiCommands ( array $a_commands )

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

References ilTable2GUI\addMultiCommand(), ilTable2GUI\addMultiItemSelectionButton(), and ILIAS\Repository\lng().

                                                         : bool
     {
         if (!count($a_commands)) {
             $this->addMultiCommand('addUser', $this->lng->txt('btn_add'));
             return true;
         }
         $this->addMultiItemSelectionButton('member_type', $a_commands, 'addUser', $this->lng->txt('btn_add'));
         return true;
     }

Here is the call graph for this function:

◆ parseUserIds()

ilRepositoryUserResultTableGUI::parseUserIds ( array $a_user_ids )

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

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

                                                    : bool
     {
         if (!$a_user_ids) {
             $this->setData(array());
             return true;
         }
 
         $additional_fields = $this->getSelectedColumns();
 
         $parse_access = false;
         if (isset($additional_fields['access_until'])) {
             $parse_access = true;
             unset($additional_fields['access_until']);
         }
 
         $udf_ids = $usr_data_fields = $odf_ids = array();
         foreach ($additional_fields as $field) {
             if ($field == 'org_units') {
                 continue;
             }
             if (substr($field, 0, 3) == 'udf') {
                 $udf_ids[] = substr($field, 4);
                 continue;
             }
             $usr_data_fields[] = $field;
         }
 
         $u_query = new ilUserQuery();
         $u_query->setOrderField('login');
         $u_query->setOrderDirection('ASC');
         $u_query->setLimit(999999);
 
         if (!ilSearchSettings::getInstance()->isInactiveUserVisible() && $this->getUserLimitations()) {
             $u_query->setActionFilter("active");
         }
 
         if (!ilSearchSettings::getInstance()->isLimitedUserVisible() && $this->getUserLimitations()) {
             $u_query->setAccessFilter(true);
         }
 
         $u_query->setAdditionalFields($usr_data_fields);
         $u_query->setUserFilter($a_user_ids);
 
         $usr_data = $u_query->query();
 
 
         if ($this->admin_mode && $parse_access) {
             // see ilUserTableGUI
             $current_time = time();
             foreach ($usr_data['set'] as $k => $user) {
                 if ($user['active']) {
                     if ($user["time_limit_unlimited"]) {
                         $txt_access = $this->lng->txt("access_unlimited");
                         $usr_data["set"][$k]["access_class"] = "smallgreen";
                     } elseif ($user["time_limit_until"] < $current_time) {
                         $txt_access = $this->lng->txt("access_expired");
                         $usr_data["set"][$k]["access_class"] = "smallred";
                     } else {
                         $txt_access = ilDatePresentation::formatDate(new ilDateTime($user["time_limit_until"], IL_CAL_UNIX));
                         $usr_data["set"][$k]["access_class"] = "small";
                     }
                 } else {
                     $txt_access = $this->lng->txt("inactive");
                     $usr_data["set"][$k]["access_class"] = "smallred";
                 }
                 $usr_data["set"][$k]["access_until"] = $txt_access;
             }
         }
 
         // Custom user data fields
         if ($udf_ids) {
             $data = ilUserDefinedData::lookupData($a_user_ids, $udf_ids);
 
             $users = array();
             $counter = 0;
             foreach ($usr_data['set'] as $set) {
                 $users[$counter] = $set;
                 foreach ($udf_ids as $udf_field) {
                     $users[$counter]['udf_' . $udf_field] = ($data[(int) ($set['usr_id'] ?? 0)][$udf_field] ?? '');
                 }
                 ++$counter;
             }
         } else {
             $users = $usr_data['set'];
         }
 
         if ($this->getType() == self::TYPE_GLOBAL_SEARCH) {
             if ($this->getLuceneResult() instanceof ilLuceneSearchResult) {
                 foreach ($users as $counter => $ud) {
                     $users[$counter]['relevance'] = $this->getLuceneResult()->getRelevance((int) ($ud['usr_id']) ?? 0);
                 }
             }
         }
         if ($this->getType() === self::TYPE_GLOBAL_SEARCH) {
             $users = $this->applySortation($users);
         }
         $this->setData($users);
         return true;
     }

Here is the call graph for this function:

◆ setLuceneResult()

ilRepositoryUserResultTableGUI::setLuceneResult ( ilLuceneSearchResult $res )

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

References $res.

                                                               : void
     {
         $this->lucene_result = $res;
     }

◆ setUserLimitations()

ilRepositoryUserResultTableGUI::setUserLimitations ( bool $a_limitations )

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

                                                            : void
     {
         $this->user_limitations = $a_limitations;
     }

Field Documentation

◆ $admin_mode

bool ilRepositoryUserResultTableGUI::$admin_mode

protected

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

◆ $all_selectable_cols

array ilRepositoryUserResultTableGUI::$all_selectable_cols = []

staticprotected

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

◆ $http

HTTP ilRepositoryUserResultTableGUI::$http

protected

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

◆ $lucene_result

ilLuceneSearchResult ilRepositoryUserResultTableGUI::$lucene_result = null

private

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

Referenced by getLuceneResult().

◆ $refinery

Refinery ilRepositoryUserResultTableGUI::$refinery

protected

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

◆ $review

ilRbacReview ilRepositoryUserResultTableGUI::$review

protected

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

◆ $type

int ilRepositoryUserResultTableGUI::$type

protected

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

Referenced by getType().

◆ $ui

UIServices ilRepositoryUserResultTableGUI::$ui

protected

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

◆ $user

ilObjUser ilRepositoryUserResultTableGUI::$user

protected

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

◆ $user_limitations

bool ilRepositoryUserResultTableGUI::$user_limitations = true

protected

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

Referenced by getUserLimitations().

◆ TYPE_GLOBAL_SEARCH

const ilRepositoryUserResultTableGUI::TYPE_GLOBAL_SEARCH = 2

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

Referenced by ilLuceneUserSearchGUI\performSearch().

◆ TYPE_STANDARD

const ilRepositoryUserResultTableGUI::TYPE_STANDARD = 1

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

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

components/ILIAS/Search/classes/class.ilRepositoryUserResultTableGUI.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ applySortation()

◆ fillRow()

◆ getDefaultSortation()

◆ getHTML()

◆ getLuceneResult()

◆ getPossibleSortations()

◆ getSelectableColumns()

◆ getType()

◆ getUserLimitations()

◆ initMultiCommands()

◆ parseUserIds()

◆ setLuceneResult()

◆ setUserLimitations()

Field Documentation

◆ $admin_mode

◆ $all_selectable_cols

◆ $http

◆ $lucene_result

◆ $refinery

◆ $review

◆ $type

◆ $ui

◆ $user

◆ $user_limitations

◆ TYPE_GLOBAL_SEARCH

◆ TYPE_STANDARD