TestScoring.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

namespace ILIAS\Test\Scoring\Manual;

use ILIAS\Test\Logging\TestScoringInteraction;
use ILIAS\Test\Logging\TestScoringInteractionTypes;

class TestScoring
{
    private bool $preserve_manual_scores = false;
    private int $question_id = 0;

    protected array $question_cache = [];

    public function __construct(
        private \ilObjTest $test,
        private \ilObjUser $scorer,
        private \ilDBInterface $db,
        private \ilLanguage $lng
    ) {
    }

    public function setPreserveManualScores(bool $preserve_manual_scores): void
    {
        $this->preserve_manual_scores = $preserve_manual_scores;
    }

    public function getPreserveManualScores(): bool
    {
        return $this->preserve_manual_scores;
    }

    public function getQuestionId(): int
    {
        return $this->question_id;
    }

    public function setQuestionId(int $question_id): void
    {
        $this->question_id = $question_id;
    }

    public function recalculateSolutions(): array
    {
        $factory = new \ilTestEvaluationFactory($this->db, $this->test);
        $participants = $factory->getCorrectionsEvaluationData()->getParticipants();

        foreach ($participants as $active_id => $userdata) {
            if (is_object($userdata) && is_array($userdata->getPasses())) {
                $this->recalculatePasses($userdata, $active_id);
                \ilLPStatusWrapper::_updateStatus(
                    $this->test->getId(),
                    $userdata->getUserID()
                );
            }
        }

        return $participants;

    }

    public function recalculateSolution(int $active_id, int $pass): void
    {
        $user_data = $this
            ->test
            ->getCompleteEvaluationData()
            ->getParticipant($active_id);

        $this->recalculatePass(
            $user_data->getPass($pass),
            $user_data->getUserID(),
            $active_id,
            $pass
        );
        $this->test->updateTestResultCache($active_id);
    }

    public function recalculatePasses(\ilTestEvaluationUserData $userdata, int $active_id): void
    {
        $passes = $userdata->getPasses();
        foreach ($passes as $pass => $passdata) {
            if (is_object($passdata)) {
                $this->recalculatePass($passdata, $userdata->getUserID(), $active_id, $pass);
            }
        }
        $this->test->updateTestResultCache($active_id);
    }

    public function recalculatePass(
        \ilTestEvaluationPassData $passdata,
        int $user_id,
        int $active_id,
        int $pass
    ): void {
        $questions = $passdata->getAnsweredQuestions();
        foreach ($questions as $question_data) {
            if (!$this->getQuestionId() || $this->getQuestionId() === $question_data['id']) {
                $this->recalculateQuestionScore($user_id, $active_id, $pass, $question_data);
            }
        }
    }

    private function recalculateQuestionScore(
        int $user_id,
        int $active_id,
        int $pass,
        array $questiondata
    ): void {
        if ($this->preserve_manual_scores === true && $questiondata['manual'] === 1) {
            return;
        }

        $q_id = $questiondata['id'];
        if (!isset($this->question_cache[$q_id])) {
            $this->question_cache[$q_id] = $this->test->createQuestionGUI('', $q_id)->getObject();
        }
        $question = $this->question_cache[$q_id];

        $old_points = $question->getReachedPoints($active_id, $pass);
        $reached = $question->adjustReachedPointsByScoringOptions(
            $question->calculateReachedPoints($active_id, $pass),
            $active_id,
        );

        $this->updateReachedPoints(
            $user_id,
            $active_id,
            $questiondata['id'],
            $old_points,
            $reached,
            $question->getMaximumPoints(),
            $pass,
        );
    }

