ilMailLuceneQueryParser Class Reference

Inheritance diagram for ilMailLuceneQueryParser:

Collaboration diagram for ilMailLuceneQueryParser:

Public Member Functions
	parse ()
	setFields (array $fields)
	Set the fields to query for ILIAS 10: the values are not boolean, but different query strings for the fields. More...
	getFields ()
	Get the fields to query for ILIAS 10 the values are not boolean, but different query strings for the fields. More...
Public Member Functions inherited from ilLuceneQueryParser
	__construct ($a_query_string)
	Constructor. More...
	parse ()
	parse query string More...
	parseAutoWildcard ()
	Append asterisk for remote search from global search form field. More...
	getQuery ()

Private Attributes
array	$fields = []

Additional Inherited Members
Static Public Member Functions inherited from ilLuceneQueryParser
static	validateQuery ($a_query)
Protected Member Functions inherited from ilLuceneQueryParser
	replaceOwnerCallback (array $matches)
	Replace owner callback (preg_replace_callback) More...
Static Protected Member Functions inherited from ilLuceneQueryParser
static	checkAllowedCharacters (string $query)
	Check allowed characters. More...
static	checkAsterisk (string $query)
	Check asterisk. More...
static	checkAmpersands (string $query)
	Check ampersands. More...
static	checkCaret (string $query)
	Check carets. More...
static	checkSquiggle (string $query)
	Check squiggles. More...
static	checkExclamationMark (string $query)
	Check exclamation marks (replacement for NOT) More...
static	checkQuestionMark (string $query)
	Check question mark (wild card single character) More...
static	checkParenthesis (string $a_query)
	Check parenthesis. More...
static	checkPlusMinus (string $a_query)
	Check plus minus. More...
static	checkANDORNOT (string $a_query)
	Check AND OR NOT. More...
static	checkQuotes (string $a_query)
	Check quotes. More...
static	checkColon (string $a_query)
	Check colon. More...
Protected Attributes inherited from ilLuceneQueryParser
string	$query_string
string	$parsed_query = ''

Detailed Description

Definition at line 21 of file class.ilMailLuceneQueryParser.php.

Member Function Documentation

getFields()

ilMailLuceneQueryParser::getFields

(

)

Get the fields to query for ILIAS 10 the values are not boolean, but different query strings for the fields.

Returns

array{'title': ?string, 'content': ?string, 'mattachment': ?string, 'msender': ?string}|array{}

Definition at line 78 of file class.ilMailLuceneQueryParser.php.

References $fields.

Referenced by parse().

                               : array
    {
        return $this->fields;
    }

Here is the caller graph for this function:

parse()

ilMailLuceneQueryParser::parse

(

)

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

References ilLuceneQueryParser\$query_string, $token, getFields(), ilSearchSettings\getInstance(), and ilSearchSettings\OPERATOR_AND.

                           : void
    {
        if (!empty($this->getFields())) {
            $queried_fields = [];
            $token_operator = ' OR ';
            if (ilSearchSettings::getInstance()->getDefaultOperator() === ilSearchSettings::OPERATOR_AND) {
                $token_operator = ' AND ';
            }

            // ILIAS 10: each filter field has now its own query string
            foreach ($this->getFields() as $field => $query_string) {
                if (empty($query_string)) {
                    continue;
                }

                $field_query = '';
                $tokens = array_map(trim(...), explode(' ', $query_string));
                foreach ($tokens as $token) {
                    if ($field_query !== '') {
                        $field_query .= $token_operator;
                    }
                    $field_query .= '(' . $field . ':' . $token . ')';
                }

                $queried_fields[] = '(' . $field_query . ')';
            }

            if ($queried_fields !== []) {
                $this->parsed_query = implode(' OR ', $queried_fields);
                return;
            }
        }

        parent::parse();
    }

Here is the call graph for this function:

setFields()

ilMailLuceneQueryParser::setFields

(

array

$fields

)

Set the fields to query for ILIAS 10: the values are not boolean, but different query strings for the fields.

Parameters

array{'title'

?string, 'content': ?string, 'mattachment': ?string, 'msender': ?string}|array{} $fields

Definition at line 68 of file class.ilMailLuceneQueryParser.php.

References $fields.

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

Field Documentation

$fields

array ilMailLuceneQueryParser::$fields = []

private

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

Referenced by getFields(), and setFields().

---

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

• components/ILIAS/Mail/classes/class.ilMailLuceneQueryParser.php