Inheritance diagram for ilTestResultsToXML:

Collaboration diagram for ilTestResultsToXML:

Public Member Functions
	__construct (private readonly ilObjTest $test_obj, private readonly ilDBInterface $db, private readonly ResourceStorage $irss, private readonly ilObjUser $user, private readonly ilLanguage $lng, private string $objects_export_directory)

	isIncludeRandomTestQuestionsEnabled ()

	setIncludeRandomTestQuestionsEnabled (bool $include_random_test_questions_enabled)

	getXML ()

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Protected Member Functions
	exportActiveIDs ()

	exportPassResult ()

	exportResultCache ()

	exportTestSequence ()

	exportTestSolutions ()

	exportRandomTestQuestions ()

	exportTestResults ()

	exportParticipantUploadedFiles (array $uploaded_files)

	exportTestTimes ()

Protected Attributes
bool	$include_random_test_questions_enabled = false

Private Attributes
array	$active_ids = []

Detailed Description

Definition at line 23 of file class.ilTestResultsToXML.php.

Constructor & Destructor Documentation

◆ __construct()

ilTestResultsToXML::__construct	(	private readonly ilObjTest	$test_obj,
		private readonly ilDBInterface	$db,
		private readonly ResourceStorage	$irss,
		private readonly ilObjUser	$user,
		private readonly ilLanguage	$lng,
		private string	$objects_export_directory
	)

Definition at line 29 of file class.ilTestResultsToXML.php.

      {
        parent::__construct();
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ exportActiveIDs()

ilTestResultsToXML::exportActiveIDs ( )

protected

Definition at line 50 of file class.ilTestResultsToXML.php.

                                        : void
    {
        $user_criteria = (new ilSetting('assessment'))->get('user_criteria', 'usr_id');
 
        $query = $this->test_obj->getAnonymity()
            ? 'SELECT * FROM tst_active WHERE test_fi = %s'
            : "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";
        $result = $this->db->queryF($query, [ilDBConstants::T_INTEGER], [$this->test_obj->getTestId()]);
 
        $test_participant_list = new ilTestParticipantList($this->test_obj, $this->user, $this->lng, $this->db);
        $test_participant_list->initializeFromDbRows($this->test_obj->getTestParticipants());
 
        $this->xmlStartTag('tst_active', null);
        while ($row = $this->db->fetchAssoc($result)) {
            $this->active_ids[] = $row['active_id'];
            $participant = $test_participant_list->getParticipantByActiveId($row['active_id']);
 
            $attrs = [
                'active_id' => $row['active_id'],
                'user_fi' => $this->test_obj->getAnonymity() ? '' : ($row['user_fi'] ?? ''),
                'fullname' => $participant ? $test_participant_list->buildFullname($participant) : '',
                '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'] ?? ''
            ];
 
            if (!$this->test_obj->getAnonymity()) {
                $attrs['user_criteria'] = $user_criteria;
                $attrs[$user_criteria] = $row[$user_criteria];
            }
 
            $this->xmlElement('row', $attrs);
        }
        $this->xmlEndTag('tst_active');
    }

References ILIAS\Repository\lng(), ilDBConstants\T_INTEGER, ILIAS\Repository\user(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportParticipantUploadedFiles()

ilTestResultsToXML::exportParticipantUploadedFiles ( array $uploaded_files )

protected

Parameters

array{value1 string, value2: string} $uploaded_files

Definition at line 227 of file class.ilTestResultsToXML.php.

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

References ilFileUtils\makeDirParents().

Referenced by exportTestResults().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportPassResult()

ilTestResultsToXML::exportPassResult ( )

protected

Definition at line 92 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportRandomTestQuestions()

ilTestResultsToXML::exportRandomTestQuestions ( )

protected

Definition at line 175 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportResultCache()

ilTestResultsToXML::exportResultCache ( )

protected

Definition at line 113 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestResults()

ilTestResultsToXML::exportTestResults ( )

protected

Definition at line 197 of file class.ilTestResultsToXML.php.

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

References exportParticipantUploadedFiles(), assQuestion\instantiateQuestion(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestSequence()

ilTestResultsToXML::exportTestSequence ( )

protected

Definition at line 135 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestSolutions()

ilTestResultsToXML::exportTestSolutions ( )

protected

Definition at line 154 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestTimes()

ilTestResultsToXML::exportTestTimes ( )

protected

Definition at line 249 of file class.ilTestResultsToXML.php.

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilTestResultsToXML::getXML ( )

Definition at line 268 of file class.ilTestResultsToXML.php.

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

References exportActiveIDs(), exportPassResult(), exportRandomTestQuestions(), exportResultCache(), exportTestResults(), exportTestSequence(), exportTestSolutions(), exportTestTimes(), isIncludeRandomTestQuestionsEnabled(), ilXmlWriter\xmlEndTag(), ilXmlWriter\xmlHeader(), and ilXmlWriter\xmlStartTag().

Referenced by xmlDumpFile(), and xmlDumpMem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIncludeRandomTestQuestionsEnabled()

ilTestResultsToXML::isIncludeRandomTestQuestionsEnabled ( )

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

                                                         : bool
    {
        return $this->include_random_test_questions_enabled;
    }

References $include_random_test_questions_enabled.

Referenced by getXML().

Here is the caller graph for this function:

◆ setIncludeRandomTestQuestionsEnabled()

ilTestResultsToXML::setIncludeRandomTestQuestionsEnabled ( bool $include_random_test_questions_enabled )

Definition at line 45 of file class.ilTestResultsToXML.php.

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

References $include_random_test_questions_enabled.

◆ xmlDumpFile()

ilTestResultsToXML::xmlDumpFile	(	string	$file,
		bool	$format = `true`
	)

Dumps xml document from memory into a file.

Reimplemented from ilXmlWriter.

Definition at line 295 of file class.ilTestResultsToXML.php.

                                                                  : void
    {
        $this->getXML();
        parent::xmlDumpFile($file, $format);
    }

References getXML().

Here is the call graph for this function:

◆ xmlDumpMem()

ilTestResultsToXML::xmlDumpMem ( bool $format = true )

Returns xml document from memory.

Reimplemented from ilXmlWriter.

Definition at line 289 of file class.ilTestResultsToXML.php.

                                                   : string
    {
        $this->getXML();
        return parent::xmlDumpMem($format);
    }

References getXML().

Here is the call graph for this function:

Field Documentation

◆ $active_ids

array ilTestResultsToXML::$active_ids = []

private

Definition at line 25 of file class.ilTestResultsToXML.php.

◆ $include_random_test_questions_enabled

bool ilTestResultsToXML::$include_random_test_questions_enabled = false

protected

Definition at line 27 of file class.ilTestResultsToXML.php.

Referenced by isIncludeRandomTestQuestionsEnabled(), and setIncludeRandomTestQuestionsEnabled().

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

components/ILIAS/Test/classes/class.ilTestResultsToXML.php

Public Member Functions

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ exportActiveIDs()

◆ exportParticipantUploadedFiles()

◆ exportPassResult()

◆ exportRandomTestQuestions()

◆ exportResultCache()

◆ exportTestResults()

◆ exportTestSequence()

◆ exportTestSolutions()

◆ exportTestTimes()

◆ getXML()

◆ isIncludeRandomTestQuestionsEnabled()

◆ setIncludeRandomTestQuestionsEnabled()

◆ xmlDumpFile()

◆ xmlDumpMem()

Field Documentation

◆ $active_ids

◆ $include_random_test_questions_enabled