class.ilLuceneSearchResult.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

class ilLuceneSearchResult implements Iterator
{
    private $listener;
    private $position = 0;
    
    private $limit = 0;
    private $total_hits = 0;
    private $max_score = 0;

    private $objects = [];
    private $relevance;
    

    public function __construct()
    {
    }
    
    public function setCallback($a_callback)
    {
        $this->listener = $a_callback;
    }
    
    public function rewind()
    {
        $this->position = 0;
    }
    
    public function valid()
    {
        if ($this->position < count($this->objects)) {
            return true;
        }
        // if the number of candidates is smaller than the total number of hits
        // get next result page
        if (count($this->objects) < $this->getTotalHits()) {
            ilLoggerFactory::getLogger('src')->debug("Trying to get next result page...");
            @call_user_func($this->listener);
        }
        // Check again
        if ($this->position < count($this->objects)) {
            return true;
        }
        return false;
    }
    
    public function key()
    {
        return $this->position;
    }
    
    public function current()
    {
        return $this->objects[$this->position];
    }
    
    public function next()
    {
        $this->position++;
    }
    
    
    
    public function getCandidates()
    {
        return $this->objects;
    }
    
    public function addObject($a_value, $a_relevance = 0)
    {
        $this->objects[] = $a_value;
        $this->relevance[$a_value] = $a_relevance;
    }
    
    public function getRelevance($a_obj_id)
    {
        if (!$this->getMaxScore()) {
            return 0;
        }
        return isset($this->relevance[$a_obj_id]) ? $this->relevance[$a_obj_id] / $this->getMaxScore() * 100 : 0;
    }
    
    
    public function setLimit($a_limit)
    {
        $this->limit = $a_limit;
    }
    
    public function getLimit()
    {
        return $this->limit;
    }
    
    
    public function setMaxScore($a_score)
    {
        $this->max_score = $a_score;
    }
    
    public function getMaxScore()
    {
        return $this->max_score;
    }
    
    public function setTotalHits($a_hits)
    {
        $this->total_hits = $a_hits;
    }
    
    public function getTotalHits()
    {
        return $this->total_hits;
    }
}