ilTestExport Class Reference

Export class for tests. More...

Inheritance diagram for ilTestExport:

Collaboration diagram for ilTestExport:

Public Member Functions
	__construct (public ilObjTest $test_obj, public string $mode="xml")
	isResultExportingEnabledForTestExport ()
	setResultExportingEnabledForTestExport (bool $resultExprtingEnabledForTestExport)
	getForcedAccessFilteredParticipantList ()
	setForcedAccessFilteredParticipantList (ilTestParticipantList $forcedAccessFilteredParticipantList)
	getAccessFilteredParticipantList ()
	getExtension ()
	getInstId ()
	buildExportFile ()
	buildExportResultFile ()
	buildExportFileXML ()
	exportXHTMLMediaObjects ($a_export_dir)

Protected Member Functions
	initXmlExport ()
	getQuestionIds ()
	populateQuestionSetConfigXml (ilXmlWriter $xmlWriter)
	getQtiXml ()
	getQuestionsQtiXml ()
	getQuestionQtiXml ($questionId)
	populateQuestionSkillAssignmentsXml (ilXmlWriter $a_xml_writer, ilAssQuestionSkillAssignmentList $assignmentList, array $questions)
	populateSkillLevelThresholdsXml (ilXmlWriter $a_xml_writer, ilAssQuestionSkillAssignmentList $assignmentList)
	buildQuestionSkillAssignmentList ()

Protected Attributes
bool	$resultExportingEnabledForTestExport = false
ilTestParticipantList	$forcedAccessFilteredParticipantList = null
ilBenchmark	$bench
ilErrorHandling	$err
ilDBInterface	$db
ILIAS	$ilias
string	$inst_id

Private Attributes
string	$export_dir
string	$subdir
string	$qti_filename
string	$filename
string	$resultsfile
ilXmlWriter	$xml
ilLanguage	$lng
ResourceStorage	$irss

Detailed Description

Export class for tests.

Author

Helmut Schottmüller helmu.nosp@m.t.sc.nosp@m.hottm.nosp@m.uell.nosp@m.er@ma.nosp@m.c.co.nosp@m.m

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

Björn Heyser bheys.nosp@m.er@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 36 of file class.ilTestExport.php.

Constructor & Destructor Documentation

__construct()

ilTestExport::__construct	(	public ilObjTest	$test_obj,
		public string	$mode = "xml"
	)

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

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

      {
        global $DIC;
        $this->err = $DIC['ilErr'];
        $this->ilias = $DIC['ilias'];
        $this->db = $DIC['ilDB'];
        $this->lng = $DIC['lng'];
        $this->bench = $DIC['ilBench'];
        $this->irss = $DIC['resource_storage'];

        $this->inst_id = (string) IL_INST_ID;

        $date = time();
        $this->export_dir = $this->test_obj->getExportDirectory();

        switch ($this->mode) {
            case "results":
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "tst__results_" . $this->test_obj->getId();
                break;
            case "aggregated":
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "test__aggregated__results_" . $this->test_obj->getId();
                break;
            default:
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "tst" . "_" . $this->test_obj->getId();
                $this->filename = $this->subdir . ".xml";
                $this->resultsfile = $date . "__" . $this->inst_id . "__" .
                    "results" . "_" . $this->test_obj->getId() . ".xml";
                $this->qti_filename = $date . "__" . $this->inst_id . "__" .
                    "qti" . "_" . $this->test_obj->getId() . ".xml";
                break;
        }
        $this->filename = $this->subdir . "." . $this->getExtension();
    }

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ilTestExport::buildExportFile

(

)

Definition at line 144 of file class.ilTestExport.php.

References buildExportFileXML(), and buildExportResultFile().

                                     : string
    {
        switch ($this->mode) {
            case "results":
                return $this->buildExportResultFile();
                break;
            default:
                return $this->buildExportFileXML();
                break;
        }
    }

