class.ilTestSequenceDynamicQuestionSet.php

Go to the documentation of this file.

<?php

class ilTestSequenceDynamicQuestionSet implements ilTestSequenceSummaryProvider
{
    private $db = null;

    private $questionSet = null;

    private $activeId = null;

    private $preventCheckedQuestionsFromComingUpEnabled;

    private $questionTracking = array();

    private $newlyTrackedQuestion;

    private $newlyTrackedQuestionsStatus;

    private $postponedQuestions = array();

    private $newlyPostponedQuestion;

    private $newlyPostponedQuestionsCount;

    private $alreadyCheckedQuestions;

    private $newlyCheckedQuestion;

    private $correctAnsweredQuestions = array();

    private $wrongAnsweredQuestions = array();

    private $newlyAnsweredQuestion;

    private $newlyAnsweredQuestionsAnswerStatus;

    private $currentQuestionId;

    public function __construct(ilDBInterface $db, ilTestDynamicQuestionSet $questionSet, $activeId)
    {
        $this->db = $db;
        $this->questionSet = $questionSet;
        $this->activeId = $activeId;

        $this->newlyTrackedQuestion = null;
        $this->newlyTrackedQuestionsStatus = null;

        $this->newlyPostponedQuestion = null;
        $this->newlyPostponedQuestionsCount = null;

        $this->newlyAnsweredQuestion = null;
        $this->newlyAnsweredQuestionsAnswerStatus = null;

        $this->alreadyCheckedQuestions = array();
        $this->newlyCheckedQuestion = null;

        $this->preventCheckedQuestionsFromComingUpEnabled = false;

        $this->currentQuestionId = null;
    }

    public function getActiveId(): ?int
    {
        return $this->activeId;
    }

    public function setPreventCheckedQuestionsFromComingUpEnabled($preventCheckedQuestionsFromComingUpEnabled)
    {
        $this->preventCheckedQuestionsFromComingUpEnabled = $preventCheckedQuestionsFromComingUpEnabled;
    }

    public function isPreventCheckedQuestionsFromComingUpEnabled(): bool
    {
        return $this->preventCheckedQuestionsFromComingUpEnabled;
    }

    public function getCurrentQuestionId(): ?int
    {
        return $this->currentQuestionId;
    }

    public function setCurrentQuestionId($currentQuestionId)
    {
        $this->currentQuestionId = $currentQuestionId;
    }

    public function loadFromDb()
    {
        $this->loadQuestionTracking();
        $this->loadAnswerStatus();
        $this->loadPostponedQuestions();
        $this->loadCheckedQuestions();
    }

    private function loadQuestionTracking()
    {
        $query = "
                        SELECT          question_fi, status
                        FROM            tst_seq_qst_tracking
                        WHERE           active_fi = %s
                        AND                     pass = %s
                        ORDER BY        orderindex ASC
                ";

        $res = $this->db->queryF($query, array('integer','integer'), array($this->activeId, 0));

        $this->questionTracking = array();

        while ($row = $this->db->fetchAssoc($res)) {
            $this->questionTracking[] = array(
                'qid' => $row['question_fi'],
                'status' => $row['status']
            );
        }
    }

    private function loadAnswerStatus()
    {
        $query = "
                        SELECT  question_fi, correctness
                        FROM    tst_seq_qst_answstatus
                        WHERE   active_fi = %s
                        AND             pass = %s
                ";

        $res = $this->db->queryF($query, array('integer','integer'), array($this->activeId, 0));

        $this->correctAnsweredQuestions = array();
        $this->wrongAnsweredQuestions = array();

        while ($row = $this->db->fetchAssoc($res)) {
            if ($row['correctness']) {
                $this->correctAnsweredQuestions[ $row['question_fi'] ] = $row['question_fi'];
            } else {
                $this->wrongAnsweredQuestions[ $row['question_fi'] ] = $row['question_fi'];
            }
        }
    }

    private function loadPostponedQuestions()
    {
        $query = "
                        SELECT  question_fi, cnt
                        FROM    tst_seq_qst_postponed
                        WHERE   active_fi = %s
                        AND             pass = %s
                ";

        $res = $this->db->queryF($query, array('integer','integer'), array($this->activeId, 0));

        $this->postponedQuestions = array();

        while ($row = $this->db->fetchAssoc($res)) {
            $this->postponedQuestions[ $row['question_fi'] ] = $row['cnt'];
        }
    }

    private function loadCheckedQuestions()
    {
        $res = $this->db->queryF(
            "SELECT question_fi FROM tst_seq_qst_checked WHERE active_fi = %s AND pass = %s",
            array('integer','integer'),
            array($this->getActiveId(), 0)
        );

        while ($row = $this->db->fetchAssoc($res)) {
            $this->alreadyCheckedQuestions[ $row['question_fi'] ] = $row['question_fi'];
        }
    }

    public function saveToDb()
    {
        $this->db->manipulateF(
            "DELETE FROM tst_sequence WHERE active_fi = %s AND pass = %s",
            array('integer','integer'),
            array($this->getActiveId(), 0)
        );

        $this->db->insert('tst_sequence', array(
            'active_fi' => array('integer', $this->getActiveId()),
            'pass' => array('integer', 0),
            'sequence' => array('clob', null),
            'postponed' => array('text', null),
            'hidden' => array('text', null),
            'tstamp' => array('integer', time())
        ));

        $this->saveNewlyTrackedQuestion();
        $this->saveNewlyAnsweredQuestionsAnswerStatus();
        $this->saveNewlyPostponedQuestion();
        $this->removeQuestionsNotPostponedAnymore();
        $this->saveNewlyCheckedQuestion();
        $this->removeQuestionsNotCheckedAnymore();
    }

    private function saveNewlyTrackedQuestion()
    {
        if ((int) $this->newlyTrackedQuestion) {
            $newOrderIndex = $this->getNewOrderIndexForQuestionTracking();

            $this->db->replace(
                'tst_seq_qst_tracking',
                array(
                    'active_fi' => array('integer', (int) $this->getActiveId()),
                    'pass' => array('integer', 0),
                    'question_fi' => array('integer', (int) $this->newlyTrackedQuestion)
                ),
                array(
                    'status' => array('text', $this->newlyTrackedQuestionsStatus),
                    'orderindex' => array('integer', $newOrderIndex)
                )
            );
        }
    }

    private function getNewOrderIndexForQuestionTracking()
    {
        $query = "
                                SELECT (MAX(orderindex) + 1) new_order_index
                                FROM tst_seq_qst_tracking
                                WHERE active_fi = %s
                                AND pass = %s
                        ";

        $res = $this->db->queryF($query, array('integer','integer'), array($this->getActiveId(), 0));

        $row = $this->db->fetchAssoc($res);

        if ($row['new_order_index']) {
            return $row['new_order_index'];
        }

        return 1;
    }

    private function saveNewlyAnsweredQuestionsAnswerStatus()
    {
        if ((int) $this->newlyAnsweredQuestion) {
            $this->db->replace(
                'tst_seq_qst_answstatus',
                array(
                    'active_fi' => array('integer', (int) $this->getActiveId()),
                    'pass' => array('integer', 0),
                    'question_fi' => array('integer', (int) $this->newlyAnsweredQuestion)
                ),
                array(
                    'correctness' => array('integer', (int) $this->newlyAnsweredQuestionsAnswerStatus)
                )
            );
        }
    }

    private function saveNewlyPostponedQuestion()
    {
        if ((int) $this->newlyPostponedQuestion) {
            $this->db->replace(
                'tst_seq_qst_postponed',
                array(
                    'active_fi' => array('integer', (int) $this->getActiveId()),
                    'pass' => array('integer', 0),
                    'question_fi' => array('integer', (int) $this->newlyPostponedQuestion)
                ),
                array(
                    'cnt' => array('integer', (int) $this->newlyPostponedQuestionsCount)
                )
            );
        }
    }

    private function removeQuestionsNotPostponedAnymore()
    {
        $INquestions = $this->db->in('question_fi', array_keys($this->postponedQuestions), true, 'integer');

        $query = "
                        DELETE FROM tst_seq_qst_postponed
                        WHERE active_fi = %s
                        AND pass = %s
                        AND $INquestions
                ";

        $this->db->manipulateF($query, array('integer','integer'), array($this->getActiveId(), 0));
    }

    private function saveNewlyCheckedQuestion()
    {
        if ((int) $this->newlyCheckedQuestion) {
            $this->db->replace('tst_seq_qst_checked', array(
                'active_fi' => array('integer', (int) $this->getActiveId()),
                'pass' => array('integer', 0),
                'question_fi' => array('integer', (int) $this->newlyCheckedQuestion)
            ), array());
        }
    }

    private function removeQuestionsNotCheckedAnymore()
    {
        $NOT_IN_checkedQuestions = $this->db->in('question_fi', $this->alreadyCheckedQuestions, true, 'integer');

        // BEGIN: FIX IN QUERY
        if ($NOT_IN_checkedQuestions == ' 1=2 ') {
            $NOT_IN_checkedQuestions = ' 1=1 ';
        }
        // END: FIX IN QUERY

        $query = "
                        DELETE FROM tst_seq_qst_checked
                        WHERE active_fi = %s
                        AND pass = %s
                        AND $NOT_IN_checkedQuestions
                ";

        $this->db->manipulateF($query, array('integer', 'integer'), array((int) $this->getActiveId(), 0));
    }

