This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilUserSearchOptions:

Static Public Member Functions
static	getSelectableColumnInfo (bool $a_admin=false)
	Get info of searchable fields for selectable columns in table gui. More...

static	_getSearchableFieldsInfo (bool $a_admin=false)

static	_getPossibleFields (bool $a_admin=false)

static	_isSearchable (string $a_key)

static	_isEnabled ($a_key)

static	_saveStatus (string $a_key, bool $a_enabled)

static	__appendUserDefinedFields (array $fields, int $counter)

static	__prepareValues (array $a_values)

Data Fields
const	FIELD_TYPE_UDF_UNDEFINED = 0

const	FIELD_TYPE_UDF_SELECT = 1

const	FIELD_TYPE_UDF_TEXT = 2

const	FIELD_TYPE_SELECT = 3

const	FIELD_TYPE_TEXT = 4

const	FIELD_TYPE_MULTI = 5

const	FIELD_TYPE_UDF_WYSIWYG = 6

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilUserSearchOptions

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

Definition at line 29 of file class.ilUserSearchOptions.php.

Member Function Documentation

◆ __appendUserDefinedFields()

static ilUserSearchOptions::__appendUserDefinedFields	(	array	$fields,
		int	$counter
	)

static

Definition at line 212 of file class.ilUserSearchOptions.php.

                                                                                 : array
    {
        $user_defined_fields = ilUserDefinedFields::_getInstance();
        foreach ($user_defined_fields->getSearchableDefinitions() as $definition) {
            $fields[$counter]['values'] = ilUserSearchOptions::__prepareValues($definition['field_values']);
            $fields[$counter]['lang'] = $definition['field_name'];
            $fields[$counter]['db'] = $definition['field_id'];
 
            switch ($definition['field_type']) {
                case UDF_TYPE_TEXT:
                    $fields[$counter]['type'] = self::FIELD_TYPE_UDF_TEXT;
                    break;
 
                case UDF_TYPE_SELECT:
                    $fields[$counter]['type'] = self::FIELD_TYPE_UDF_SELECT;
                    break;
 
                case UDF_TYPE_WYSIWYG:
                    $fields[$counter]['type'] = self::FIELD_TYPE_UDF_WYSIWYG;
                    break;
 
                default:
                    // do not throw: udf plugin support
                    $fields[$counter]['type'] = $definition['field_type'];
                    break;
            }
            ++$counter;
        }
        return $fields;
    }

References __prepareValues(), ilUserDefinedFields\_getInstance(), FIELD_TYPE_UDF_SELECT, FIELD_TYPE_UDF_TEXT, FIELD_TYPE_UDF_WYSIWYG, UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

Referenced by _getSearchableFieldsInfo().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __prepareValues()

static ilUserSearchOptions::__prepareValues ( array $a_values )

static

Definition at line 243 of file class.ilUserSearchOptions.php.

                                                           : array
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        $new_values = array(0 => $lng->txt('please_choose'));
        foreach ($a_values as $value) {
            $new_values[$value] = $value;
        }
        return $new_values;
    }

References $DIC, and $lng.

Referenced by __appendUserDefinedFields().

Here is the caller graph for this function:

◆ _getPossibleFields()

static ilUserSearchOptions::_getPossibleFields ( bool $a_admin = false )

static

Definition at line 157 of file class.ilUserSearchOptions.php.

                                                                    : array
    {
        return array('gender',
                     'lastname',
                     'firstname',
                     'login',
                     'title',
                     'institution',
                     'department',
                     'street',
                     'zipcode',
                     'city',
                     'country',
                     'sel_country',
                     'email',
                     'second_email',
                     'hobby',
                     'org_units',
                     // begin-patch lok
                     'matriculation',
                     'interests_general',
                     'interests_help_offered',
                     'interests_help_looking'
        );
        // end-patch lok
    }

Referenced by _getSearchableFieldsInfo(), and _isSearchable().

Here is the caller graph for this function:

◆ _getSearchableFieldsInfo()

static ilUserSearchOptions::_getSearchableFieldsInfo ( bool $a_admin = false )

static

Todo:: : implement a more general solution

