ilTestScoring Class Reference

Class ilTestScoring. More...

Collaboration diagram for ilTestScoring:

Public Member Functions
	__construct (private ilObjTest $test, private ilDBInterface $db)
	setPreserveManualScores (bool $preserve_manual_scores)
	getPreserveManualScores ()
	getQuestionId ()
	setQuestionId (int $question_id)
	recalculateSolutions ()
	recalculateSolution (int $active_id, int $pass)
	recalculatePasses (ilTestEvaluationUserData $userdata, int $active_id)
	recalculatePass (ilTestEvaluationPassData $passdata, int $active_id, int $pass)
	recalculateQuestionScore (int $q_id, int $active_id, int $pass, array $questiondata)
	updateReachedPoints (int $active_id, int $question_id, float $old_points, float $points, float $max_points, int $pass)
	This is an optimized version of ::_setReachedPoints that only executes updates in the database if necessary. More...
	resetRecalculatedPassesByActives ()
	getRecalculatedPassesByActives ()
	addRecalculatedPassByActive (int $active_id, int $pass)
	removeAllQuestionResults ($question_id)
	updatePassAndTestResults (array $active_ids)
	getNumManualScorings ()

Protected Attributes
ilLanguage	$lng
array	$question_cache = []
array	$participants = []
string	$initiator_name
int	$initiator_id

Private Attributes
bool	$preserve_manual_scores = false
array	$recalculated_passes = []
int	$question_id = 0

Detailed Description

Class ilTestScoring.

This class holds a mechanism to get the scoring for

• a test,
• a user in a test,
• a pass in a users passes in a test, or
• a question in a pass in a users passes in a test.

Warning: Please use carefully, this is one of the classes that may cause funny spikes on your servers load graph on large datasets in the test.

Author

Maximilian Becker mbeck.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 40 of file class.ilTestScoring.php.

Constructor & Destructor Documentation

__construct()

ilTestScoring::__construct	(	private ilObjTest	$test,
		private ilDBInterface	$db
	)

Definition at line 61 of file class.ilTestScoring.php.

References $DIC, and ILIAS\Repository\lng().

      {
        global $DIC;
        $this->lng = $DIC->language();
        $this->initiator_name = $DIC->user()->getFullname() . " (" . $DIC->user()->getLogin() . ")";
        $this->initiator_id = $DIC->user()->getId();
    }

Here is the call graph for this function:

Member Function Documentation

addRecalculatedPassByActive()

ilTestScoring::addRecalculatedPassByActive	(	int	$active_id,
		int	$pass
	)

Definition at line 272 of file class.ilTestScoring.php.

Referenced by recalculatePasses().

                                                                          : void
    {
        if (! array_key_exists($active_id, $this->recalculated_passes)
            || !is_array($this->recalculated_passes[$active_id])
        ) {
            $this->recalculated_passes[$active_id] = [];
        }

        $this->recalculated_passes[$active_id][] = $pass;
    }

Here is the caller graph for this function:

getNumManualScorings()

ilTestScoring::getNumManualScorings

(

)

Definition at line 307 of file class.ilTestScoring.php.

