Auto completion class for user lists. More...

Inheritance diagram for ilUserAutoComplete:

Collaboration diagram for ilUserAutoComplete:

Public Member Functions
	__construct ()
	Default constructor. More...

	respectMinimumSearchCharacterCount ($a_status)

	getRespectMinimumSearchCharacterCount ()

	setLimit ($a_limit)

	getLimit ()

	setSearchType ($search_type)

	getSearchType ()

	setPrivacyMode ($privacy_mode)

	getPrivacyMode ()

	setUser ($user)

	getUser ()

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

	isFieldSearchableCheckEnabled ()
	Searchable check enabled. More...

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

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

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

	getSearchFields ()
	get possible search fields More...

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

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

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

	isMoreLinkAvailable ()

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

	parseQueryString ($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 ()

	getOrderByPart ()

Private Attributes
	$logger = null

	$searchable_check = false

	$user_access_check = true

	$possible_fields = array()

	$result_field

	$search_type

	$privacy_mode

	$user

	$limit = 0

	$user_limitations = true

	$respect_min_search_character_count = true

	$more_link_available = false

Detailed Description

Auto completion class for user lists.

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

Constructor & Destructor Documentation

◆ __construct()

ilUserAutoComplete::__construct ( )

Default constructor.

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

    {
        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();
    }

References $DIC, setPrivacyMode(), and setSearchType().

Here is the call graph for this function:

Member Function Documentation

◆ enableFieldSearchableCheck()

ilUserAutoComplete::enableFieldSearchableCheck ( $a_status )

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

Parameters

bool $a_status

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

    {
        $this->searchable_check = $a_status;
    }

◆ enableUserAccessCheck()

ilUserAutoComplete::enableUserAccessCheck ( $a_status )

Enable user access check.

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

Parameters

bool $a_status

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

    {
        $this->user_access_check = $a_status;
    }

◆ getFields()

ilUserAutoComplete::getFields ( )

protected

Get searchable fields.

Returns: array

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

    {
        if (!$this->isFieldSearchableCheckEnabled()) {
            return $this->getSearchFields();
        }
        $available_fields = array();
        foreach ($this->getSearchFields() as $field) {
            include_once 'Services/Search/classes/class.ilUserSearchOptions.php';
            if (ilUserSearchOptions::_isEnabled($field)) {
                $available_fields[] = $field;
            }
        }
        return $available_fields;
    }

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

Here is the call graph for this function:

◆ getLimit()

ilUserAutoComplete::getLimit ( )

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

    {
        return $this->limit;
    }

References $limit.

◆ getOrderByPart()

ilUserAutoComplete::getOrderByPart ( )

protected

Returns: string

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

    {
        return 'login ASC';
    }

◆ getPrivacyMode()

ilUserAutoComplete::getPrivacyMode ( )

Returns: int

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

    {
        return $this->privacy_mode;
    }

References $privacy_mode.

Referenced by getSelectPart().

Here is the caller graph for this function:

◆ getRespectMinimumSearchCharacterCount()

ilUserAutoComplete::getRespectMinimumSearchCharacterCount ( )

Returns: bool

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

    {
        return $this->respect_min_search_character_count;
    }

References $respect_min_search_character_count.

◆ getSearchFields()

ilUserAutoComplete::getSearchFields ( )

get possible search fields

Returns: array

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

    {
        return $this->possible_fields;
    }

References $possible_fields.

Referenced by getFields().

Here is the caller graph for this function:

◆ getSearchType()

ilUserAutoComplete::getSearchType ( )

Returns: mixed

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

    {
        return $this->search_type;
    }

References $search_type.

◆ getSelectPart()

ilUserAutoComplete::getSelectPart ( )

protected

Returns: string

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

    {
        $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);
    }

References getPrivacyMode().

Here is the call graph for this function:

◆ getUser()

ilUserAutoComplete::getUser ( )

Returns: ilObjUser

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

    {
        return $this->user;
    }

References $user.

Referenced by ilOnScreenChatUserUserAutoComplete\getWherePart().

Here is the caller graph for this function:

◆ getUserLimitations()

ilUserAutoComplete::getUserLimitations ( )

allow user limitations like inactive and access limitations

Returns: bool

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

    {
        return $this->user_limitations;
    }

References $user_limitations.

◆ isFieldSearchableCheckEnabled()

ilUserAutoComplete::isFieldSearchableCheckEnabled ( )

Searchable check enabled.

Returns: bool

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

    {
        return $this->searchable_check;
    }

References $searchable_check.

Referenced by getFields().

Here is the caller graph for this function:

◆ isMoreLinkAvailable()

ilUserAutoComplete::isMoreLinkAvailable ( )

Returns: boolean

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

    {
        return $this->more_link_available;
    }

References $more_link_available.

◆ isUserAccessCheckEnabled()

ilUserAutoComplete::isUserAccessCheckEnabled ( )

Check if user access check is enabled.

Returns: bool

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

    {
        return $this->user_access_check;
    }

References $user_access_check.

◆ parseQueryString()

ilUserAutoComplete::parseQueryString ( $a_query )

Parse query string.

Parameters

string $a_query

