ilLuceneHighlighterResultParser Class Reference

Parses result XML from lucene search highlight. More...

Collaboration diagram for ilLuceneHighlighterResultParser:

Public Member Functions
	getMaxScore ()
	setMaxScore (float $score)
	getRelevance (int $obj_id, int $sub_id, string $sub_type)
	setResultString (string $a_res)
	getResultString ()
	parse ()
	parse More...
	getTitle (int $obj_id, int $sub_id, string $sub_type)
	getDescription (int $obj_id, int $sub_id, string $sub_type)
	getContent (int $obj_id, int $sub_id, string $sub_type)
	getSubItemIds (int $obj_id)

Private Attributes
string	$result_string = ''
array	$result = []
float	$max_score = 0

Detailed Description

Parses result XML from lucene search highlight.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

getContent()

ilLuceneHighlighterResultParser::getContent	(	int	$obj_id,
		int	$sub_id,
		string	$sub_type
	)

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

                                                                          : string
    {
        return $this->result[$obj_id][$sub_type . '__' . $sub_id]['content'] ?? '';
    }

Referenced by ILIAS\Search\Presentation\Result\ResultPresenterImpl\getLuceneSearchResultAsPanel().

Here is the caller graph for this function:

getDescription()

ilLuceneHighlighterResultParser::getDescription	(	int	$obj_id,
		int	$sub_id,
		string	$sub_type
	)

Definition at line 108 of file class.ilLuceneHighlighterResultParser.php.

                                                                              : string
    {
        return $this->result[$obj_id][$sub_type . '__' . $sub_id]['description'] ?? '';
    }

Referenced by ILIAS\Search\Presentation\Result\ResultPresenterImpl\getLuceneSearchResultAsPanel().

Here is the caller graph for this function:

getMaxScore()

ilLuceneHighlighterResultParser::getMaxScore

(

)

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

                                 : float
    {
        return $this->max_score;
    }

References $max_score.

Referenced by getRelevance().

Here is the caller graph for this function:

getRelevance()

ilLuceneHighlighterResultParser::getRelevance	(	int	$obj_id,
		int	$sub_id,
		string	$sub_type
	)

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

                                                                            : float
    {
        if (!$this->getMaxScore()) {
            return 0;
        }
 
        $score = $this->result[$obj_id][$sub_type . '__' . $sub_id]['score'] ?? 0;
        return $score / $this->getMaxScore() * 100;
    }

References getMaxScore().

Referenced by ILIAS\Search\Presentation\Result\ResultPresenterImpl\getLuceneSearchResultAsPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

getResultString()

ilLuceneHighlighterResultParser::getResultString

(

)

Definition at line 63 of file class.ilLuceneHighlighterResultParser.php.

                                     : string
    {
        return $this->result_string;
    }

References $result_string.

Referenced by parse().

Here is the caller graph for this function:

getSubItemIds()

ilLuceneHighlighterResultParser::getSubItemIds

(

int

$obj_id

)

Returns

list<array{id: int, type: string}>

Definition at line 121 of file class.ilLuceneHighlighterResultParser.php.

                                              : array
    {
        $sub_item_ids = [];
        if (!isset($this->result[$obj_id])) {
            return [];
        }
        foreach ($this->result[$obj_id] as $data) {
            if ($data['id'] <= 0) {
                continue;
            }
            $sub_item_ids[] = ['id' => (int) $data['id'], 'type' => (string) $data['type']];
        }
        return $sub_item_ids;
    }

References $data, and ILIAS\Repository\int().

Referenced by ILIAS\Search\Presentation\Result\ResultPresenterImpl\getLuceneSearchResultAsPanel().

Here is the call graph for this function:

Here is the caller graph for this function:

getTitle()

ilLuceneHighlighterResultParser::getTitle	(	int	$obj_id,
		int	$sub_id,
		string	$sub_type
	)

Definition at line 103 of file class.ilLuceneHighlighterResultParser.php.

                                                                        : string
    {
        return $this->result[$obj_id][$sub_type . '__' . $sub_id]['title'] ?? '';
    }

Referenced by ILIAS\Search\Presentation\Result\ResultPresenterImpl\getLuceneSearchResultAsPanel().

Here is the caller graph for this function:

parse()

ilLuceneHighlighterResultParser::parse

(

)

parse

Returns

bool

Definition at line 72 of file class.ilLuceneHighlighterResultParser.php.

                           : bool
    {
        if (!strlen($this->getResultString())) {
            return false;
        }
        ilLoggerFactory::getLogger('src')->debug($this->getResultString());
        $root = new SimpleXMLElement($this->getResultString());
        $this->setMaxScore((float) $root['maxScore']);
        foreach ($root->children() as $object) {
            $obj_id = (string) $object['id'];
            foreach ($object->children() as $item) {
                $sub_type = (string) $item['type'];
                $sub_id = (string) $item['id'];
 
                $this->result[$obj_id][$sub_type . '__' . $sub_id]['id'] = $sub_id;
                $this->result[$obj_id][$sub_type . '__' . $sub_id]['type'] = $sub_type;
 
                // begin-patch mime_filter
                $score = (string) $item['absoluteScore'];
                $this->result[$obj_id][$sub_type . '__' . $sub_id]['score'] = $score;
                // end-patch mime_filter
 
                foreach ($item->children() as $field) {
                    $name = (string) $field['name'];
                    $this->result[$obj_id][$sub_type . '__' . $sub_id][$name] = (string) $field;
                }
            }
        }
        return true;
    }

References ilLoggerFactory\getLogger(), getResultString(), and setMaxScore().

Here is the call graph for this function:

setMaxScore()

ilLuceneHighlighterResultParser::setMaxScore

(

float

$score

)

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

                                             : void
    {
        $this->max_score = $score;
    }

Referenced by parse().

Here is the caller graph for this function:

setResultString()

ilLuceneHighlighterResultParser::setResultString

(

string

$a_res

)

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

                                                  : void
    {
        $this->result_string = $a_res;
    }

Field Documentation

$max_score

float ilLuceneHighlighterResultParser::$max_score = 0

private

Definition at line 34 of file class.ilLuceneHighlighterResultParser.php.

Referenced by getMaxScore().

$result

array ilLuceneHighlighterResultParser::$result = []

private

Definition at line 33 of file class.ilLuceneHighlighterResultParser.php.

$result_string

string ilLuceneHighlighterResultParser::$result_string = ''

private

Definition at line 32 of file class.ilLuceneHighlighterResultParser.php.

Referenced by getResultString().

---

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

• components/ILIAS/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php