ilLuceneHighlighterResultParser Class Reference

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

Collaboration diagram for ilLuceneHighlighterResultParser:

Public Member Functions
	__construct ()
	Contructor. More...
	getMaxScore ()
	setMaxScore ($a_score)
	getRelevance ($a_obj_id, $sub_id)
	get relevance More...
	setResultString ($a_res)
	set result xml string More...
	getResultString ()
	get result xml string More...
	parse ()
	parse More...
	getTitle ($a_obj_id, $a_sub_id)
	get title More...
	getDescription ($a_obj_id, $a_sub_id)
	get description More...
	getContent ($a_obj_id, $a_sub_id)
	get content More...
	getSubItemIds ($a_obj_id)
	get subitem ids More...

Private Attributes
	$result_string = ''
	$result = array()
	$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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilLuceneHighlighterResultParser::__construct

(

)

Contructor.

Returns

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

    {
    }

Member Function Documentation

getContent()

ilLuceneHighlighterResultParser::getContent	(		$a_obj_id,
			$a_sub_id
	)

get content

Parameters

int	obj_id
int	sub_item

Returns

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

    {
        return isset($this->result[$a_obj_id][$a_sub_id]['content']) ? $this->result[$a_obj_id][$a_sub_id]['content'] : null;
    }

getDescription()

ilLuceneHighlighterResultParser::getDescription	(		$a_obj_id,
			$a_sub_id
	)

get description

Parameters

int	obj_id
int	sub_item

Returns

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

    {
        return isset($this->result[$a_obj_id][$a_sub_id]['description']) ? $this->result[$a_obj_id][$a_sub_id]['description'] : null;
    }

getMaxScore()

ilLuceneHighlighterResultParser::getMaxScore

(

)

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

    {
        return $this->max_score;
    }

References $max_score.

Referenced by getRelevance().

Here is the caller graph for this function:

getRelevance()

ilLuceneHighlighterResultParser::getRelevance	(		$a_obj_id,
			$sub_id
	)

get relevance

Parameters

int

obj_id

Returns

int relevance in percent

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

    {
        if (!$this->getMaxScore()) {
            return 0;
        }
        
        $score = $this->result[$a_obj_id][$sub_id]['score'];
        return $score / $this->getMaxScore() * 100;
    }

References getMaxScore().

Here is the call graph for this function:

getResultString()

ilLuceneHighlighterResultParser::getResultString

(

)

get result xml string

Parameters

return

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

    {
        return $this->result_string;
    }

References $result_string.

Referenced by parse().

Here is the caller graph for this function:

getSubItemIds()

ilLuceneHighlighterResultParser::getSubItemIds

(

$a_obj_id

)

get subitem ids

Parameters

return

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

    {
        $sub_item_ids = array();
        if (!isset($this->result[$a_obj_id])) {
            return array();
        }
        foreach ($this->result[$a_obj_id] as $sub_item_id => $data) {
            if ($sub_item_id) {
                $sub_item_ids[] = $sub_item_id;
            }
        }
        return $sub_item_ids ? $sub_item_ids : array();
    }

References $data.

getTitle()

ilLuceneHighlighterResultParser::getTitle	(		$a_obj_id,
			$a_sub_id
	)

get title

Parameters

int	obj_id
int	sub_item

Returns

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

    {
        return isset($this->result[$a_obj_id][$a_sub_id]['title']) ? $this->result[$a_obj_id][$a_sub_id]['title'] : null;
    }

parse()

ilLuceneHighlighterResultParser::parse

(

)

parse

Returns

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

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

References $name, $root, ilLoggerFactory\getLogger(), getResultString(), and setMaxScore().

Here is the call graph for this function:

setMaxScore()

ilLuceneHighlighterResultParser::setMaxScore

(

$a_score

)

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

    {
        $this->max_score = $a_score;
    }

Referenced by parse().

Here is the caller graph for this function:

setResultString()

ilLuceneHighlighterResultParser::setResultString

(

$a_res

)

set result xml string

Parameters

return

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

    {
        $this->result_string = $a_res;
    }

Field Documentation

$max_score

ilLuceneHighlighterResultParser::$max_score = 0

private

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

Referenced by getMaxScore().

$result

ilLuceneHighlighterResultParser::$result = array()

private

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

$result_string

ilLuceneHighlighterResultParser::$result_string = ''

private

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

Referenced by getResultString().

---

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

• Services/Search/classes/Lucene/class.ilLuceneHighlighterResultParser.php