    public function loadQuestions(ilObjTestDynamicQuestionSetConfig $dynamicQuestionSetConfig, ilTestDynamicQuestionSetFilterSelection $filterSelection)
    {
        $this->questionSet->load($dynamicQuestionSetConfig, $filterSelection);

        //              echo "<table><tr>";
//              echo "<td width='200'><pre>".print_r($this->questionSet->getActualQuestionSequence(), 1)."</pre></td>";
//              echo "<td width='200'><pre>".print_r($this->correctAnsweredQuestions, 1)."</pre></td>";
//              echo "<td width='200'><pre>".print_r($this->wrongAnsweredQuestions, 1)."</pre></td>";
//              echo "</tr></table>";
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function cleanupQuestions(ilTestSessionDynamicQuestionSet $testSession)
    {
        switch (true) {
            case !$this->questionSet->questionExists($testSession->getCurrentQuestionId()):
            case !$this->isFilteredQuestion($testSession->getCurrentQuestionId()):

                $testSession->setCurrentQuestionId(null);
        }

        foreach ($this->postponedQuestions as $questionId) {
            if (!$this->questionSet->questionExists($questionId)) {
                unset($this->postponedQuestions[$questionId]);
            }
        }

        foreach ($this->wrongAnsweredQuestions as $questionId) {
            if (!$this->questionSet->questionExists($questionId)) {
                unset($this->wrongAnsweredQuestions[$questionId]);
            }
        }

        foreach ($this->correctAnsweredQuestions as $questionId) {
            if (!$this->questionSet->questionExists($questionId)) {
                unset($this->correctAnsweredQuestions[$questionId]);
            }
        }
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function getUpcomingQuestionId()
    {
        if ($questionId = $this->fetchUpcomingQuestionId(true, true)) {
            return $questionId;
        }

        if ($questionId = $this->fetchUpcomingQuestionId(false, true)) {
            return $questionId;
        }

        if ($questionId = $this->fetchUpcomingQuestionId(true, false)) {
            return $questionId;
        }

        if ($questionId = $this->fetchUpcomingQuestionId(false, false)) {
            return $questionId;
        }

        return null;
    }

    private function fetchUpcomingQuestionId($excludePostponedQuestions, $forceNonAnsweredQuestion)
    {
        foreach ($this->questionSet->getActualQuestionSequence() as $level => $questions) {
            $postponedQuestions = array();

            foreach ($questions as $pos => $qId) {
                if (isset($this->correctAnsweredQuestions[$qId])) {
                    continue;
                }

                if ($this->isPreventCheckedQuestionsFromComingUpEnabled() && $this->isQuestionChecked($qId)) {
                    continue;
                }

                if ($forceNonAnsweredQuestion && isset($this->wrongAnsweredQuestions[$qId])) {
                    continue;
                }

                if (isset($this->postponedQuestions[$qId])) {
                    $postponedQuestions[$qId] = $this->postponedQuestions[$qId];
                    continue;
                }

                return $qId;
            }

            if (!$excludePostponedQuestions && count($postponedQuestions)) {
                return $this->fetchMostLeastPostponedQuestion($postponedQuestions);
            }
        }

        return null;
    }

    public function isAnsweredQuestion($questionId): bool
    {
        return (
            isset($this->correctAnsweredQuestions[$questionId])
            || isset($this->wrongAnsweredQuestions[$questionId])
        );
    }

    public function isPostponedQuestion($questionId): bool
    {
        return isset($this->postponedQuestions[$questionId]);
    }

    public function isFilteredQuestion($questionId): bool
    {
        foreach ($this->questionSet->getActualQuestionSequence() as $level => $questions) {
            if (in_array($questionId, $questions)) {
                return true;
            }
        }

        return false;
    }

    public function trackedQuestionExists(): bool
    {
        return (bool) count($this->questionTracking);
    }

    public function getTrackedQuestionList($currentQuestionId = null): array
    {
        $questionList = array();

        if ($currentQuestionId) {
            $questionList[$currentQuestionId] = $this->questionSet->getQuestionData($currentQuestionId);
        }

        foreach (array_reverse($this->questionTracking) as $trackedQuestion) {
            if (!isset($questionList[ $trackedQuestion['qid'] ])) {
                $questionList[ $trackedQuestion['qid'] ] = $this->questionSet->getQuestionData($trackedQuestion['qid']);
            }
        }

        return $questionList;
    }

    public function resetTrackedQuestionList()
    {
        $this->questionTracking = array();
    }

    public function openQuestionExists(): bool
    {
        return count($this->getOpenQuestions()) > 0;
    }

    public function getOpenQuestions(): array
    {
        $completeQuestionIds = array_keys($this->questionSet->getAllQuestionsData());

        $openQuestions = array_diff($completeQuestionIds, $this->correctAnsweredQuestions);

        return $openQuestions;
    }

    public function getTrackedQuestionCount(): int
    {
        $uniqueQuestions = array();

        foreach ($this->questionTracking as $trackedQuestion) {
            $uniqueQuestions[$trackedQuestion['qid']] = $trackedQuestion['qid'];
        }

        return count($uniqueQuestions);
    }

    public function getCurrentPositionIndex($questionId): ?int
    {
        $i = 0;

        foreach ($this->getSelectionOrderedSequence() as $qId) {
            $i++;

            if ($qId == $questionId) {
                return $i;
            }
        }

        return null;
    }

    public function getLastPositionIndex(): int
    {
        return count($this->getSelectionOrderedSequence());
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function setQuestionUnchecked($questionId)
    {
        unset($this->alreadyCheckedQuestions[$questionId]);
    }

    public function setQuestionChecked($questionId)
    {
        $this->newlyCheckedQuestion = $questionId;
        $this->alreadyCheckedQuestions[$questionId] = $questionId;
    }

    public function isQuestionChecked($questionId): bool
    {
        return isset($this->alreadyCheckedQuestions[$questionId]);
    }

    public function setQuestionPostponed($questionId)
    {
        $this->trackQuestion($questionId, 'postponed');

        if (!isset($this->postponedQuestions[$questionId])) {
            $this->postponedQuestions[$questionId] = 0;
        }

        $this->postponedQuestions[$questionId]++;

        $this->newlyPostponedQuestion = $questionId;
        $this->newlyPostponedQuestionsCount = $this->postponedQuestions[$questionId];
    }

    public function unsetQuestionPostponed($questionId)
    {
        if (isset($this->postponedQuestions[$questionId])) {
            unset($this->postponedQuestions[$questionId]);
        }
    }

    public function setQuestionAnsweredCorrect($questionId)
    {
        $this->trackQuestion($questionId, 'correct');

        $this->correctAnsweredQuestions[$questionId] = $questionId;

        if (isset($this->wrongAnsweredQuestions[$questionId])) {
            unset($this->wrongAnsweredQuestions[$questionId]);
        }

        $this->newlyAnsweredQuestion = $questionId;
        $this->newlyAnsweredQuestionsAnswerStatus = true;
    }

    public function setQuestionAnsweredWrong($questionId)
    {
        $this->trackQuestion($questionId, 'wrong');

        $this->wrongAnsweredQuestions[$questionId] = $questionId;

        if (isset($this->correctAnsweredQuestions[$questionId])) {
            unset($this->correctAnsweredQuestions[$questionId]);
        }

        $this->newlyAnsweredQuestion = $questionId;
        $this->newlyAnsweredQuestionsAnswerStatus = false;
    }

    private function trackQuestion($questionId, $answerStatus)
    {
        $this->questionTracking[] = array(
            'qid' => $questionId, 'status' => $answerStatus
        );

        $this->newlyTrackedQuestion = $questionId;
        $this->newlyTrackedQuestionsStatus = $answerStatus;
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function hasStarted(): bool
    {
        return $this->trackedQuestionExists();
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function getQuestionSet(): ilTestDynamicQuestionSet
    {
        return $this->questionSet;
    }

    public function getCompleteQuestionsData(): array
    {
        return $this->questionSet->getCompleteQuestionList()->getQuestionDataArray();
    }

    public function getFilteredQuestionsData(): array
    {
        return $this->questionSet->getFilteredQuestionList()->getQuestionDataArray();
    }

    // -----------------------------------------------------------------------------------------------------------------

    public function getUserSequenceQuestions(): array
    {
        //return array_keys( $this->getTrackedQuestionList() );

        $questionSequence = array();

        foreach ($this->questionSet->getActualQuestionSequence() as $level => $questions) {
            $questionSequence = array_merge($questionSequence, $questions);
        }

        return $questionSequence;
    }

    private function fetchMostLeastPostponedQuestion($postponedQuestions)
    {
        $minPostponeCount = null;
        $minPostponeItem = null;

        foreach (array_reverse($postponedQuestions, true) as $qId => $postponeCount) {
            if ($minPostponeCount === null || $postponeCount <= $minPostponeCount) {
                $minPostponeCount = $postponeCount;
                $minPostponeItem = $qId;
            }
        }
        return $minPostponeItem;
    }

    public function getPass(): int
    {
        return 0;
    }

    // -----------------------------------------------------------------------------------------------------------------

    private function orderQuestionsByPostponeCount($postponedQuestions): array
    {
        $maxPostponeCount = max($postponedQuestions);

        $orderedSequence = array();
        $postponedCountDomain = array_flip($postponedQuestions);

        for ($i = 1; $i <= $maxPostponeCount; $i++) {
            if (!isset($postponedCountDomain[$i])) {
                continue;
            }

            foreach ($postponedQuestions as $qId => $postponeCount) {
                if ($postponeCount == $i) {
                    $orderedSequence[] = $qId;
                }
            }
        }

        return $orderedSequence;
    }

    private function fetchQuestionSequence($nonPostponedQuestions, $nonAnsweredQuestions): array
    {
        $questionSequence = array();

        foreach ($this->questionSet->getActualQuestionSequence() as $level => $questions) {
            $postponedQuestions = array();

            foreach ($questions as $pos => $qId) {
                if (isset($this->correctAnsweredQuestions[$qId])) {
                    continue;
                }

                if ($nonAnsweredQuestions && isset($this->wrongAnsweredQuestions[$qId])) {
                    continue;
                } elseif (!$nonAnsweredQuestions && !isset($this->wrongAnsweredQuestions[$qId])) {
                    continue;
                }

                if (!$nonPostponedQuestions && isset($this->postponedQuestions[$qId])) {
                    $postponedQuestions[$qId] = $this->postponedQuestions[$qId];
                    continue;
                } elseif ($nonPostponedQuestions && !isset($this->postponedQuestions[$qId])) {
                    $questionSequence[] = $qId;
                }
            }

            if (!$nonPostponedQuestions && count($postponedQuestions)) {
                $questionSequence = array_merge(
                    $questionSequence,
                    $this->orderQuestionsByPostponeCount($postponedQuestions)
                );
            }
        }

        return $questionSequence;
    }

    private function fetchTrackedCorrectAnsweredSequence(): array
    {
        $questionSequence = array();

        foreach ($this->questionTracking as $key => $question) {
            $qId = $question['qid'];

            if (!isset($this->correctAnsweredQuestions[$qId])) {
                continue;
            }

            $questionSequence[] = $qId;
        }

        return $questionSequence;
    }

    private function getOrderedSequence(): array
    {
        $correctAnsweredQuestions = $this->fetchTrackedCorrectAnsweredSequence();

        $nonAnsweredQuestions = $this->fetchQuestionSequence(
            true,
            true
        );

        $postponedNonAnsweredQuestions = $this->fetchQuestionSequence(
            false,
            true
        );

        $wrongAnsweredQuestions = $this->fetchQuestionSequence(
            true,
            false
        );

        $postponedWrongAnsweredQuestions = $this->fetchQuestionSequence(
            false,
            false
        );

        $questionOrder = array_merge(
            $correctAnsweredQuestions,
            $nonAnsweredQuestions,
            $postponedNonAnsweredQuestions,
            $wrongAnsweredQuestions,
            $postponedWrongAnsweredQuestions
        );

        return $questionOrder;
    }

    public function getSelectionOrderedSequence(): array
    {
        $sequence = array();

        foreach ($this->getOrderedSequence() as $qId) {
            if (!$this->getQuestionSet()->getSelectionQuestionList()->isInList($qId)) {
                continue;
            }

            $sequence[] = $qId;
        }

        return $sequence;
    }

    public function getSequenceSummary($obligationsFilterEnabled = false): array
    {
        $questionOrder = $this->getSelectionOrderedSequence();

        $solved_questions = ilObjTest::_getSolvedQuestions($this->getActiveId());

        $key = 1;

        $summary = array();

        foreach ($questionOrder as $qId) {
            $question = ilObjTest::_instanciateQuestion($qId);
            if (is_object($question)) {
                $worked_through = $question->_isWorkedThrough($this->getActiveId(), $question->getId(), $this->getPass());
                $solved = 0;
                if (array_key_exists($question->getId(), $solved_questions)) {
                    $solved = $solved_questions[$question->getId()]["solved"];
                }

                // do not show postponing, since this happens implicit on dircarding solutions (CTM only)
                //$is_postponed = $this->isPostponedQuestion($question->getId());

                $row = array("nr" => "$key", "title" => $question->getTitle(), "qid" => $question->getId(), "visited" => $worked_through, "solved" => (($solved) ? "1" : "0"), "description" => $question->getComment(), "points" => $question->getMaximumPoints(), "worked_through" => $worked_through, "postponed" => false, "sequence" => $qId, "obligatory" => ilObjTest::isQuestionObligatory($question->getId()), 'isAnswered' => $question->isAnswered($this->getActiveId(), $this->getPass()));

                if (!$obligationsFilterEnabled || $row['obligatory']) {
                    $summary[] = $row;
                }

                $key++;
            }
        }

        return $summary;
    }

    public function hasFilteredQuestionListCheckedQuestions(): bool
    {
        $filteredQuestions = $this->questionSet->getFilteredQuestionList()->getQuestionDataArray();

        foreach ($filteredQuestions as $filteredQuestion) {
            if ($this->isQuestionChecked($filteredQuestion['question_id'])) {
                return true;
            }
        }

        return false;
    }

    public function resetFilteredQuestionListsCheckedStatus()
    {
        $filteredQuestions = $this->questionSet->getFilteredQuestionList()->getQuestionDataArray();

        foreach ($filteredQuestions as $filteredQuestion) {
            if ($this->isQuestionChecked($filteredQuestion['question_id'])) {
                $this->setQuestionUnchecked($filteredQuestion['question_id']);
            }
        }
    }
}