ilUserSearchFilter Class Reference

Collaboration diagram for ilUserSearchFilter:

Public Member Functions
	__construct (int $a_usr_id)
	ilUserSearchFilter constructor. More...
	enableField (string $key)
	disableField (string $key)
	enableMemberFilter (bool $a_status)
	setPossibleUsers (array $a_users)
	getLimit ()
	limitReached ()
	getUserId ()
	storeQueryStrings (array $a_strings)
	getQueryString (string $a_field)
	getUsers ()
	__searchObjects ()
	__parseQueryString (string $a_string)
	parse query string, using query parser instance More...
	__storeEntries (ilSearchResult $new_res)
	__toArray (array $entries)
	memberFilter (int $a_usr_id, array $entry_data)

Protected Attributes
ilDBInterface	$db
ilSearchResult	$result_obj
ilSetting	$settings

Private Attributes
int	$limit = 0
bool	$limit_reached = false
bool	$stored = false
array	$search_fields
array bool	$enabled_member_filter = false
array	$possible_users = array()
int	$usr_id
ilGlobalTemplateInterface	$main_tpl

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilUserSearchFilter::__construct

(

int

$a_usr_id

)

ilUserSearchFilter constructor.

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

References $DIC, ILIAS\Repository\int(), and ILIAS\Repository\settings().

    {
        global $DIC;
        $this->main_tpl = $DIC->ui()->mainTemplate();

        $this->usr_id = $a_usr_id;
        $this->db = $DIC->database();
        $this->settings = $DIC->settings();

        // Limit of filtered objects is search max hits

        $this->limit = (int) $this->settings->get('search_mx_hits', '50');
        $this->result_obj = new ilSearchResult();
    }

Here is the call graph for this function:

Member Function Documentation

__parseQueryString()

ilUserSearchFilter::__parseQueryString

(

string

$a_string

)

parse query string, using query parser instance

Returns

ilQueryParser | string of query parser or error message if an error occured public

Definition at line 186 of file class.ilUserSearchFilter.php.

References ilQueryParser\QP_COMBINATION_OR, and ilUtil\stripSlashes().