References $res, and getQuestionId().

                                          : int
    {
        $query = "
                        SELECT COUNT(*) num_manual_scorings
                        FROM tst_test_result tres

                        INNER JOIN tst_active tact
                        ON tact.active_id = tres.active_fi
                        AND tact.test_fi = %s

                        WHERE tres.manual = 1
                ";

        $types = array('integer');
        $values = array($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;
    }

Here is the call graph for this function:

getPreserveManualScores()

ilTestScoring::getPreserveManualScores

(

)

Definition at line 76 of file class.ilTestScoring.php.

References $preserve_manual_scores.

                                             : bool
    {
        return $this->preserve_manual_scores;
    }

getQuestionId()

ilTestScoring::getQuestionId

(

)

Definition at line 81 of file class.ilTestScoring.php.

References $question_id.

Referenced by getNumManualScorings(), and recalculatePass().

                                   : int
    {
        return $this->question_id;
    }

Here is the caller graph for this function:

getRecalculatedPassesByActives()

ilTestScoring::getRecalculatedPassesByActives

(

)

Definition at line 267 of file class.ilTestScoring.php.

References $recalculated_passes.

                                                    : array
    {
        return $this->recalculated_passes;
    }

recalculatePass()

ilTestScoring::recalculatePass	(	ilTestEvaluationPassData	$passdata,
		int	$active_id,
		int	$pass
	)

Definition at line 136 of file class.ilTestScoring.php.

References ilTestEvaluationPassData\getAnsweredQuestions(), getQuestionId(), and recalculateQuestionScore().

Referenced by recalculatePasses(), and recalculateSolution().

      {
        $questions = $passdata->getAnsweredQuestions();
        foreach ($questions as $question_data) {
            if (!$this->getQuestionId() || $this->getQuestionId() === $question_data['id']) {
                $this->recalculateQuestionScore($question_data['id'], $active_id, $pass, $question_data);
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

recalculatePasses()

ilTestScoring::recalculatePasses	(	ilTestEvaluationUserData	$userdata,
		int	$active_id
	)

Definition at line 124 of file class.ilTestScoring.php.

References addRecalculatedPassByActive(), ilTestEvaluationUserData\getPasses(), and recalculatePass().

Referenced by recalculateSolutions().

                                                                                         : void
    {
        $passes = $userdata->getPasses();
        foreach ($passes as $pass => $passdata) {
            if (is_object($passdata)) {
                $this->recalculatePass($passdata, $active_id, $pass);
                $this->addRecalculatedPassByActive($active_id, $pass);
            }
        }
        $this->test->updateTestResultCache($active_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

recalculateQuestionScore()

ilTestScoring::recalculateQuestionScore	(	int	$q_id,
		int	$active_id,
		int	$pass,
		array	$questiondata
	)

Definition at line 149 of file class.ilTestScoring.php.

References updateReachedPoints().

Referenced by recalculatePass().

                                                                                                       : void
    {
        if (!isset($this->question_cache[$q_id])) {
            $this->question_cache[$q_id] = $this->test->createQuestionGUI("", $q_id)->object;
        }
        $question = $this->question_cache[$q_id];

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

        if ($this->preserve_manual_scores && $questiondata['manual'] == '1') {
            return;
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

recalculateSolution()

ilTestScoring::recalculateSolution	(	int	$active_id,
		int	$pass
	)

Definition at line 112 of file class.ilTestScoring.php.

References recalculatePass().

                                                                  : void
    {
        $user_data = $this
            ->test
            ->getCompleteEvaluationData(false)
            ->getParticipant($active_id)
            ->getPass($pass);

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

Here is the call graph for this function:

recalculateSolutions()

ilTestScoring::recalculateSolutions

(

)

Returns

array<int, ilTestEvaluationUserData>

Definition at line 94 of file class.ilTestScoring.php.

References $participants, ilLPStatusWrapper\_updateStatus(), and recalculatePasses().

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

        foreach ($this->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 $this->participants;
    }

Here is the call graph for this function:

removeAllQuestionResults()

ilTestScoring::removeAllQuestionResults

(

$question_id

)

Definition at line 283 of file class.ilTestScoring.php.

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

resetRecalculatedPassesByActives()

ilTestScoring::resetRecalculatedPassesByActives

(

)

Definition at line 262 of file class.ilTestScoring.php.

    {
        $this->recalculated_passes = [];
    }

setPreserveManualScores()

ilTestScoring::setPreserveManualScores

(

bool

$preserve_manual_scores

)

Definition at line 71 of file class.ilTestScoring.php.

References $preserve_manual_scores.

                                                                         : void
    {
        $this->preserve_manual_scores = $preserve_manual_scores;
    }

setQuestionId()

ilTestScoring::setQuestionId

(

int

$question_id

)

Definition at line 86 of file class.ilTestScoring.php.

References $question_id.

                                                   : void
    {
        $this->question_id = $question_id;
    }

updatePassAndTestResults()

ilTestScoring::updatePassAndTestResults

(

array

$active_ids

)

Parameters

array<int>

$active_ids

Definition at line 293 of file class.ilTestScoring.php.

                                                               : 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->areObligationsEnabled());
            }

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

updateReachedPoints()

ilTestScoring::updateReachedPoints	(	int	$active_id,
		int	$question_id,
		float	$old_points,
		float	$points,
		float	$max_points,
		int	$pass
	)

This is an optimized version of ::_setReachedPoints that only executes updates in the database if necessary.

In addition, unlike the original, this method does NOT update the test cache, so this must also be called afterward.

See also

assQuestion::_setReachedPoints

Definition at line 184 of file class.ilTestScoring.php.

References $data, $question_id, ilObjAssessmentFolder\_addLog(), ilObjAssessmentFolder\_enabledAssessmentLogging(), ilObjAssessmentFolder\_getLogLanguage(), ilObjTest\_getQuestionCountAndPointsForPassOfParticipant(), ilObjTest\_getUserIdFromActiveId(), ilCourseObjectiveResult\_updateObjectiveResult(), and ILIAS\Repository\lng().

Referenced by recalculateQuestionScore().

                                                                                                                                         : 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' => ['float', $points],
                    'tstamp' => ['integer', time()],
                ],
                [
                    'active_fi' => ['integer', $active_id],
                    'question_fi' => ['integer', $question_id],
                    'pass' => ['integer', $pass]
                ]
            );
        }

        // Always update the pass result as the maximum points might have changed
        $data = ilObjTest::_getQuestionCountAndPointsForPassOfParticipant($active_id, $pass);
        $values = [
            'maxpoints' => ['float', $data['points']],
            'tstamp' => ['integer', time()],
        ];

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

        $this->db->update(
            'tst_pass_result',
            $values,
            ['active_fi' => ['integer', $active_id], 'pass' => ['integer', $pass]]
        );

        ilCourseObjectiveResult::_updateObjectiveResult(ilObjTest::_getUserIdFromActiveId($active_id), $active_id, $question_id);
        if (ilObjAssessmentFolder::_enabledAssessmentLogging()) {
            $msg = $this->lng->txtlng('assessment', 'log_answer_changed_points', ilObjAssessmentFolder::_getLogLanguage());
            $msg = sprintf(
                $msg,
                isset($this->participants[$active_id]) && $this->participants[$active_id] instanceof ilTestEvaluationUserData ?
                    $this->participants[$active_id]->getName() :
                    '',
                $old_points,
                $points,
                $this->initiator_name
            );
            ilObjAssessmentFolder::_addLog(
                $this->initiator_id,
                $this->test->getId(),
                $msg,
                $question_id
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$initiator_id

int ilTestScoring::$initiator_id

protected

Definition at line 59 of file class.ilTestScoring.php.

$initiator_name

string ilTestScoring::$initiator_name

protected

Definition at line 58 of file class.ilTestScoring.php.

$lng

ilLanguage ilTestScoring::$lng

protected

Definition at line 46 of file class.ilTestScoring.php.

$participants

array< int, ilTestEvaluationUserData > ilTestScoring::$participants = []

protected

Definition at line 56 of file class.ilTestScoring.php.

Referenced by recalculateSolutions().

$preserve_manual_scores

bool ilTestScoring::$preserve_manual_scores = false

private

Definition at line 42 of file class.ilTestScoring.php.

Referenced by getPreserveManualScores(), and setPreserveManualScores().

$question_cache

array< int, assQuestionGUI > ilTestScoring::$question_cache = []

protected

Definition at line 51 of file class.ilTestScoring.php.

$question_id

int ilTestScoring::$question_id = 0

private

Definition at line 44 of file class.ilTestScoring.php.

Referenced by getQuestionId(), setQuestionId(), and updateReachedPoints().

$recalculated_passes

array ilTestScoring::$recalculated_passes = []

private

Definition at line 43 of file class.ilTestScoring.php.

Referenced by getRecalculatedPassesByActives().

---

The documentation for this class was generated from the following file:

• Modules/Test/classes/class.ilTestScoring.php