ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
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.

49 {
50
51 }

Member Function Documentation

◆ getContent()

ilLuceneHighlighterResultParser::getContent (   $a_obj_id,
  $a_sub_id 
)

get content

Parameters
intobj_id
intsub_item
Returns

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

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

◆ getDescription()

ilLuceneHighlighterResultParser::getDescription (   $a_obj_id,
  $a_sub_id 
)

get description

Parameters
intobj_id
intsub_item
Returns

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

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

◆ getMaxScore()

ilLuceneHighlighterResultParser::getMaxScore ( )

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

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
intobj_id
Returns
int relevance in percent

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

70 {
71 if(!$this->getMaxScore())
72 {
73 return 0;
74 }
75
76 $score = $this->result[$a_obj_id][$sub_id]['score'];
77 return $score / $this->getMaxScore() * 100;
78 }

References getMaxScore().

+ Here is the call graph for this function:

◆ getResultString()

ilLuceneHighlighterResultParser::getResultString ( )

get result xml string

Parameters

return

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

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 180 of file class.ilLuceneHighlighterResultParser.php.

181 {
182 $sub_item_ids = array();
183 if(!isset($this->result[$a_obj_id]))
184 {
185 return array();
186 }
187 foreach($this->result[$a_obj_id] as $sub_item_id => $data)
188 {
189 if($sub_item_id)
190 {
191 $sub_item_ids[] = $sub_item_id;
192 }
193 }
194 return $sub_item_ids ? $sub_item_ids : array();
195 }
$data

References $data.

◆ getTitle()

ilLuceneHighlighterResultParser::getTitle (   $a_obj_id,
  $a_sub_id 
)

get title

Parameters
intobj_id
intsub_item
Returns

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

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

◆ parse()

ilLuceneHighlighterResultParser::parse ( )

parse

Returns

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

107 {
108 if(!strlen($this->getResultString()))
109 {
110 return false;
111 }
112 $root = new SimpleXMLElement($this->getResultString());
113
114 // begin-patch mime_filter
115 $this->setMaxScore((string) $root['maxScore']);
116 // end-patch mime_filter
117
118
119 foreach($root->children() as $object)
120 {
121 $obj_id = (string) $object['id'];
122 foreach($object->children() as $item)
123 {
124 $sub_id = (string) $item['id'];
125
126 // begin-patch mime_filter
127 $score = (string) $item['absoluteScore'];
128 $this->result[$obj_id][$sub_id]['score'] = $score;
129 // end-patch mime_filter
130
131 foreach($item->children() as $field)
132 {
133 $name = (string) $field['name'];
134 $this->result[$obj_id][$sub_id][$name] = (string) $field;
135 }
136 }
137 }
138
139 return true;
140 }

References getResultString(), and setMaxScore().

+ Here is the call graph for this function:

◆ setMaxScore()

ilLuceneHighlighterResultParser::setMaxScore (   $a_score)

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

60 {
61 $this->max_score = $a_score;
62 }

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 87 of file class.ilLuceneHighlighterResultParser.php.

88 {
89 $this->result_string = $a_res;
90 }

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: