class.ilTestRandomQuestionSetQuestionCollection.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
// hey: fixRandomTestBuildable - iterator interface for collection
class ilTestRandomQuestionSetQuestionCollection implements
    Iterator
    // hey.
{
    private $questions = [];
 
    public function setQuestions(array $questions): void
    {
        $this->questions = $questions;
    }
 
    public function getQuestions(): array
    {
        return $this->questions;
    }
 
    public function addQuestion(ilTestRandomQuestionSetQuestion $question)
    {
        $this->questions[] = $question;
    }
 
    public function current(): ?ilTestRandomQuestionSetQuestion
    {
        $current = current($this->questions);
        return $current !== false ? $current : null;
    }
 
    public function next(): void
    {
        next($this->questions);
    }
 
    public function key(): ?string
    {
        return (string) key($this->questions);
    }
 
    public function valid(): bool
    {
        return key($this->questions) !== null;
    }
 
    public function rewind(): void
    {
        reset($this->questions);
    }
    // hey.
 
    public function isGreaterThan($amount): bool
    {
        return count($this->questions) > $amount;
    }
 
    public function isSmallerThan($amount): bool
    {
        return count($this->questions) < $amount;
    }
 
    public function getMissingCount($requiredAmount): int
    {
        // hey: fixRandomTestBuildable - fix returning missing count instead of difference (neg values!)
        $difference = $requiredAmount - count($this->questions);
        $missingCount = $difference < 0 ? 0 : $difference;
        return $missingCount;
        // hey.
    }
 
    public function shuffleQuestions()
    {
        shuffle($this->questions);
    }
 
    public function mergeQuestionCollection(self $questionCollection)
    {
        $this->questions = array_merge($this->questions, $questionCollection->getQuestions());
    }
 
    public function getUniqueQuestionCollection(): ilTestRandomQuestionSetQuestionCollection
    {
        $uniqueQuestions = [];
 
        foreach ($this->getQuestions() as $question) {
            /* @var ilTestRandomQuestionSetQuestion $question */
 
            if (!isset($uniqueQuestions[$question->getQuestionId()])) {
                $uniqueQuestions[$question->getQuestionId()] = $question;
            }
        }
 
        $uniqueQuestionCollection = new self();
        $uniqueQuestionCollection->setQuestions($uniqueQuestions);
 
        return $uniqueQuestionCollection;
    }
 
    public function getRelativeComplementCollection(self $questionCollection): ilTestRandomQuestionSetQuestionCollection
    {
        // hey: fixRandomTestBuildable - comment for refactoring
        // hey.
 
        $questionIds = array_flip($questionCollection->getInvolvedQuestionIds());
 
        $relativeComplementCollection = new self();
 
        foreach ($this->getQuestions() as $question) {
            if (!isset($questionIds[$question->getQuestionId()])) {
                $relativeComplementCollection->addQuestion($question);
            }
        }
 
        return $relativeComplementCollection;
    }
 
    public function getIntersectionCollection(self $questionCollection): ilTestRandomQuestionSetQuestionCollection
    {
        $questionIds = array_flip($questionCollection->getInvolvedQuestionIds());
 
        $intersectionCollection = new self();
 
        foreach ($this->getQuestions() as $question) {
            if (!isset($questionIds[$question->getQuestionId()])) {
                continue;
            }
 
            $intersectionCollection->addQuestion($question);
        }
 
        return $intersectionCollection;
    }
 
    public function getQuestionAmount(): int
    {
        return count($this->getQuestions());
    }
    // hey.
 
    public function getInvolvedQuestionIds(): array
    {
        $questionIds = [];
 
        foreach ($this->getQuestions() as $question) {
            $questionIds[] = $question->getQuestionId();
        }
 
        return $questionIds;
    }
 
    public function getRandomQuestionCollection($requiredAmount): ilTestRandomQuestionSetQuestionCollection
    {
        $randomKeys = $this->getRandomArrayKeys($this->questions, $requiredAmount);
 
        $randomQuestionCollection = new self();
 
        foreach ($randomKeys as $randomKey) {
            $randomQuestionCollection->addQuestion($this->questions[$randomKey]);
        }
 
        return $randomQuestionCollection;
    }
 
    private function getRandomArrayKeys($array, $numKeys)
    {
        if ($numKeys < 1) {
            return [];
        }
 
        if ($numKeys > 1) {
            return array_rand($array, $numKeys);
        }
 
        return [ array_rand($array, $numKeys) ];
    }
}