Returns: $query

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

    {
        $query = array();
        
        if (!stristr($a_query, '\\')) {
            $a_query = str_replace('%', '\%', $a_query);
            $a_query = str_replace('_', '\_', $a_query);
        }
 
        $query['query'] = trim($a_query);
        
        // "," means fixed search for lastname, firstname
        if (strpos($a_query, ',')) {
            $comma_separated = (array) 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 = (array) explode(' ', $a_query);
            foreach ($whitespace_separated as $part) {
                if (trim($part)) {
                    $query['parts'][] = trim($part);
                }
            }
        }
        
        $this->logger->dump($query, ilLogLevel::DEBUG);
        
        return $query;
    }

References $query, and ilLogLevel\DEBUG.

◆ respectMinimumSearchCharacterCount()

ilUserAutoComplete::respectMinimumSearchCharacterCount ( $a_status )

Parameters

bool $a_status

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

    {
        $this->respect_min_search_character_count = $a_status;
    }

◆ setLimit()

ilUserAutoComplete::setLimit ( $a_limit )

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

    {
        $this->limit = $a_limit;
    }

◆ setMoreLinkAvailable()

ilUserAutoComplete::setMoreLinkAvailable ( $more_link_available )

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

Parameters

boolean $more_link_available

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

    {
        $this->more_link_available = $more_link_available;
    }

References $more_link_available.

◆ setPrivacyMode()

ilUserAutoComplete::setPrivacyMode ( $privacy_mode )

Parameters

int $privacy_mode

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

    {
        $this->privacy_mode = $privacy_mode;
    }

References $privacy_mode.

Referenced by __construct().

Here is the caller graph for this function:

◆ setResultField()

ilUserAutoComplete::setResultField ( $a_field )

Set result field.

Parameters

string $a_field

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

    {
        $this->result_field = $a_field;
    }

◆ setSearchFields()

ilUserAutoComplete::setSearchFields ( $a_fields )

Set searchable fields.

Parameters

array $a_fields

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

    {
        $this->possible_fields = $a_fields;
    }

◆ setSearchType()

ilUserAutoComplete::setSearchType ( $search_type )

Parameters

int $search_type

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

    {
        $this->search_type = $search_type;
    }

References $search_type.

Referenced by __construct().

Here is the caller graph for this function:

◆ setUser()

ilUserAutoComplete::setUser ( $user )

Parameters

ilObjUser $user

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

    {
        $this->user = $user;
    }

References $user, and user().

Here is the call graph for this function:

◆ setUserLimitations()

ilUserAutoComplete::setUserLimitations ( $a_limitations )

allow user limitations like inactive and access limitations

Parameters

bool $a_limitations

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

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

Field Documentation

◆ $limit

ilUserAutoComplete::$limit = 0

private

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

Referenced by getLimit().

◆ $logger

ilUserAutoComplete::$logger = null

private

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

◆ $more_link_available

ilUserAutoComplete::$more_link_available = false

private

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

Referenced by isMoreLinkAvailable(), and setMoreLinkAvailable().

◆ $possible_fields

ilUserAutoComplete::$possible_fields = array()

private

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

Referenced by getSearchFields().

◆ $privacy_mode

ilUserAutoComplete::$privacy_mode

private

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

Referenced by getPrivacyMode(), and setPrivacyMode().

◆ $respect_min_search_character_count

ilUserAutoComplete::$respect_min_search_character_count = true

private

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

Referenced by getRespectMinimumSearchCharacterCount().

◆ $result_field

ilUserAutoComplete::$result_field

private

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

◆ $search_type

ilUserAutoComplete::$search_type

private

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

Referenced by getSearchType(), and setSearchType().

◆ $searchable_check

ilUserAutoComplete::$searchable_check = false

private

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

Referenced by isFieldSearchableCheckEnabled().

◆ $user

ilUserAutoComplete::$user

private

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

Referenced by getUser(), and setUser().

◆ $user_access_check

ilUserAutoComplete::$user_access_check = true

private

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

Referenced by isUserAccessCheckEnabled().

◆ $user_limitations

ilUserAutoComplete::$user_limitations = true

private

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

Referenced by getUserLimitations().

◆ MAX_ENTRIES

const ilUserAutoComplete::MAX_ENTRIES = 1000

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

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

◆ PRIVACY_MODE_IGNORE_USER_SETTING

const ilUserAutoComplete::PRIVACY_MODE_IGNORE_USER_SETTING = 2

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

◆ PRIVACY_MODE_RESPECT_USER_SETTING

const ilUserAutoComplete::PRIVACY_MODE_RESPECT_USER_SETTING = 1

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

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

◆ SEARCH_TYPE_EQUALS

const ilUserAutoComplete::SEARCH_TYPE_EQUALS = 2

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

Referenced by ilChatroomInviteUsersToPrivateRoomGUI\getUserList().

◆ SEARCH_TYPE_LIKE

const ilUserAutoComplete::SEARCH_TYPE_LIKE = 1

Definition at line 15 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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ enableFieldSearchableCheck()

◆ enableUserAccessCheck()

◆ getFields()

◆ getLimit()

◆ getOrderByPart()

◆ getPrivacyMode()

◆ getRespectMinimumSearchCharacterCount()

◆ getSearchFields()

◆ getSearchType()

◆ getSelectPart()

◆ getUser()

◆ getUserLimitations()

◆ 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_limitations

◆ MAX_ENTRIES

◆ PRIVACY_MODE_IGNORE_USER_SETTING

◆ PRIVACY_MODE_RESPECT_USER_SETTING

◆ SEARCH_TYPE_EQUALS

◆ SEARCH_TYPE_LIKE