class.ilTestResultsToXML.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\ResourceStorage\Services as ResourceStorage;

class ilTestResultsToXML extends ilXmlWriter
{
    private $active_ids;

    protected bool $include_random_test_questions_enabled = false;

    public function __construct(
        private int $test_id,
        private ilDBInterface $db,
        private ResourceStorage $irss,
        private string $objects_export_directory,
        private bool $anonymized = false
    ) {
        parent::__construct();
    }

    public function isIncludeRandomTestQuestionsEnabled(): bool
    {
        return $this->include_random_test_questions_enabled;
    }

    public function setIncludeRandomTestQuestionsEnabled(bool $include_random_test_questions_enabled): void
    {
        $this->include_random_test_questions_enabled = $include_random_test_questions_enabled;
    }

    protected function exportActiveIDs(): void
    {
        $assessment_setting = new ilSetting('assessment');
        $user_criteria = $assessment_setting->get('user_criteria');
        if ($user_criteria === null || $user_criteria === '') {
            $user_criteria = 'usr_id';
        }

        if ($this->anonymized) {
            $result = $this->db->queryF(
                'SELECT * FROM tst_active WHERE test_fi = %s',
                ['integer'],
                [$this->test_id]
            );
        } else {
            $result = $this->db->queryF(
                'SELECT tst_active.*, usr_data.' . $user_criteria . ' FROM tst_active, usr_data WHERE tst_active.test_fi = %s AND tst_active.user_fi = usr_data.usr_id',
                ['integer'],
                [$this->test_id]
            );
        }
        $this->xmlStartTag('tst_active', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'active_id' => $row['active_id'],
                'user_fi' => $row['user_fi'] ?? '',
                'anonymous_id' => $row['anonymous_id'] ?? '',
                'test_fi' => $row['test_fi'],
                'lastindex' => $row['lastindex'] ?? '',
                'tries' => $row['tries'] ?? '',
                'last_started_pass' => $row['last_started_pass'] ?? '',
                'last_finished_pass' => $row['last_finished_pass'] ?? '',
                'submitted' => $row['submitted'] ?? '',
                'submittimestamp' => $row['submittimestamp'] ?? '',
                'tstamp' => $row['tstamp'] ?? ''
            ];
            $attrs['fullname'] = ilObjTestAccess::_getParticipantData($row['active_id']);
            if (!$this->anonymized) {
                $attrs['user_criteria'] = $user_criteria;
                $attrs[$user_criteria] = $row[$user_criteria];
            }
            array_push($this->active_ids, $row['active_id']);
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_active');
    }