Here is the call graph for this function:

buildExportFileXML()

ilTestExport::buildExportFileXML

(

)

Definition at line 190 of file class.ilTestExport.php.

References $db, $irss, buildQuestionSkillAssignmentList(), exportXHTMLMediaObjects(), getQtiXml(), getQuestionIds(), initXmlExport(), isResultExportingEnabledForTestExport(), ilFileUtils\makeDir(), populateQuestionSetConfigXml(), populateQuestionSkillAssignmentsXml(), populateSkillLevelThresholdsXml(), ilTestResultsToXML\setIncludeRandomTestQuestionsEnabled(), and ilFileUtils\zip().

Referenced by buildExportFile().

                                        : string
    {
        $this->bench->start("TestExport", "buildExportFile");

        $this->initXmlExport();

        $this->xml = new ilXmlWriter();

        // set dtd definition
        $this->xml->xmlSetDtdDef("<!DOCTYPE Test SYSTEM \"http://www.ilias.uni-koeln.de/download/dtd/ilias_co.dtd\">");

        // set generated comment
        $this->xml->xmlSetGenCmt("Export of ILIAS Test " .
            $this->test_obj->getId() . " of installation " . $this->inst_id . ".");

        // set xml header
        $this->xml->xmlHeader();

        $this->xml->xmlStartTag("ContentObject", array('Type' => 'Test'));

        // create directories
        $this->test_obj->createExportDirectory();
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir);
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir . "/objects");

        // get Log File
        $expDir = $this->test_obj->getExportDirectory();
        $expLog = new ilLog($expDir, "export.log");
        $expLog->delete();
        $expLog->setLogFormat("");
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export");

        // write qti file
        $qti_file = fopen($this->export_dir . "/" . $this->subdir . "/" . $this->qti_filename, "wb");
        fwrite($qti_file, $this->getQtiXml());
        fclose($qti_file);

        // get xml content
        $this->bench->start("TestExport", "buildExportFile_getXML");
        $this->test_obj->exportPagesXML(
            $this->xml,
            $this->inst_id,
            $this->export_dir . "/" . $this->subdir,
            $expLog
        );
        $this->bench->stop("TestExport", "buildExportFile_getXML");

        $this->populateQuestionSetConfigXml($this->xml);

        $assignmentList = $this->buildQuestionSkillAssignmentList();
        $this->populateQuestionSkillAssignmentsXml($this->xml, $assignmentList, $this->getQuestionIds());
        $this->populateSkillLevelThresholdsXml($this->xml, $assignmentList);

        $this->xml->xmlEndTag("ContentObject");

        $this->bench->start("TestExport", "buildExportFile_dumpToFile");
        $this->xml->xmlDumpFile($this->export_dir . "/" . $this->subdir . "/" . $this->filename, false);
        $this->bench->stop("TestExport", "buildExportFile_dumpToFile");

        if ($this->isResultExportingEnabledForTestExport()) {
            $resultwriter = new ilTestResultsToXML(
                $this->test_obj->getTestId(),
                $this->db,
                $this->irss,
                $this->export_dir . "/" . $this->subdir . "/objects",
                $this->test_obj->getAnonymity()
            );
            $resultwriter->setIncludeRandomTestQuestionsEnabled($this->test_obj->isRandomTest());
            $this->bench->start("TestExport", "buildExportFile_results");
            $resultwriter->xmlDumpFile($this->export_dir . "/" . $this->subdir . "/" . $this->resultsfile, false);
            $this->bench->stop("TestExport", "buildExportFile_results");
        }

        // add media objects which were added with tiny mce
        $this->bench->start("QuestionpoolExport", "buildExportFile_saveAdditionalMobs");
        $this->exportXHTMLMediaObjects($this->export_dir . "/" . $this->subdir);
        $this->bench->stop("QuestionpoolExport", "buildExportFile_saveAdditionalMobs");

        // zip the file
        $this->bench->start("TestExport", "buildExportFile_zipFile");
        ilFileUtils::zip(
            $this->export_dir . "/" . $this->subdir,
            $this->export_dir . "/" . $this->subdir . ".zip"
        );
        $this->bench->stop("TestExport", "buildExportFile_zipFile");

        // destroy writer object
        $this->xml = null;

        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export");
        $this->bench->stop("TestExport", "buildExportFile");

        return $this->export_dir . "/" . $this->subdir . ".zip";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildExportResultFile()

