ILIAS\User\Search\AutocompleteQuery Class Reference

This class provides some pre-processing for search terms provided by a user when searching for users. More...

Collaboration diagram for ILIAS\User\Search\AutocompleteQuery:

Public Member Functions
	__construct (private readonly int $required_search_term_length, private readonly string $search_term,)
	checkSearchTermLength (?string $search_term)
	getUnprocessedSearchTerm ()
	The returned search term might contain wild cards or any other input. More...
	getSearchTermQueryString ()
	getLastnameQueryString ()
	getFirstnameQueryString ()

Private Attributes
string	$processed_search_term
string	$lastname_search_term = null
string	$firstname_search_term = null

Detailed Description

This class provides some pre-processing for search terms provided by a user when searching for users.

It treats strings containing one comma as being of the form lastname, firstname and parses them correspondingly.

Definition at line 28 of file AutocompleteQuery.php.

Constructor & Destructor Documentation

__construct()

ILIAS\User\Search\AutocompleteQuery::__construct	(	private readonly int	$required_search_term_length,
		private readonly string	$search_term
	)

Definition at line 34 of file AutocompleteQuery.php.

      {
        $this->processed_search_term = str_replace(
            ['%', '_'],
            ['\%', '\_'],
            trim($search_term)
        );
 
        $comma_separated = explode(',', $search_term);
 
        if (count($comma_separated) !== 2) {
            return;
        }
 
        $lastname_search_term = trim($comma_separated[0]);
        $firstname_search_term = trim($comma_separated[1]);
 
        if ($lastname_search_term . $firstname_search_term === '') {
            return;
        }
 
        $this->lastname_search_term = $lastname_search_term === '' ? null : $lastname_search_term;
        $this->firstname_search_term = $firstname_search_term === '' ? null : $firstname_search_term;
    }

References ILIAS\User\Search\AutocompleteQuery\$firstname_search_term, and ILIAS\User\Search\AutocompleteQuery\$lastname_search_term.

Member Function Documentation

checkSearchTermLength()

ILIAS\User\Search\AutocompleteQuery::checkSearchTermLength

(

?string

$search_term

)

Definition at line 61 of file AutocompleteQuery.php.

                                                               : bool
    {
        if ($search_term === null) {
            return false;
        }
        return mb_strlen($search_term) >= $this->required_search_term_length;
    }

getFirstnameQueryString()

ILIAS\User\Search\AutocompleteQuery::getFirstnameQueryString

(

)

Definition at line 106 of file AutocompleteQuery.php.

                                             : ?string
    {
        if ($this->firstname_search_term !== null) {
            return $this->firstname_search_term;
        }
 
        if ($this->lastname_search_term === null) {
            return $this->search_term;
        }
 
        return null;
    }

References ILIAS\User\Search\AutocompleteQuery\$firstname_search_term.

getLastnameQueryString()

ILIAS\User\Search\AutocompleteQuery::getLastnameQueryString

(

)

Definition at line 93 of file AutocompleteQuery.php.

                                            : ?string
    {
        if ($this->lastname_search_term !== null) {
            return $this->lastname_search_term;
        }
 
        if ($this->firstname_search_term === null) {
            return $this->search_term;
        }
 
        return null;
    }

References ILIAS\User\Search\AutocompleteQuery\$lastname_search_term.

getSearchTermQueryString()

ILIAS\User\Search\AutocompleteQuery::getSearchTermQueryString

(

)

Returns

string|null The return value will be null, if it is determined that a search for lastname and/or firstname is needed.

Definition at line 83 of file AutocompleteQuery.php.

                                              : ?string
    {
        if ($this->lastname_search_term !== null
            || $this->firstname_search_term !== null) {
            return null;
        }
 
        return $this->search_term;
    }

getUnprocessedSearchTerm()

ILIAS\User\Search\AutocompleteQuery::getUnprocessedSearchTerm

(

)

The returned search term might contain wild cards or any other input.

Please make sure to process the string to avoid any privacy issues.

Definition at line 73 of file AutocompleteQuery.php.

                                              : string
    {
        return $this->search_term;
    }

Field Documentation

$firstname_search_term

string ILIAS\User\Search\AutocompleteQuery::$firstname_search_term = null

private

Definition at line 32 of file AutocompleteQuery.php.

Referenced by ILIAS\User\Search\AutocompleteQuery\__construct(), and ILIAS\User\Search\AutocompleteQuery\getFirstnameQueryString().

$lastname_search_term

string ILIAS\User\Search\AutocompleteQuery::$lastname_search_term = null

private

Definition at line 31 of file AutocompleteQuery.php.

Referenced by ILIAS\User\Search\AutocompleteQuery\__construct(), and ILIAS\User\Search\AutocompleteQuery\getLastnameQueryString().

$processed_search_term

string ILIAS\User\Search\AutocompleteQuery::$processed_search_term

private

Definition at line 30 of file AutocompleteQuery.php.

---

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

• components/ILIAS/User/src/Search/AutocompleteQuery.php