class.ilLuceneSearchResult.php

Go to the documentation of this file.

<?php

declare(strict_types=1);


class ilLuceneSearchResult implements Iterator
{
    private array $listener = [];
    private int $position = 0;

    private int $limit = 0;
    private int $total_hits = 0;
    private float $max_score = 0;

    private array $objects = [];
    private array $relevance = [];



    public function setCallback(array $a_callback): void
    {
        $this->listener = $a_callback;
    }

    public function rewind(): void
    {
        $this->position = 0;
    }

    public function valid(): bool
    {
        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(): int
    {
        return $this->position;
    }

    public function current(): int
    {
        return $this->objects[$this->position];
    }

    public function next(): void
    {
        $this->position++;
    }



    public function getCandidates(): array
    {
        return $this->objects;
    }

    public function addObject(int $a_value, float $a_relevance = 0): void
    {
        $this->objects[] = $a_value;
        $this->relevance[$a_value] = $a_relevance;
    }

    public function getRelevance(int $a_obj_id): float
    {
        if (!$this->getMaxScore()) {
            return 0;
        }
        return isset($this->relevance[$a_obj_id]) ? $this->relevance[$a_obj_id] / $this->getMaxScore() * 100 : 0;
    }


    public function setLimit(int $a_limit): void
    {
        $this->limit = $a_limit;
    }

    public function getLimit(): int
    {
        return $this->limit;
    }


    public function setMaxScore(float $a_score): void
    {
        $this->max_score = $a_score;
    }

    public function getMaxScore(): float
    {
        return $this->max_score;
    }

    public function setTotalHits(int $a_hits): void
    {
        $this->total_hits = $a_hits;
    }

    public function getTotalHits(): int
    {
        return $this->total_hits;
    }
}