    protected function exportPassResult(): void
    {
        $query = 'SELECT * FROM tst_pass_result WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY active_fi, pass';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_pass_result', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'active_fi' => $row['active_fi'],
                'pass' => $row['pass'] ?? '',
                'points' => $row['points'] ?? '',
                'maxpoints' => $row['maxpoints'] ?? '',
                'questioncount' => $row['questioncount'] ?? '',
                'answeredquestions' => $row['answeredquestions'] ?? '',
                'workingtime' => $row['workingtime'] ?? '',
                'tstamp' => $row['tstamp'] ?? ''
            ];
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_pass_result');
    }

    protected function exportResultCache(): void
    {
        $query = 'SELECT * FROM tst_result_cache WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY active_fi';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_result_cache', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'active_fi' => $row['active_fi'],
                'pass' => $row['pass'],
                'max_points' => $row['max_points'],
                'reached_points' => $row['reached_points'],
                'mark_short' => $row['mark_short'],
                'mark_official' => $row['mark_official'],
                'passed' => $row['passed'],
                'failed' => $row['failed'],
                'tstamp' => $row['tstamp']
            ];
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_result_cache');
    }

    protected function exportTestSequence(): void
    {
        $query = 'SELECT * FROM tst_sequence WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY active_fi, pass';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_sequence', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'active_fi' => $row['active_fi'],
                'pass' => $row['pass'] ?? '',
                'sequence' => $row['sequence'] ?? '',
                'postponed' => $row['postponed'] ?? '',
                'hidden' => $row['hidden'] ?? '',
                'tstamp' => $row['tstamp'] ?? ''
            ];
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_sequence');
    }

    protected function exportTestSolutions(): void
    {
        $query = 'SELECT * FROM tst_solutions WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY solution_id';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_solutions', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'solution_id' => $row['solution_id'],
                'active_fi' => $row['active_fi'],
                'question_fi' => $row['question_fi'],
                'points' => $row['points'] ?? '',
                'pass' => $row['pass'] ?? '',
                'value1' => $row['value1'] ?? '',
                'value2' => $row['value2'] ?? '',
                'tstamp' => $row['tstamp'] ?? ''
            ];
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_solutions');
    }

    protected function exportRandomTestQuestions(): void
    {
        $result = $this->db->query("
                          SELECT * FROM tst_test_rnd_qst
                          WHERE {$this->db->in('active_fi', $this->active_ids, false, 'integer')}
                          ORDER BY test_random_question_id
                ");

        $this->xmlStartTag('tst_test_rnd_qst', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [];

            foreach ($row as $field => $value) {
                $attrs[$field] = $value;
            }

            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_test_rnd_qst');
    }


    protected function exportTestResults(): void
    {
        $query = 'SELECT * FROM tst_test_result WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY active_fi';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_test_result', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $active_fi = $row['active_fi'];
            $pass = $row['pass'] ?? '';
            $attrs = [
                'test_result_id' => $row['test_result_id'],
                'active_fi' => $active_fi,
                'question_fi' => $row['question_fi'],
                'points' => $row['points'] ?? '',
                'pass' => $pass,
                'manual' => $row['manual'] ?? '',
                'tstamp' => $row['tstamp'] ?? ''
            ];

            if (($question = assQuestion::instantiateQuestion($row['question_fi'])) instanceof assFileUpload) {
                $this->exportParticipantUploadedFiles($question->getUploadedFiles($active_fi, $pass));
            }

            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_test_result');
    }

    protected function exportParticipantUploadedFiles(array $uploaded_files): void
    {
        foreach ($uploaded_files as $uploaded_file) {
            if ($uploaded_file['value2'] !== 'rid') {
                continue;
            }

            $rid_string = $uploaded_file['value1'];
            $rid = $this->irss->manage()->find($rid_string);
            if ($rid === null) {
                continue;
            }

            $target_dir = "$this->objects_export_directory/resources/$rid_string";
            ilFileUtils::makeDirParents($target_dir);
            file_put_contents(
                "$target_dir/{$this->irss->manage()->getCurrentRevision($rid)->getTitle()}",
                $this->irss->consume()->stream($rid)->getStream(),
            );
        }
    }

    protected function exportTestTimes(): void
    {
        $query = 'SELECT * FROM tst_times WHERE ' . $this->db->in('active_fi', $this->active_ids, false, 'integer') . ' ORDER BY active_fi';
        $result = $this->db->query($query);
        $this->xmlStartTag('tst_times', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $attrs = [
                'times_id' => $row['times_id'],
                'active_fi' => $row['active_fi'],
                'started' => $row['started'],
                'finished' => $row['finished'],
                'pass' => $row['pass'],
                'tstamp' => $row['tstamp']
            ];
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_times');
    }

    public function getXML(): void
    {
        $this->active_ids = [];
        $this->xmlHeader();
        $attrs = ['version' => '4.1.0'];
        $this->xmlStartTag('results', $attrs);
        $this->exportActiveIDs();

        if ($this->isIncludeRandomTestQuestionsEnabled()) {
            $this->exportRandomTestQuestions();
        }

        $this->exportPassResult();
        $this->exportResultCache();
        $this->exportTestSequence();
        $this->exportTestSolutions();
        $this->exportTestResults();
        $this->exportTestTimes();
        $this->xmlEndTag('results');
    }

    public function xmlDumpMem(bool $format = true): string
    {
        $this->getXML();
        return parent::xmlDumpMem($format);
    }

    public function xmlDumpFile(string $file, bool $format = true): void
    {
        $this->getXML();
        parent::xmlDumpFile($file, $format);
    }
}