Definition at line 66 of file class.ilUserSearchOptions.php.

                                                                          : array
    {
        global $DIC;
 
        $lng = $DIC->language();
 
        // begin-patch lok
        $lng->loadLanguageModule('user');
        // end-patch lok
 
        $counter = 1;
        $fields = [];
        foreach (ilUserSearchOptions::_getPossibleFields($a_admin) as $field) {
            // TODO: check enabled
            // DONE
            if ($a_admin == false and !ilUserSearchOptions::_isEnabled($field)) {
                continue;
            }
            $fields[$counter]['values'] = array();
            $fields[$counter]['type'] = self::FIELD_TYPE_TEXT;
            $fields[$counter]['lang'] = $lng->txt($field);
            $fields[$counter]['db'] = $field;
 
            $fields[$counter]['autoComplete'] = false;
            switch ($field) {
                case 'login':
                case 'firstname':
                case 'lastname':
                case 'email':
                case 'second_email':
                    $fields[$counter]['autoComplete'] = true;
                    break;
 
                case 'title':
                    $fields[$counter]['lang'] = $lng->txt('person_title');
                    break;
 
                // SELECTS
 
                case 'gender':
                    $fields[$counter]['type'] = self::FIELD_TYPE_SELECT;
                    $fields[$counter]['values'] = array(
                        0 => $lng->txt('please_choose'),
                        'n' => $lng->txt('gender_n'),
                        'f' => $lng->txt('gender_f'),
                        'm' => $lng->txt('gender_m'),
                    );
                    break;
 
                case 'sel_country':
                    $fields[$counter]['type'] = self::FIELD_TYPE_SELECT;
                    $fields[$counter]['values'] = array(0 => $lng->txt('please_choose'));
 
                    // #7843 -- see ilCountrySelectInputGUI
                    $lng->loadLanguageModule('meta');
                    foreach (ilCountry::getCountryCodes() as $c) {
                        $fields[$counter]['values'][$c] = $lng->txt('meta_c_' . $c);
                    }
                    asort($fields[$counter]['values']);
                    break;
 
                case 'org_units':
                    $fields[$counter]['type'] = self::FIELD_TYPE_SELECT;
                    $paths = ilOrgUnitPathStorage::getTextRepresentationOfOrgUnits();
                    $options[0] = $lng->txt('select_one');
                    foreach ($paths as $org_ref_id => $path) {
                        $options[$org_ref_id] = $path;
                    }
 
                    $fields[$counter]['values'] = $options;
                    break;
 
 
                // begin-patch lok
                case 'interests_general':
                case 'interests_help_offered':
                case 'interests_help_looking':
                    $fields[$counter]['type'] = self::FIELD_TYPE_MULTI;
                    break;
            }
 
            ++$counter;
        }
        $fields = ilUserSearchOptions::__appendUserDefinedFields($fields, $counter);
 
        return $fields ?: array();
    }

References $c, $DIC, $lng, $path, __appendUserDefinedFields(), _getPossibleFields(), _isEnabled(), FIELD_TYPE_MULTI, FIELD_TYPE_SELECT, FIELD_TYPE_TEXT, ilCountry\getCountryCodes(), and ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits().

Referenced by ilRepositorySearchGUI\__performUserSearch(), and ilRepositorySearchGUI\initFormSearch().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isEnabled()

static ilUserSearchOptions::_isEnabled ( $a_key )

static

Definition at line 189 of file class.ilUserSearchOptions.php.

                                             : bool
    {
        global $DIC;
 
        $settings = $DIC->settings();
 
        // login is always enabled
        if ($a_key == 'login') {
            return true;
        }
        return (bool) $settings->get('search_enabled_' . $a_key);
    }

References $DIC, and ILIAS\LTI\ToolProvider\$settings.

Referenced by _getSearchableFieldsInfo(), ilUserFieldSettingsTableGUI\fillRow(), ilMailAutoCompleteUserProvider\getFields(), ilUserAutoComplete\getFields(), ilUserAutoComplete\getList(), ILIAS\MyStaff\ListCertificates\ilMStListCertificatesTableGUI\initFilter(), ILIAS\MyStaff\ListCompetences\Skills\ilMStListCompetencesSkillsTableGUI\initFilter(), ilMStListCoursesTableGUI\initFilter(), ILIAS\MyStaff\ListUsers\ilMStListUsersTableGUI\initFilter(), and ilRepositorySearchGUI\initFormSearch().

Here is the caller graph for this function:

◆ _isSearchable()

static ilUserSearchOptions::_isSearchable ( string $a_key )

static

Definition at line 184 of file class.ilUserSearchOptions.php.

                                                       : bool
    {
        return in_array($a_key, ilUserSearchOptions::_getPossibleFields());
    }

References _getPossibleFields().

Referenced by ilUserFieldSettingsTableGUI\fillRow(), and ilObjUserFolderGUI\saveGlobalUserSettingsObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _saveStatus()

static ilUserSearchOptions::_saveStatus	(	string	$a_key,
		bool	$a_enabled
	)

static

Definition at line 202 of file class.ilUserSearchOptions.php.

                                                                      : bool
    {
        global $DIC;
 
        $ilias = $DIC['ilias'];
 
        $ilias->setSetting('search_enabled_' . $a_key, (string) $a_enabled);
        return true;
    }

References $DIC.

Referenced by ilObjUserFolderGUI\saveGlobalUserSettingsObject().

Here is the caller graph for this function:

◆ getSelectableColumnInfo()

static ilUserSearchOptions::getSelectableColumnInfo ( bool $a_admin = false )

static

Get info of searchable fields for selectable columns in table gui.

Parameters

bool $a_admin

Returns: array

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

                                                                         : array
    {
        $col_info = array();
        foreach (self::_getSearchableFieldsInfo($a_admin) as $field) {
            if (is_numeric($field['db'])) {
                $field['db'] = 'udf_' . $field['db'];
            }
 
            $col_info[$field['db']] = array(
                'txt' => $field['lang']
            );
 
            if ($field['db'] == 'login' or $field['db'] == 'firstname' or $field['db'] == 'lastname') {
                $col_info[$field['db']]['default'] = true;
            }
        }
        return $col_info;
    }