ilQueryParser Class Reference

Collaboration diagram for ilQueryParser:

Public Member Functions
	__construct (string $a_query_str)
	setMinWordLength (int $a_length)
	getMinWordLength ()
	setGlobalMinLength (int $a_value)
	getGlobalMinLength ()
	setAllowedWildcards (bool $a_value)
	getAllowedWildcards ()
	setMessage (string $a_msg)
	getMessage ()
	appendMessage (string $a_msg)
	setCombination (string $a_combination)
	getCombination ()
	getQueryString ()
	getWords ()
	getQuotedWords (bool $with_quotation=false)
	getLuceneQueryString ()
	parse ()
	__parseQuotation ()
	validate ()

Data Fields
const	MIN_WORD_LENGTH = 3
	Minimum of characters required for search. More...
const	QP_COMBINATION_AND = 'and'
const	QP_COMBINATION_OR = 'or'

Protected Attributes
ilLanguage	$lng
ilSearchSettings	$settings

Private Attributes
int	$min_word_length = 0
int	$global_min_length = 0
string	$query_str
array	$quoted_words = array()
string	$message
string	$combination = ''
bool	$wildcards_allowed
array	$words

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilQueryParser::__construct

(

string

$a_query_str

)

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

References $DIC, ilSearchSettings\getInstance(), ILIAS\Repository\lng(), setAllowedWildcards(), setMinWordLength(), and ILIAS\Repository\settings().

    {
        global $DIC;

        $this->lng = $DIC->language();
        $this->settings = ilSearchSettings::getInstance();

        if (!defined('MIN_WORD_LENGTH')) {
            define('MIN_WORD_LENGTH', self::MIN_WORD_LENGTH);
        }


        $this->query_str = $a_query_str;
        $this->message = '';

        $this->setMinWordLength(1);

        $this->setAllowedWildcards(false);
    }

Here is the call graph for this function:

Member Function Documentation

__parseQuotation()

ilQueryParser::__parseQuotation

(

)

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

References getAllowedWildcards(), and getQueryString().

