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

Inheritance diagram for ilUserAutoComplete:

Collaboration diagram for ilUserAutoComplete:

Public Member Functions
	__construct ()

	respectMinimumSearchCharacterCount (bool $a_status)

	getRespectMinimumSearchCharacterCount ()

	addUserAccessFilterCallable (Closure $user_filter)
	Closure for filtering users e.g $rep_search_gui->addUserAccessFilterCallable(function($user_ids) use($ref_id,$rbac_perm,$pos_perm)) { // filter users return $filtered_users }. More...

	setLimit (int $a_limit)

	getLimit ()

	setSearchType (int $search_type)

	getSearchType ()

	setPrivacyMode (int $privacy_mode)

	getPrivacyMode ()

	setUser (ilObjUser $user)

	getUser ()

	enableFieldSearchableCheck (bool $a_status)
	Enable the check whether the field is searchable in Administration -> Settings -> Standard Fields. More...

	isFieldSearchableCheckEnabled ()

	enableUserAccessCheck (bool $a_status)
	Enable user access check. More...

	isUserAccessCheckEnabled ()
	Check if user access check is enabled. More...

	setSearchFields (array $a_fields)
	Set searchable fields. More...

	getSearchFields ()
	get possible search fields More...

	setResultField (string $a_field)
	Set result field. More...

	getList (string $a_str)
	Get completion list. More...

	setUserLimitations (bool $a_limitations)
	allow user limitations like inactive and access limitations More...

	getUserLimitations ()
	allow user limitations like inactive and access limitations More...

	isMoreLinkAvailable ()

	setMoreLinkAvailable (bool $more_link_available)
	IMPORTANT: remember to read request parameter 'fetchall' to use this function. More...

	parseQueryString (string $a_query)
	Parse query string. More...

Data Fields
const	MAX_ENTRIES = 1000

const	SEARCH_TYPE_LIKE = 1

const	SEARCH_TYPE_EQUALS = 2

const	PRIVACY_MODE_RESPECT_USER_SETTING = 1

const	PRIVACY_MODE_IGNORE_USER_SETTING = 2

Protected Member Functions
	getFields ()
	Get searchable fields. More...

	getSelectPart ()

	getFromPart ()

	getWherePart (array $search_query)

	getOrderByPart ()

	getQueryConditionByFieldAndValue (string $field, array $query)

Protected Attributes
Closure	$user_filter = null

Private Attributes
ilLogger	$logger = null

bool	$searchable_check = false

bool	$user_access_check = true

array	$possible_fields = array()

string	$result_field

int	$search_type

int	$privacy_mode

ilObjUser	$user = null

int	$limit = 0

bool	$user_limitations = true

bool	$respect_min_search_character_count = true

bool	$more_link_available = false

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 Auto completion class for user lists

Definition at line 22 of file class.ilUserAutoComplete.php.

Constructor & Destructor Documentation

◆ __construct()

ilUserAutoComplete::__construct ( )

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

References $DIC, ILIAS\Repository\logger(), setPrivacyMode(), and setSearchType().

     {
         global $DIC;
 
         $this->result_field = 'login';
 
         $this->setSearchType(self::SEARCH_TYPE_LIKE);
         $this->setPrivacyMode(self::PRIVACY_MODE_IGNORE_USER_SETTING);
 
         $this->logger = $DIC->logger()->user();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addUserAccessFilterCallable()

ilUserAutoComplete::addUserAccessFilterCallable ( Closure $user_filter )

Closure for filtering users e.g $rep_search_gui->addUserAccessFilterCallable(function($user_ids) use($ref_id,$rbac_perm,$pos_perm)) { // filter users return $filtered_users }.

Definition at line 74 of file class.ilUserAutoComplete.php.

References $user_filter.

                                                                      : void
     {
         $this->user_filter = $user_filter;
     }

◆ enableFieldSearchableCheck()

ilUserAutoComplete::enableFieldSearchableCheck ( bool $a_status )

Enable the check whether the field is searchable in Administration -> Settings -> Standard Fields.

Definition at line 122 of file class.ilUserAutoComplete.php.

                                                               : void
     {
         $this->searchable_check = $a_status;
     }

◆ enableUserAccessCheck()

ilUserAutoComplete::enableUserAccessCheck ( bool $a_status )

Enable user access check.

See also: Administration -> User Accounts -> Settings -> General Settings

Definition at line 136 of file class.ilUserAutoComplete.php.

                                                          : void
     {
         $this->user_access_check = $a_status;
     }

◆ getFields()

ilUserAutoComplete::getFields ( )

protected

Get searchable fields.

Definition at line 168 of file class.ilUserAutoComplete.php.

References ilUserSearchOptions\_isEnabled(), getSearchFields(), and isFieldSearchableCheckEnabled().

Referenced by getWherePart().

                                   : array // Missing array type.
     {
         if (!$this->isFieldSearchableCheckEnabled()) {
             return $this->getSearchFields();
         }
         $available_fields = array();
         foreach ($this->getSearchFields() as $field) {
             if (ilUserSearchOptions::_isEnabled($field)) {
                 $available_fields[] = $field;
             }
         }
         return $available_fields;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFromPart()

ilUserAutoComplete::getFromPart ( )

protected

Definition at line 303 of file class.ilUserAutoComplete.php.

References $DIC, $ilDB, and getPrivacyMode().

Referenced by getList().

                                     : string
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $joins = array();
 
         if (self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode()) {
             $joins[] = 'LEFT JOIN usr_pref profpref
                                 ON profpref.usr_id = ud.usr_id
                                 AND profpref.keyword = ' . $ilDB->quote('public_profile', 'text');
 
             $joins[] = 'LEFT JOIN usr_pref pubemail
                                 ON pubemail.usr_id = ud.usr_id
                                 AND pubemail.keyword = ' . $ilDB->quote('public_email', 'text');
 
             $joins[] = 'LEFT JOIN usr_pref pubsecondemail
                                 ON pubsecondemail.usr_id = ud.usr_id
                                 AND pubsecondemail.keyword = ' . $ilDB->quote('public_second_email', 'text');
         }
 
         if ($joins) {
             return 'usr_data ud ' . implode(' ', $joins);
         } else {
             return 'usr_data ud';
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLimit()

ilUserAutoComplete::getLimit ( )

Definition at line 84 of file class.ilUserAutoComplete.php.

References $limit.

Referenced by getList().

                               : int
     {
         return $this->limit;
     }

Here is the caller graph for this function:

◆ getList()

ilUserAutoComplete::getList ( string $a_str )

Get completion list.

Definition at line 193 of file class.ilUserAutoComplete.php.

References $DIC, $ilDB, $query, $res, ilUserSearchOptions\_isEnabled(), ilLogLevel\DEBUG, getFromPart(), ilSearchSettings\getInstance(), getLimit(), getOrderByPart(), getPrivacyMode(), getSelectPart(), getWherePart(), isFieldSearchableCheckEnabled(), isMoreLinkAvailable(), ILIAS\Repository\logger(), ilQueryParser\MIN_WORD_LENGTH, parseQueryString(), and ilStr\strLen().

                                           : string
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $parsed_query = $this->parseQueryString($a_str);
 
         if (ilStr::strLen($parsed_query['query']) < ilQueryParser::MIN_WORD_LENGTH) {
             $result_json['items'] = [];
             $result_json['hasMoreResults'] = false;
             $this->logger->debug('Autocomplete search rejected: minimum characters count.');
             return json_encode($result_json);
         }
 
 
         $select_part = $this->getSelectPart();
         $where_part = $this->getWherePart($parsed_query);
         $order_by_part = $this->getOrderByPart();
         $query = implode(" ", array(
             'SELECT ' . $select_part,
             'FROM ' . $this->getFromPart(),
             $where_part ? 'WHERE ' . $where_part : '',
             $order_by_part ? 'ORDER BY ' . $order_by_part : ''
         ));
 
         $this->logger->debug('Query: ' . $query);
 
         $res = $ilDB->query($query);
 
         // add email only if it is "searchable"
         $add_email = true;
         if ($this->isFieldSearchableCheckEnabled() && !ilUserSearchOptions::_isEnabled("email")) {
             $add_email = false;
         }
 
         $add_second_email = true;
         if ($this->isFieldSearchableCheckEnabled() && !ilUserSearchOptions::_isEnabled("second_email")) {
             $add_second_email = false;
         }
 
         $max = $this->getLimit() ?: ilSearchSettings::getInstance()->getAutoCompleteLength();
         $cnt = 0;
         $more_results = false;
         $result = array();
         $recs = array();
         $usrIds = array();
         while (($rec = $ilDB->fetchAssoc($res)) && $cnt < ($max + 1)) {
             if ($cnt >= $max && $this->isMoreLinkAvailable()) {
                 $more_results = true;
                 break;
             }
             $recs[$rec['usr_id']] = $rec;
             $usrIds[] = $rec['usr_id'];
             $cnt++;
         }
         $callable_name = null;
         if (is_callable($this->user_filter, true, $callable_name)) {
             $usrIds = call_user_func($this->user_filter, $usrIds);
         }
         foreach ($usrIds as $usr_id) {
             $rec = $recs[$usr_id];
 
             if (self::PRIVACY_MODE_RESPECT_USER_SETTING != $this->getPrivacyMode() || in_array($rec['profile_value'], ['y','g'])) {
                 $label = $rec['lastname'] . ', ' . $rec['firstname'] . ' [' . $rec['login'] . ']';
             } else {
                 $label = '[' . $rec['login'] . ']';
             }
 
             if ($add_email && $rec['email'] && (self::PRIVACY_MODE_RESPECT_USER_SETTING != $this->getPrivacyMode() || 'y' == $rec['email_value'])) {
                 $label .= ', ' . $rec['email'];
             }
 
             if ($add_second_email && $rec['second_email'] && (self::PRIVACY_MODE_RESPECT_USER_SETTING != $this->getPrivacyMode() || 'y' == $rec['second_email_value'])) {
                 $label .= ', ' . $rec['second_email'];
             }
 
             $result[$cnt]['value'] = (string) $rec[$this->result_field];
             $result[$cnt]['label'] = $label;
             $result[$cnt]['id'] = $rec['usr_id'];
             $cnt++;
         }
 
         $result_json['items'] = $result;
         $result_json['hasMoreResults'] = $more_results;
 
         $this->logger->dump($result_json, ilLogLevel::DEBUG);
 
         return json_encode($result_json, JSON_THROW_ON_ERROR);
     }

Here is the call graph for this function:

◆ getOrderByPart()

ilUserAutoComplete::getOrderByPart ( )

protected

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

Referenced by getList().

                                        : string
     {
         return 'login ASC';
     }

Here is the caller graph for this function:

◆ getPrivacyMode()

ilUserAutoComplete::getPrivacyMode ( )

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

References $privacy_mode.

Referenced by getFromPart(), getList(), getSelectPart(), and getWherePart().

                                     : int
     {
         return $this->privacy_mode;
     }

Here is the caller graph for this function:

◆ getQueryConditionByFieldAndValue()

ilUserAutoComplete::getQueryConditionByFieldAndValue	(	string	$field,
		array	$query
	)

protected

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

References $DIC, $ilDB, and getSearchType().

Referenced by getWherePart().

                                                                                     : string // Missing array type.
     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $query_strings = array($query['query']);
 
         if (array_key_exists($field, $query)) {
             $query_strings = array($query[$field]);
         } elseif (array_key_exists('parts', $query)) {
             $query_strings = $query['parts'];
         }
 
         $query_condition = '( ';
         $num = 0;
         foreach ($query_strings as $query_string) {
             if ($num++ > 0) {
                 $query_condition .= ' OR ';
             }
             if (self::SEARCH_TYPE_LIKE == $this->getSearchType()) {
                 $query_condition .= $ilDB->like($field, 'text', $query_string . '%');
             } else {
                 $query_condition .= $ilDB->like($field, 'text', $query_string);
             }
         }
         $query_condition .= ')';
         return $query_condition;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRespectMinimumSearchCharacterCount()

ilUserAutoComplete::getRespectMinimumSearchCharacterCount ( )

Definition at line 61 of file class.ilUserAutoComplete.php.

References $respect_min_search_character_count.

                                                            : bool
     {
         return $this->respect_min_search_character_count;
     }

◆ getSearchFields()

ilUserAutoComplete::getSearchFields ( )

get possible search fields

Definition at line 160 of file class.ilUserAutoComplete.php.

References $possible_fields.

Referenced by getFields().

                                      : array // Missing array type.
     {
         return $this->possible_fields;
     }

Here is the caller graph for this function:

◆ getSearchType()

ilUserAutoComplete::getSearchType ( )

Definition at line 94 of file class.ilUserAutoComplete.php.

References $search_type.

Referenced by getQueryConditionByFieldAndValue().

                                    : int
     {
         return $this->search_type;
     }

Here is the caller graph for this function:

◆ getSelectPart()

ilUserAutoComplete::getSelectPart ( )

protected

Definition at line 283 of file class.ilUserAutoComplete.php.

References getPrivacyMode().

Referenced by getList().

                                       : string
     {
         $fields = array(
             'ud.usr_id',
             'ud.login',
             'ud.firstname',
             'ud.lastname',
             'ud.email',
             'ud.second_email'
         );
 
         if (self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode()) {
             $fields[] = 'profpref.value profile_value';
             $fields[] = 'pubemail.value email_value';
             $fields[] = 'pubsecondemail.value second_email_value';
         }
 
         return implode(', ', $fields);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUser()

ilUserAutoComplete::getUser ( )

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

References $user.

Referenced by ilOnScreenChatUserUserAutoComplete\getWherePart(), and getWherePart().

                              : ?ilObjUser
     {
         return $this->user;
     }

Here is the caller graph for this function:

◆ getUserLimitations()

ilUserAutoComplete::getUserLimitations ( )

allow user limitations like inactive and access limitations

Definition at line 473 of file class.ilUserAutoComplete.php.

References $user_limitations.

Referenced by getWherePart().

                                         : bool
     {
         return $this->user_limitations;
     }

Here is the caller graph for this function:

◆ getWherePart()

ilUserAutoComplete::getWherePart ( array $search_query )

protected

Definition at line 332 of file class.ilUserAutoComplete.php.

References $DIC, $ilDB, $ilSetting, ILIAS\LTI\ToolProvider\$settings, ANONYMOUS_USER_ID, getFields(), ilUserFilter\getInstance(), ilUserAccountSettings\getInstance(), ilSearchSettings\getInstance(), getPrivacyMode(), getQueryConditionByFieldAndValue(), getUser(), and getUserLimitations().

Referenced by getList().

                                                         : string // Missing array type.
     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilSetting = $DIC->settings();
 
         $outer_conditions = array();
 
         // In 'anonymous' context with respected user privacy, only users with globally published profiles should be found.
         if (self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode() &&
             $this->getUser() instanceof ilObjUser &&
             $this->getUser()->isAnonymous()
         ) {
             if (!$ilSetting->get('enable_global_profiles', '0')) {
                 // If 'Enable User Content Publishing' is not set in the administration, no user should be found for 'anonymous' context.
                 return '1 = 2';
             } else {
                 // Otherwise respect the profile activation setting of every user (as a global (outer) condition in the where clause).
                 $outer_conditions[] = 'profpref.value = ' . $ilDB->quote('g', 'text');
             }
         }
 
         $outer_conditions[] = 'ud.usr_id != ' . $ilDB->quote(ANONYMOUS_USER_ID, 'integer');
 
         $field_conditions = array();
         foreach ($this->getFields() as $field) {
             $field_condition = $this->getQueryConditionByFieldAndValue($field, $search_query);
 
             if ('email' == $field && self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode()) {
                 // If privacy should be respected, the profile setting of every user concerning the email address has to be
                 // respected (in every user context, no matter if the user is 'logged in' or 'anonymous').
                 $email_query = array();
                 $email_query[] = $field_condition;
                 $email_query[] = 'pubemail.value = ' . $ilDB->quote('y', 'text');
                 $field_conditions[] = '(' . implode(' AND ', $email_query) . ')';
             } elseif ('second_email' == $field && self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode()) {
                 // If privacy should be respected, the profile setting of every user concerning the email address has to be
                 // respected (in every user context, no matter if the user is 'logged in' or 'anonymous').
                 $email_query = array();
                 $email_query[] = $field_condition;
                 $email_query[] = 'pubsecondemail.value = ' . $ilDB->quote('y', 'text');
                 $field_conditions[] = '(' . implode(' AND ', $email_query) . ')';
             } else {
                 $field_conditions[] = $field_condition;
             }
         }
 
         // If the current user context ist 'logged in' and privacy should be respected, all fields >>>except the login<<<
         // should only be searchable if the users' profile is published (y oder g)
         // In 'anonymous' context we do not need this additional conditions,
         // because we checked the privacy setting in the condition above: profile = 'g'
         if (self::PRIVACY_MODE_RESPECT_USER_SETTING == $this->getPrivacyMode() &&
             $this->getUser() instanceof ilObjUser && !$this->getUser()->isAnonymous() &&
             $field_conditions
         ) {
             $fields = '(' . implode(' OR ', $field_conditions) . ')';
 
             $field_conditions = [
                 '(' . implode(' AND ', array(
                 $fields,
                 $ilDB->in('profpref.value', array('y', 'g'), false, 'text')
                 )) . ')'
             ];
         }
 
         // The login field must be searchable regardless (for 'logged in' users) of any privacy settings.
         // We handled the general condition for 'anonymous' context above: profile = 'g'
         $field_conditions[] = $this->getQueryConditionByFieldAndValue('login', $search_query);
 
         if (ilUserAccountSettings::getInstance()->isUserAccessRestricted()) {
             $outer_conditions[] = $ilDB->in('time_limit_owner', ilUserFilter::getInstance()->getFolderIds(), false, 'integer');
         }
 
         if ($field_conditions) {
             $outer_conditions[] = '(' . implode(' OR ', $field_conditions) . ')';
         }
 
         $settings = ilSearchSettings::getInstance();
 
         if (!$settings->isInactiveUserVisible() && $this->getUserLimitations()) {
             $outer_conditions[] = "ud.active = " . $ilDB->quote(1, 'integer');
         }
 
         if (!$settings->isLimitedUserVisible() && $this->getUserLimitations()) {
             $unlimited = "ud.time_limit_unlimited = " . $ilDB->quote(1, 'integer');
             $from = "ud.time_limit_from < " . $ilDB->quote(time(), 'integer');
             $until = "ud.time_limit_until > " . $ilDB->quote(time(), 'integer');
 
             $outer_conditions[] = '(' . $unlimited . ' OR (' . $from . ' AND ' . $until . '))';
         }
 
         return implode(' AND ', $outer_conditions);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFieldSearchableCheckEnabled()

ilUserAutoComplete::isFieldSearchableCheckEnabled ( )

Definition at line 127 of file class.ilUserAutoComplete.php.

References $searchable_check.

Referenced by getFields(), and getList().

                                                    : bool
     {
         return $this->searchable_check;
     }

Here is the caller graph for this function:

◆ isMoreLinkAvailable()

ilUserAutoComplete::isMoreLinkAvailable ( )

Definition at line 478 of file class.ilUserAutoComplete.php.

References $more_link_available.

Referenced by getList().

                                          : bool
     {
         return $this->more_link_available;
     }

Here is the caller graph for this function:

◆ isUserAccessCheckEnabled()

ilUserAutoComplete::isUserAccessCheckEnabled ( )

Check if user access check is enabled.

Definition at line 144 of file class.ilUserAutoComplete.php.

References $user_access_check.

                                               : bool
     {
         return $this->user_access_check;
     }

◆ parseQueryString()

ilUserAutoComplete::parseQueryString ( string $a_query )

Parse query string.

Definition at line 494 of file class.ilUserAutoComplete.php.

References $query, ilLogLevel\DEBUG, and ILIAS\Repository\logger().

Referenced by getList().

                                                      : array // Missing array type.
     {
         $query = array();
 
         if (strpos($a_query, '\\') === false) {
             $a_query = str_replace(['%', '_'], ['\%', '\_'], $a_query);
         }
 
         $query['query'] = trim($a_query);
 
         // "," means fixed search for lastname, firstname
         if (strpos($a_query, ',')) {
             $comma_separated = explode(',', $a_query);
 
             if (count($comma_separated) == 2) {
                 if (trim($comma_separated[0])) {
                     $query['lastname'] = trim($comma_separated[0]);
                 }
                 if (trim($comma_separated[1])) {
                     $query['firstname'] = trim($comma_separated[1]);
                 }
             }
         } else {
             $whitespace_separated = explode(' ', $a_query);
             foreach ($whitespace_separated as $part) {
                 if (trim($part)) {
                     $query['parts'][] = trim($part);
                 }
             }
         }
 
         $this->logger->dump($query, ilLogLevel::DEBUG);
 
         return $query;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ respectMinimumSearchCharacterCount()

ilUserAutoComplete::respectMinimumSearchCharacterCount ( bool $a_status )

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

                                                                       : void
     {
         $this->respect_min_search_character_count = $a_status;
     }

◆ setLimit()

ilUserAutoComplete::setLimit ( int $a_limit )

Definition at line 79 of file class.ilUserAutoComplete.php.

                                           : void
     {
         $this->limit = $a_limit;
     }

◆ setMoreLinkAvailable()

ilUserAutoComplete::setMoreLinkAvailable ( bool $more_link_available )

IMPORTANT: remember to read request parameter 'fetchall' to use this function.

Definition at line 486 of file class.ilUserAutoComplete.php.

References $more_link_available.

                                                                    : void
     {
         $this->more_link_available = $more_link_available;
     }

◆ setPrivacyMode()

ilUserAutoComplete::setPrivacyMode ( int $privacy_mode )

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

References $privacy_mode.

Referenced by __construct().

                                                      : void
     {
         $this->privacy_mode = $privacy_mode;
     }

Here is the caller graph for this function:

◆ setResultField()

ilUserAutoComplete::setResultField ( string $a_field )

Set result field.

Definition at line 185 of file class.ilUserAutoComplete.php.

                                                    : void
     {
         $this->result_field = $a_field;
     }

◆ setSearchFields()

ilUserAutoComplete::setSearchFields ( array $a_fields )

Set searchable fields.

Definition at line 152 of file class.ilUserAutoComplete.php.

Referenced by ilCmiXapiStatementsGUI\asyncUserAutocompleteCmd(), ilLTIConsumerXapiStatementsGUI\asyncUserAutocompleteCmd(), and ilLTIConsumerGradeSynchronizationGUI\asyncUserAutocompleteCmd().

                                                     : void // Missing array type.
     {
         $this->possible_fields = $a_fields;
     }

Here is the caller graph for this function:

◆ setSearchType()

ilUserAutoComplete::setSearchType ( int $search_type )

Definition at line 89 of file class.ilUserAutoComplete.php.

References $search_type.

Referenced by __construct().

                                                    : void
     {
         $this->search_type = $search_type;
     }

Here is the caller graph for this function:

◆ setUser()

ilUserAutoComplete::setUser ( ilObjUser $user )

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

References $user, and ILIAS\Repository\user().

                                             : void
     {
         $this->user = $user;
     }

Here is the call graph for this function:

◆ setUserLimitations()

ilUserAutoComplete::setUserLimitations ( bool $a_limitations )

allow user limitations like inactive and access limitations

Definition at line 465 of file class.ilUserAutoComplete.php.

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

Field Documentation

◆ $limit

int ilUserAutoComplete::$limit = 0

private

Definition at line 38 of file class.ilUserAutoComplete.php.

Referenced by getLimit().

◆ $logger

ilLogger ilUserAutoComplete::$logger = null

private

Definition at line 30 of file class.ilUserAutoComplete.php.

◆ $more_link_available

bool ilUserAutoComplete::$more_link_available = false

private

Definition at line 41 of file class.ilUserAutoComplete.php.

Referenced by isMoreLinkAvailable(), and setMoreLinkAvailable().

◆ $possible_fields

array ilUserAutoComplete::$possible_fields = array()

private

Definition at line 33 of file class.ilUserAutoComplete.php.

Referenced by getSearchFields().

◆ $privacy_mode

int ilUserAutoComplete::$privacy_mode

private

Definition at line 36 of file class.ilUserAutoComplete.php.

Referenced by getPrivacyMode(), and setPrivacyMode().

◆ $respect_min_search_character_count

bool ilUserAutoComplete::$respect_min_search_character_count = true

private

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

Referenced by getRespectMinimumSearchCharacterCount().

◆ $result_field

string ilUserAutoComplete::$result_field

private

Definition at line 34 of file class.ilUserAutoComplete.php.

◆ $search_type

int ilUserAutoComplete::$search_type

private

Definition at line 35 of file class.ilUserAutoComplete.php.

Referenced by getSearchType(), and setSearchType().

◆ $searchable_check

bool ilUserAutoComplete::$searchable_check = false

private

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

Referenced by isFieldSearchableCheckEnabled().

◆ $user

ilObjUser ilUserAutoComplete::$user = null

private

Definition at line 37 of file class.ilUserAutoComplete.php.

Referenced by getUser(), and setUser().

◆ $user_access_check

bool ilUserAutoComplete::$user_access_check = true

private

Definition at line 32 of file class.ilUserAutoComplete.php.

Referenced by isUserAccessCheckEnabled().

◆ $user_filter

Closure ilUserAutoComplete::$user_filter = null

protected

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

Referenced by addUserAccessFilterCallable().

◆ $user_limitations

bool ilUserAutoComplete::$user_limitations = true

private

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

Referenced by getUserLimitations().

◆ MAX_ENTRIES

const ilUserAutoComplete::MAX_ENTRIES = 1000

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

Referenced by ilTermsOfServiceAcceptanceHistoryGUI\addUserAutoComplete(), ilLocalUserGUI\addUserAutoCompleteObject(), ilObjUserFolderGUI\addUserAutoCompleteObject(), ilObjCategoryGUI\addUserAutoCompleteObject(), ilSurveyRaterGUI\doAutoComplete(), ilObjSurveyGUI\doAutoCompleteObject(), ilRepositorySearchGUI\doUserAutoComplete(), ilCalendarAppointmentGUI\doUserAutoComplete(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), and ilOnScreenChatGUI\getUserList().

◆ PRIVACY_MODE_IGNORE_USER_SETTING

const ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING = 2

Definition at line 28 of file class.ilUserAutoComplete.php.

Referenced by ilObjEmployeeTalkGUI\executeCommand().

◆ PRIVACY_MODE_RESPECT_USER_SETTING

const ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING = 1

Definition at line 27 of file class.ilUserAutoComplete.php.

Referenced by ilSurveyRaterGUI\doAutoComplete(), ilCalendarAppointmentGUI\doUserAutoComplete(), ilExSubmissionTeamGUI\executeCommand(), ilChatroomInviteUsersToPrivateRoomGUI\getUserList(), ilOnScreenChatGUI\getUserList(), ilRepositorySearchGUI\performSearch(), and ilRepositorySearchGUI\showSearch().

◆ SEARCH_TYPE_EQUALS

const ilUserAutoComplete::SEARCH_TYPE_EQUALS = 2

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

Referenced by ilChatroomInviteUsersToPrivateRoomGUI\getUserList().

◆ SEARCH_TYPE_LIKE

const ilUserAutoComplete::SEARCH_TYPE_LIKE = 1

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

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

Services/User/classes/class.ilUserAutoComplete.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUserAccessFilterCallable()

◆ enableFieldSearchableCheck()

◆ enableUserAccessCheck()

◆ getFields()

◆ getFromPart()

◆ getLimit()

◆ getList()

◆ getOrderByPart()

◆ getPrivacyMode()

◆ getQueryConditionByFieldAndValue()

◆ getRespectMinimumSearchCharacterCount()

◆ getSearchFields()

◆ getSearchType()

◆ getSelectPart()

◆ getUser()

◆ getUserLimitations()

◆ getWherePart()

◆ isFieldSearchableCheckEnabled()

◆ isMoreLinkAvailable()

◆ isUserAccessCheckEnabled()

◆ parseQueryString()

◆ respectMinimumSearchCharacterCount()

◆ setLimit()

◆ setMoreLinkAvailable()

◆ setPrivacyMode()

◆ setResultField()

◆ setSearchFields()

◆ setSearchType()

◆ setUser()

◆ setUserLimitations()

Field Documentation

◆ $limit

◆ $logger

◆ $more_link_available

◆ $possible_fields

◆ $privacy_mode

◆ $respect_min_search_character_count

◆ $result_field

◆ $search_type

◆ $searchable_check

◆ $user

◆ $user_access_check

◆ $user_filter

◆ $user_limitations

◆ MAX_ENTRIES

◆ PRIVACY_MODE_IGNORE_USER_SETTING

◆ PRIVACY_MODE_RESPECT_USER_SETTING

◆ SEARCH_TYPE_EQUALS

◆ SEARCH_TYPE_LIKE