    public function updateReachedPoints(
        int $user_id,
        int $active_id,
        int $question_id,
        float $old_points,
        float $points,
        float $max_points,
        int $pass,
        bool $manual_scoring = false
    ): void {
        // Only update the test results if necessary
        $has_changed = $old_points !== $points;
        if ($has_changed && $points <= $max_points) {
            $this->db->update(
                'tst_test_result',
                [
                    'points' => [\ilDBConstants::T_FLOAT, $points],
                    'tstamp' => [\ilDBConstants::T_INTEGER, time()],
                ],
                [
                    'active_fi' => [\ilDBConstants::T_INTEGER, $active_id],
                    'question_fi' => [\ilDBConstants::T_INTEGER, $question_id],
                    'pass' => [\ilDBConstants::T_INTEGER, $pass]
                ]
            );
        }

        // Always update the pass result as the maximum points might have changed
        $data = $this->test->getQuestionCountAndPointsForPassOfParticipant($active_id, $pass);
        $values = [
            'maxpoints' => [\ilDBConstants::T_FLOAT, $data['points']],
            'tstamp' => [\ilDBConstants::T_INTEGER, time()],
        ];

        if ($has_changed) {
            $result = $this->db->queryF(
                'SELECT SUM(points) reachedpoints FROM tst_test_result WHERE active_fi = %s AND pass = %s',
                [\ilDBConstants::T_INTEGER, \ilDBConstants::T_INTEGER],
                [$active_id, $pass]
            );
            $values['points'] = [\ilDBConstants::T_FLOAT, $result->fetchAssoc()['reachedpoints'] ?? 0.0];
        }

        $this->db->update(
            'tst_pass_result',
            $values,
            ['active_fi' => [\ilDBConstants::T_INTEGER, $active_id], 'pass' => [\ilDBConstants::T_INTEGER, $pass]]
        );

        \ilCourseObjectiveResult::_updateObjectiveResult($user_id, $active_id, $question_id);
        $logger = $this->test->getTestLogger();
        if ($logger->isLoggingEnabled()) {
            $logger->logScoringInteraction(
                new TestScoringInteraction(
                    $this->test->getRefId(),
                    $question_id,
                    $this->scorer->getId(),
                    $user_id,
                    TestScoringInteractionTypes::QUESTION_GRADING_RESET,
                    time(),
                    []
                )
            );
        }
    }

    public function calculateBestSolutionForTest(): string
    {
        $solution = '';
        foreach ($this->test->getAllQuestions() as $question) {
            $question_gui = $this->test->createQuestionGUI("", $question['question_id']);
            $solution .= '<h1>' . $question_gui->getObject()->getTitleForHTMLOutput() . '</h1>';
            $solution .= $question_gui->getSolutionOutput(0, null, true, true, false, false, true, false);
        }

        return $solution;
    }

    public function removeAllQuestionResults($question_id)
    {
        $query = "DELETE FROM tst_test_result WHERE question_fi = %s";
        $this->db->manipulateF($query, ['integer'], [$question_id]);
    }

    public function updatePassAndTestResults(array $active_ids): void
    {
        foreach ($active_ids as $active_id) {
            $passSelector = new \ilTestPassesSelector($this->db, $this->test);
            $passSelector->setActiveId($active_id);

            foreach ($passSelector->getExistingPasses() as $pass) {
                $this->test->updateTestPassResults($active_id, $pass);
            }

            $this->test->updateTestResultCache($active_id);
        }
    }

    public function getNumManualScorings(): int
    {
        $query = "
                        SELECT COUNT(*) num_manual_scorings
                FROM tst_test_result tres
                        INNER JOIN tst_active tact
                ON tact.active_id = tres.active_fi
                        WHERE tact.test_fi = %s
                        AND tres.manual = 1
                ";

        $types = ['integer'];
        $values = [$this->test->getTestId()];

        if ($this->getQuestionId()) {
            $query .= "
                                AND tres.question_fi = %s
                        ";

            $types[] = 'integer';
            $values[] = $this->getQuestionId();
        }

        $res = $this->db->queryF($query, $types, $values);

        while ($row = $this->db->fetchAssoc($res)) {
            return (int) $row['num_manual_scorings'];
        }

        return 0;
    }
}