Referenced by parse().

                                      : bool
    {
        if (!strlen($this->getQueryString())) {
            $this->quoted_words[] = '';
            return false;
        }
        $query_str = $this->getQueryString();
        while (preg_match("/\".*?\"/", $query_str, $matches)) {
            $query_str = str_replace($matches[0], '', $query_str);
            $this->quoted_words[] = $matches[0];
        }

        // Parse the rest
        $words = explode(' ', trim($query_str));
        foreach ($words as $word) {
            if (!strlen(trim($word))) {
                continue;
            }

            $this->quoted_words[] = $word;
        }

        if (!$this->getAllowedWildcards()) {
            // #14768
            foreach ($this->quoted_words as $idx => $word) {
                if (!stristr($word, '\\')) {
                    $word = str_replace('%', '\%', $word);
                    $word = str_replace('_', '\_', $word);
                }
                $this->quoted_words[$idx] = $word;
            }
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

appendMessage()

ilQueryParser::appendMessage

(

string

$a_msg

)

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

References getMessage().

                                                : void
    {
        if (strlen($this->getMessage())) {
            $this->message .= '<br />';
        }
        $this->message .= $a_msg;
    }

Here is the call graph for this function:

getAllowedWildcards()

ilQueryParser::getAllowedWildcards

(

)

Definition at line 106 of file class.ilQueryParser.php.

References $wildcards_allowed.

Referenced by __parseQuotation(), and parse().

                                         : bool
    {
        return $this->wildcards_allowed;
    }

Here is the caller graph for this function:

getCombination()

ilQueryParser::getCombination

(

)

Definition at line 131 of file class.ilQueryParser.php.

References $combination.

Referenced by getLuceneQueryString().

                                    : string
    {
        return $this->combination;
    }

Here is the caller graph for this function:

getGlobalMinLength()

ilQueryParser::getGlobalMinLength

(

)

Definition at line 96 of file class.ilQueryParser.php.

References $global_min_length.

Referenced by validate().

                                        : int
    {
        return $this->global_min_length;
    }

Here is the caller graph for this function:

getLuceneQueryString()

ilQueryParser::getLuceneQueryString

(

)

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

References getCombination(), and getQuotedWords().

                                          : string
    {
        $counter = 0;
        $tmp_str = "";
        foreach ($this->getQuotedWords(true) as $word) {
            if ($counter++) {
                $tmp_str .= (" " . strtoupper($this->getCombination()) . " ");
            }
            $tmp_str .= $word;
        }
        return $tmp_str;
    }

Here is the call graph for this function:

getMessage()

ilQueryParser::getMessage

(

)

Definition at line 115 of file class.ilQueryParser.php.

References $message.

Referenced by appendMessage(), and validate().

                                : string
    {
        return $this->message;
    }

Here is the caller graph for this function:

getMinWordLength()

ilQueryParser::getMinWordLength

(

)

Definition at line 82 of file class.ilQueryParser.php.

References $min_word_length.

Referenced by parse(), and validate().

                                      : int
    {
        return $this->min_word_length;
    }

Here is the caller graph for this function:

getQueryString()

ilQueryParser::getQueryString

(

)

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

Referenced by __parseQuotation(), parse(), and validate().

                                    : string
    {
        return trim($this->query_str);
    }

Here is the caller graph for this function:

getQuotedWords()

ilQueryParser::getQuotedWords

(

bool

$with_quotation = false

)

Returns

string[]

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

Referenced by getLuceneQueryString(), and ilAdvancedMDFieldDefinitionText\searchObjects().

                                                                : array
    {
        if ($with_quotation) {
            return $this->quoted_words ?: [];
        }

        foreach ($this->quoted_words as $word) {
            $tmp_word[] = str_replace("\"", '', $word);
        }
        return $tmp_word ?? [];
    }

Here is the caller graph for this function:

getWords()

ilQueryParser::getWords

(

)

Returns

string[]

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

Referenced by validate().

                              : array
    {
        return $this->words ?? array();
    }

Here is the caller graph for this function:

parse()

ilQueryParser::parse

(

)

Definition at line 176 of file class.ilQueryParser.php.

References __parseQuotation(), getAllowedWildcards(), getMinWordLength(), getQueryString(), ILIAS\Repository\lng(), and setMessage().

                           : bool
    {
        $this->words = array();


        $words = explode(' ', trim($this->getQueryString()));
        foreach ($words as $word) {
            if (!strlen(trim($word))) {
                continue;
            }

            if (strlen(trim($word)) < $this->getMinWordLength()) {
                $this->setMessage(sprintf($this->lng->txt('search_minimum_info'), $this->getMinWordLength()));
                continue;
            }

            $this->words[] = $word;
        }

        $fullstr = trim($this->getQueryString());
        if (!in_array($fullstr, $this->words)) {
            $this->words[] = $fullstr;
        }

        if (!$this->getAllowedWildcards()) {
            // #14768
            foreach ($this->words as $idx => $word) {
                if (!stristr($word, '\\')) {
                    $word = str_replace('%', '\%', $word);
                    $word = str_replace('_', '\_', $word);
                }
                $this->words[$idx] = $word;
            }
        }

        // Parse strings like && 'A "B C D" E' as 'A' && 'B C D' && 'E'
        // Can be used in LIKE search or fulltext search > MYSQL 4.0
        $this->__parseQuotation();

        return true;
    }

Here is the call graph for this function:

setAllowedWildcards()

ilQueryParser::setAllowedWildcards

(

bool

$a_value

)

Definition at line 101 of file class.ilQueryParser.php.

Referenced by __construct().

                                                      : void
    {
        $this->wildcards_allowed = $a_value;
    }

Here is the caller graph for this function:

setCombination()

ilQueryParser::setCombination

(

string

$a_combination

)

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

                                                         : void
    {
        $this->combination = $a_combination;
    }

setGlobalMinLength()

ilQueryParser::setGlobalMinLength

(

int

$a_value

)

Definition at line 87 of file class.ilQueryParser.php.

                                                    : void
    {
        if ($a_value < 1) {
            return;
        }

        $this->global_min_length = $a_value;
    }

setMessage()

ilQueryParser::setMessage

(

string

$a_msg

)

Definition at line 111 of file class.ilQueryParser.php.

Referenced by parse(), and validate().

                                             : void
    {
        $this->message = $a_msg;
    }

Here is the caller graph for this function:

setMinWordLength()

ilQueryParser::setMinWordLength

(

int

$a_length

)

Definition at line 77 of file class.ilQueryParser.php.

Referenced by __construct(), ilLDAPSettingsGUI\loadRoleAssignmentRule(), ilAuthShibbolethSettingsGUI\loadRule(), and ilUserStartingPointGUI\saveStartingPoint().

                                                   : void
    {
        $this->min_word_length = $a_length;
    }

Here is the caller graph for this function:

validate()

ilQueryParser::validate

(

)

Definition at line 253 of file class.ilQueryParser.php.

References getGlobalMinLength(), getMessage(), getMinWordLength(), getQueryString(), getWords(), ILIAS\Repository\lng(), and setMessage().

                              : bool
    {
        // Words with less than 3 characters
        if (strlen($this->getMessage())) {
            return false;
        }
        // No search string given
        if ($this->getMinWordLength() and !count($this->getWords())) {
            $this->setMessage($this->lng->txt('msg_no_search_string'));
            return false;
        }
        // No search string given
        if ($this->getGlobalMinLength() and strlen(str_replace('"', '', $this->getQueryString())) < $this->getGlobalMinLength()) {
            $this->setMessage(sprintf($this->lng->txt('search_minimum_info'), $this->getGlobalMinLength()));
            return false;
        }

        return true;
    }

Here is the call graph for this function:

Field Documentation

$combination

string ilQueryParser::$combination = ''

private

Definition at line 49 of file class.ilQueryParser.php.

Referenced by getCombination().

$global_min_length

int ilQueryParser::$global_min_length = 0

private

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

Referenced by getGlobalMinLength().

$lng

ilLanguage ilQueryParser::$lng

protected

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

$message

string ilQueryParser::$message

private

Definition at line 48 of file class.ilQueryParser.php.

Referenced by getMessage().

$min_word_length

int ilQueryParser::$min_word_length = 0

private

Definition at line 43 of file class.ilQueryParser.php.

Referenced by getMinWordLength().

$query_str

string ilQueryParser::$query_str

private

Definition at line 46 of file class.ilQueryParser.php.

$quoted_words

array ilQueryParser::$quoted_words = array()

private

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

$settings

ilSearchSettings ilQueryParser::$settings

protected

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

$wildcards_allowed

bool ilQueryParser::$wildcards_allowed

private

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

Referenced by getAllowedWildcards().

$words

array ilQueryParser::$words

private

Definition at line 54 of file class.ilQueryParser.php.

MIN_WORD_LENGTH

const ilQueryParser::MIN_WORD_LENGTH = 3

Minimum of characters required for search.

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

Referenced by ilUserAutoComplete\getList().

QP_COMBINATION_AND

const ilQueryParser::QP_COMBINATION_AND = 'and'

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

Referenced by ilRepositorySearchGUI\__parseQueryString(), ilSoapObjectAdministration\getObjectsByTitle(), ilLDAPSettingsGUI\loadRoleAssignmentRule(), ilAuthShibbolethSettingsGUI\loadRule(), ilObjStudyProgrammeAutoMembershipsGUI\parseQueryString(), ilRepositoryObjectDetailSearch\performDBSearch(), ilUserStartingPointGUI\saveStartingPoint(), ilSoapObjectAdministration\searchObjects(), ilLPTableBaseGUI\searchObjects(), ilDclRecordEditGUI\searchObjects(), ilSoapRBACAdministration\searchRoles(), ilObjectCopyGUI\searchSource(), ilInternalLink\searchUsers(), ilMailSearchGUI\showResults(), ilLDAPSettingsGUI\showRoleSelection(), and ilUserStartingPointGUI\showRoleSelection().

QP_COMBINATION_OR

const ilQueryParser::QP_COMBINATION_OR = 'or'

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

Referenced by ilAbstractSearch\__createLocateString(), ilUserSearchFilter\__parseQueryString(), ilRepositorySearchGUI\__parseQueryString(), ilAdvancedSearchGUI\__performContentSearch(), ilAdvancedSearchGUI\__performEntitySearch(), ilAdvancedSearchGUI\__performGeneralSearch(), ilAdvancedSearchGUI\__performKeywordSearch(), ilAdvancedSearchGUI\__performLifecycleSearch(), ilAdvancedSearchGUI\__performTaxonSearch(), ilAdvancedSearchGUI\__performTitleSearch(), ILIAS\UI\Component\Legacy\Content\Filter\FilterManager\apply(), ilRepositoryObjectDetailSearch\performDBSearch(), ilSoapObjectAdministration\searchObjects(), ilSoapRBACAdministration\searchRoles(), and ilCalendarCategoryGUI\sharePerformSearch().

---

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

• components/ILIAS/Search/classes/class.ilQueryParser.php