Referenced by __searchObjects().

    {
        $query_parser = new ilQueryParser(ilUtil::stripSlashes($a_string));
        $query_parser->setCombination(ilQueryParser::QP_COMBINATION_OR);
        $query_parser->setMinWordLength(1);
        $query_parser->parse();

        if (!$query_parser->validate()) {
            return $query_parser->getMessage();
        }
        return $query_parser;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

__searchObjects()

ilUserSearchFilter::__searchObjects

(

)

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

References ILIAS\LTI\ToolProvider\$enabled, __parseQueryString(), __storeEntries(), __toArray(), ilObjectSearchFactory\_getUserSearchInstance(), ilSession\get(), and ROOT_FOLDER_ID.

                                     : array
    {
        foreach ($this->search_fields as $field => $enabled) {
            // Disabled ?
            if (!$enabled) {
                continue;
            }

            $session_usr_filter = ilSession::get('search_usr_filter');
            $query_string = (string) ($session_usr_filter[$field] ?? '');
            if (!$query_string) {
                continue;
            }
            if (!is_object($query_parser = $this->__parseQueryString($query_string))) {
                $this->main_tpl->setOnScreenMessage('info', $query_parser);
                return [];
            }
            $user_search = ilObjectSearchFactory::_getUserSearchInstance($query_parser);
            $user_search->setFields(array($field));

            // store entries
            $result_obj = $user_search->performSearch();
            $this->__storeEntries($result_obj);
        }

        // no filter entries
        if (is_object($this->result_obj)) {
            if ($this->enabled_member_filter) {
                $this->result_obj->addObserver($this, 'memberFilter');
            }
            $this->result_obj->filter(ROOT_FOLDER_ID, true);

            return $this->__toArray($this->result_obj->getResults());
        }
        return [];
    }

Here is the call graph for this function:

__storeEntries()

ilUserSearchFilter::__storeEntries

(

ilSearchResult

$new_res

)

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

Referenced by __searchObjects().

                                                           : bool
    {
        if ($this->stored == false) {
            $this->result_obj->mergeEntries($new_res);
            $this->stored = true;
            return true;
        } else {
            $this->result_obj->intersectEntries($new_res);
            return true;
        }
    }

Here is the caller graph for this function:

__toArray()

ilUserSearchFilter::__toArray

(

array

$entries

)

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

Referenced by __searchObjects().

                                             : array
    {
        $users = [];
        foreach ($entries as $entry) {
            $users[] = $entry['obj_id'];
        }
        return $users ?: array();
    }

Here is the caller graph for this function:

disableField()

ilUserSearchFilter::disableField

(

string

$key

)

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

References ILIAS\LTI\ToolProvider\$key.

                                             : void
    {
        $this->search_fields[$key] = true;
    }

enableField()

ilUserSearchFilter::enableField

(

string

$key

)

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

References ILIAS\LTI\ToolProvider\$key.

                                            : void
    {
        $this->search_fields[$key] = true;
    }

enableMemberFilter()

ilUserSearchFilter::enableMemberFilter

(

bool

$a_status

)

Definition at line 88 of file class.ilUserSearchFilter.php.

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

getLimit()

ilUserSearchFilter::getLimit

(

)

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

References $limit.

                              : int
    {
        return $this->limit;
    }

getQueryString()

ilUserSearchFilter::getQueryString

(

string

$a_field

)

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

References ilSession\get().

                                                   : string
    {
        $session_usr_filter = ilSession::get('search_usr_filter') ?? [];
        return $session_usr_filter[$a_field] ?? '';
    }

Here is the call graph for this function:

getUserId()

ilUserSearchFilter::getUserId

(

)

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

References $usr_id.

                               : int
    {
        return $this->usr_id;
    }

getUsers()

ilUserSearchFilter::getUsers

(

)

Definition at line 126 of file class.ilUserSearchFilter.php.

References ILIAS\LTI\ToolProvider\$enabled, $possible_users, and ilSession\get().

                              : array
    {
        // Check if a query string is given
        foreach ($this->search_fields as $field => $enabled) {
            if (!$enabled) {
                continue;
            }
            $session_search_usr_filter = (array) (ilSession::get('search_usr_filter') ?? []);
            $filter_field = (string) ($session_search_usr_filter[$field] ?? '');
            if (strlen($filter_field)) {
                $search = true;
                break;
            }
        }
        return $this->possible_users;
    }

Here is the call graph for this function:

limitReached()

ilUserSearchFilter::limitReached

(

)

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

References $limit_reached.

                                  : bool
    {
        return $this->limit_reached;
    }

memberFilter()

ilUserSearchFilter::memberFilter	(	int	$a_usr_id,
		array	$entry_data
	)

Definition at line 222 of file class.ilUserSearchFilter.php.

                                                                  : bool
    {
        return in_array($a_usr_id, $this->possible_users);
    }

setPossibleUsers()

ilUserSearchFilter::setPossibleUsers

(

array

$a_users

)

Definition at line 93 of file class.ilUserSearchFilter.php.

                                                    : void
    {
        $this->possible_users = $a_users ?: array();
    }

storeQueryStrings()

ilUserSearchFilter::storeQueryStrings

(

array

$a_strings

)

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

References ilSession\set().

                                                       : void
    {
        ilSession::set('search_usr_filter', $a_strings);
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilUserSearchFilter::$db

protected

Definition at line 57 of file class.ilUserSearchFilter.php.

$enabled_member_filter

array bool ilUserSearchFilter::$enabled_member_filter = false

private

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

$limit

int ilUserSearchFilter::$limit = 0

private

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

Referenced by getLimit().

$limit_reached

bool ilUserSearchFilter::$limit_reached = false

private

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

Referenced by limitReached().

$main_tpl

ilGlobalTemplateInterface ilUserSearchFilter::$main_tpl

private

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

$possible_users

array ilUserSearchFilter::$possible_users = array()

private

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

Referenced by getUsers().

$result_obj

ilSearchResult ilUserSearchFilter::$result_obj

protected

Definition at line 58 of file class.ilUserSearchFilter.php.

$search_fields

array ilUserSearchFilter::$search_fields

private

Initial value:

=
        [
            'login' => true

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

$settings

ilSetting ilUserSearchFilter::$settings

protected

Definition at line 59 of file class.ilUserSearchFilter.php.

$stored

bool ilUserSearchFilter::$stored = false

private

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

$usr_id

int ilUserSearchFilter::$usr_id

private

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

Referenced by getUserId().

---

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

• Services/Search/classes/class.ilUserSearchFilter.php