Inheritance diagram for ilTestResultsToXML:

Collaboration diagram for ilTestResultsToXML:

Public Member Functions
	__construct (private int $test_id, private ilDBInterface $db, private ResourceStorage $irss, private string $objects_export_directory, private bool $anonymized=false,)

	isIncludeRandomTestQuestionsEnabled ()

	setIncludeRandomTestQuestionsEnabled (bool $include_random_test_questions_enabled)

	getXML ()

	xmlDumpMem (bool $format=true)

	xmlDumpFile (string $file, bool $format=true)

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
	$active_ids

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilTestResultsToXML::__construct	(	private int	$test_id,
		private ilDBInterface	$db,
		private ResourceStorage	$irss,
		private string	$objects_export_directory,
		private bool	$anonymized = `false`
	)

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

References ILIAS\MetaData\Repository\Validation\Data\__construct().

       {
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ exportActiveIDs()

ilTestResultsToXML::exportActiveIDs ( )

protected

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

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

Referenced by getXML().

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

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 231 of file class.ilTestResultsToXML.php.

References ilFileUtils\makeDirParents().

Referenced by exportTestResults().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportPassResult()

ilTestResultsToXML::exportPassResult ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportRandomTestQuestions()

ilTestResultsToXML::exportRandomTestQuestions ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportResultCache()

ilTestResultsToXML::exportResultCache ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestResults()

ilTestResultsToXML::exportTestResults ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestSequence()

ilTestResultsToXML::exportTestSequence ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestSolutions()

ilTestResultsToXML::exportTestSolutions ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportTestTimes()

ilTestResultsToXML::exportTestTimes ( )

protected

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

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

Referenced by getXML().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilTestResultsToXML::getXML ( )

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

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

Referenced by xmlDumpFile(), and xmlDumpMem().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isIncludeRandomTestQuestionsEnabled()

ilTestResultsToXML::isIncludeRandomTestQuestionsEnabled ( )

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

References $include_random_test_questions_enabled.

Referenced by getXML().

                                                          : bool
     {
         return $this->include_random_test_questions_enabled;
     }

Here is the caller graph for this function:

◆ setIncludeRandomTestQuestionsEnabled()

ilTestResultsToXML::setIncludeRandomTestQuestionsEnabled ( bool $include_random_test_questions_enabled )

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

References $include_random_test_questions_enabled.

Referenced by ilTestExport\buildExportFileXML().

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

Here is the caller graph for this function:

◆ xmlDumpFile()

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

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

References getXML().

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

Here is the call graph for this function:

◆ xmlDumpMem()

ilTestResultsToXML::xmlDumpMem ( bool $format = true )

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

References getXML().

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

Here is the call graph for this function:

Field Documentation

◆ $active_ids

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:

Modules/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