ilTestExport::buildExportResultFile

(

)

Definition at line 156 of file class.ilTestExport.php.

References $data, $filename, ilTestEvaluationData\FILTER_BY_NONE, getExtension(), getQuestionIds(), initXmlExport(), and ilFileUtils\makeDir().

Referenced by buildExportFile().

                                           : string
    {
        //get Log File
        $expDir = $this->test_obj->getExportDirectory();

        // make_directories
        $this->test_obj->createExportDirectory();
        ilFileUtils::makeDir($this->export_dir);

        $expLog = new ilLog($expDir, "export.log");
        $expLog->delete();
        $expLog->setLogFormat("");
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export Of Results");

        $data = (new ilCSVTestExport($this->test_obj, ilTestEvaluationData::FILTER_BY_NONE, '', false))->withAllResults()->getContent();
        $file = fopen($this->export_dir . "/" . $this->filename, "wb");
        fwrite($file, $data);
        fclose($file);

        $worksheet = (new ilExcelTestExport($this->test_obj, ilTestEvaluationData::FILTER_BY_NONE, '', false, true))
            ->withResultsPage()
            ->withUserPages()
            ->getContent();
        $worksheet->writeToFile($this->export_dir . "/" . str_replace($this->getExtension(), "xlsx", $this->filename));
        // end
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export of Results");

        return $this->export_dir . "/" . $this->filename;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildQuestionSkillAssignmentList()

ilTestExport::buildQuestionSkillAssignmentList ( )

protected

Definition at line 365 of file class.ilTestExport.php.

Referenced by buildExportFileXML().

                                                         : ilAssQuestionSkillAssignmentList
    {
        $assignmentList = new ilAssQuestionSkillAssignmentList($this->db);
        $assignmentList->setParentObjId($this->test_obj->getId());
        $assignmentList->loadFromDb();
        $assignmentList->loadAdditionalSkillData();

        return $assignmentList;
    }

Here is the caller graph for this function:

exportXHTMLMediaObjects()

ilTestExport::exportXHTMLMediaObjects

(

$a_export_dir

)

Definition at line 315 of file class.ilTestExport.php.

References ilObjMediaObject\_exists(), ilObjMediaObject\_getMobsOfObject(), and getQuestionIds().

Referenced by buildExportFileXML().

                                                          : void
    {
        $mobs = ilObjMediaObject::_getMobsOfObject("tst:html", $this->test_obj->getId());

        foreach ($mobs as $mob) {
            if (ilObjMediaObject::_exists($mob)) {
                $mob_obj = new ilObjMediaObject($mob);
                $mob_obj->exportFiles($a_export_dir);
                unset($mob_obj);
            }
        }
        foreach ($this->getQuestionIds() as $question_id) {
            $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $question_id);
            foreach ($mobs as $mob) {
                if (ilObjMediaObject::_exists($mob)) {
                    $mob_obj = new ilObjMediaObject($mob);
                    $mob_obj->exportFiles($a_export_dir);
                    unset($mob_obj);
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAccessFilteredParticipantList()

ilTestExport::getAccessFilteredParticipantList

(

)

Definition at line 118 of file class.ilTestExport.php.

References getForcedAccessFilteredParticipantList().

                                                      : ?ilTestParticipantList
    {
        if ($this->getForcedAccessFilteredParticipantList() instanceof ilTestParticipantList) {
            return $this->getForcedAccessFilteredParticipantList();
        }

        return $this->test_obj->buildStatisticsAccessFilteredParticipantList();
    }

Here is the call graph for this function:

getExtension()

ilTestExport::getExtension

(

)

Definition at line 127 of file class.ilTestExport.php.

Referenced by __construct(), and buildExportResultFile().

                                  : string
    {
        switch ($this->mode) {
            case "results":
                return "csv";
                break;
            default:
                return "xml";
                break;
        }
    }

Here is the caller graph for this function:

getForcedAccessFilteredParticipantList()

ilTestExport::getForcedAccessFilteredParticipantList

(

)

Definition at line 108 of file class.ilTestExport.php.

References $forcedAccessFilteredParticipantList.

Referenced by getAccessFilteredParticipantList().

                                                            : ?ilTestParticipantList
    {
        return $this->forcedAccessFilteredParticipantList;
    }

Here is the caller graph for this function:

getInstId()

ilTestExport::getInstId

(

)

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

References $inst_id.

    {
        return $this->inst_id;
    }

getQtiXml()

ilTestExport::getQtiXml ( )

protected

Definition at line 287 of file class.ilTestExport.php.

References getQuestionsQtiXml().

Referenced by buildExportFileXML().

    {
        $tstQtiXml = $this->test_obj->toXML();
        $qstQtiXml = $this->getQuestionsQtiXml();

        if (strpos($tstQtiXml, "</section>") !== false) {
            $qtiXml = str_replace("</section>", "$qstQtiXml</section>", $tstQtiXml);
        } else {
            $qtiXml = str_replace("<section ident=\"1\"/>", "<section ident=\"1\">\n$qstQtiXml</section>", $tstQtiXml);
        }

        return $qtiXml;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestionIds()

ilTestExport::getQuestionIds ( )

abstractprotected

Referenced by buildExportFileXML(), buildExportResultFile(), and exportXHTMLMediaObjects().

Here is the caller graph for this function:

getQuestionQtiXml()

ilTestExport::getQuestionQtiXml (   $questionId )

protected

Definition at line 303 of file class.ilTestExport.php.

References $xml, and assQuestion\instantiateQuestion().

Referenced by ilTestExportFixedQuestionSet\getQuestionsQtiXml(), and ilTestExportRandomQuestionSet\getQuestionsQtiXml().

                                                     : string
    {
        $questionOBJ = assQuestion::instantiateQuestion($questionId);
        $xml = $questionOBJ->toXML(false);

        // still neccessary? there is an include header flag!?
        $xml = preg_replace("/<questestinterop>/", "", $xml);
        $xml = preg_replace("/<\/questestinterop>/", "", $xml);

        return $xml;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getQuestionsQtiXml()

ilTestExport::getQuestionsQtiXml ( )

abstractprotected

Referenced by getQtiXml().

Here is the caller graph for this function:

initXmlExport()

ilTestExport::initXmlExport ( )

abstractprotected

Referenced by buildExportFileXML(), and buildExportResultFile().

Here is the caller graph for this function:

isResultExportingEnabledForTestExport()

ilTestExport::isResultExportingEnabledForTestExport

(

)

Definition at line 98 of file class.ilTestExport.php.

References $resultExportingEnabledForTestExport.

Referenced by buildExportFileXML().

                                                           : bool
    {
        return $this->resultExportingEnabledForTestExport;
    }

Here is the caller graph for this function:

populateQuestionSetConfigXml()

ilTestExport::populateQuestionSetConfigXml ( ilXmlWriter  $xmlWriter )

abstractprotected

Referenced by buildExportFileXML().

Here is the caller graph for this function:

populateQuestionSkillAssignmentsXml()

ilTestExport::populateQuestionSkillAssignmentsXml ( ilXmlWriter  $a_xml_writer, ilAssQuestionSkillAssignmentList  $assignmentList, array  $questions  )

protected

Definition at line 338 of file class.ilTestExport.php.

Referenced by buildExportFileXML().

      {
        $skillQuestionAssignmentExporter = new ilAssQuestionSkillAssignmentExporter();
        $skillQuestionAssignmentExporter->setXmlWriter($a_xml_writer);
        $skillQuestionAssignmentExporter->setQuestionIds($questions);
        $skillQuestionAssignmentExporter->setAssignmentList($assignmentList);
        $skillQuestionAssignmentExporter->export();
    }

Here is the caller graph for this function:

populateSkillLevelThresholdsXml()

ilTestExport::populateSkillLevelThresholdsXml ( ilXmlWriter  $a_xml_writer, ilAssQuestionSkillAssignmentList  $assignmentList  )

protected

Definition at line 350 of file class.ilTestExport.php.

Referenced by buildExportFileXML().

      {
        $thresholdList = new ilTestSkillLevelThresholdList($this->db);
        $thresholdList->setTestId($this->test_obj->getTestId());
        $thresholdList->loadFromDb();

        $skillLevelThresholdExporter = new ilTestSkillLevelThresholdExporter();
        $skillLevelThresholdExporter->setXmlWriter($a_xml_writer);
        $skillLevelThresholdExporter->setAssignmentList($assignmentList);
        $skillLevelThresholdExporter->setThresholdList($thresholdList);
        $skillLevelThresholdExporter->export();
    }

Here is the caller graph for this function:

setForcedAccessFilteredParticipantList()

ilTestExport::setForcedAccessFilteredParticipantList

(

ilTestParticipantList

$forcedAccessFilteredParticipantList

)

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

References $forcedAccessFilteredParticipantList.

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

setResultExportingEnabledForTestExport()

ilTestExport::setResultExportingEnabledForTestExport

(

bool

$resultExprtingEnabledForTestExport

)

Definition at line 103 of file class.ilTestExport.php.

                                                                                                    : void
    {
        $this->resultExportingEnabledForTestExport = $resultExprtingEnabledForTestExport;
    }

Field Documentation

$bench

ilBenchmark ilTestExport::$bench

protected

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

$db

ilDBInterface ilTestExport::$db

protected

Definition at line 53 of file class.ilTestExport.php.

Referenced by buildExportFileXML().

$err

ilErrorHandling ilTestExport::$err

protected

Definition at line 52 of file class.ilTestExport.php.

$export_dir

string ilTestExport::$export_dir

private

Definition at line 38 of file class.ilTestExport.php.

$filename

string ilTestExport::$filename

private

Definition at line 41 of file class.ilTestExport.php.

Referenced by buildExportResultFile().

$forcedAccessFilteredParticipantList

ilTestParticipantList ilTestExport::$forcedAccessFilteredParticipantList = null

protected

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

Referenced by getForcedAccessFilteredParticipantList(), and setForcedAccessFilteredParticipantList().

$ilias

ILIAS ilTestExport::$ilias

protected

Definition at line 54 of file class.ilTestExport.php.

$inst_id

string ilTestExport::$inst_id

protected

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

Referenced by getInstId().

$irss

ResourceStorage ilTestExport::$irss

private

Definition at line 57 of file class.ilTestExport.php.

Referenced by buildExportFileXML().

$lng

ilLanguage ilTestExport::$lng

private

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

$qti_filename

string ilTestExport::$qti_filename

private

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

$resultExportingEnabledForTestExport

bool ilTestExport::$resultExportingEnabledForTestExport = false

protected

Definition at line 47 of file class.ilTestExport.php.

Referenced by isResultExportingEnabledForTestExport().

$resultsfile

string ilTestExport::$resultsfile

private

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

$subdir

string ilTestExport::$subdir

private

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

$xml

ilXmlWriter ilTestExport::$xml

private

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

Referenced by getQuestionQtiXml().

---

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

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