class.ilQuestionpoolExport.php

Go to the documentation of this file.

<?php

include_once "./Modules/Test/classes/inc.AssessmentConstants.php";

class ilQuestionpoolExport
{
    public $err;                        // error object
    public $db;                 // database object
    public $ilias;                      // ilias object
    public $qpl_obj;            // questionpool object
    public $questions; // array with question ids to export
    public $inst_id;            // installation id
    public $mode;
    public $lng;

    private string $export_dir = '';
    private string $subdir = '';
    private string $filename = '';
    private string $zipfilename = '';
    private ilXmlWriter $xml;

    public function __construct($a_qpl_obj, $a_mode = "xml", $array_questions = null)
    {
        global $DIC;
        $ilErr = $DIC['ilErr'];
        $ilDB = $DIC['ilDB'];
        $ilias = $DIC['ilias'];
        $lng = $DIC['lng'];

        $this->qpl_obj = &$a_qpl_obj;
        if (!is_array($array_questions)) {
            $array_questions = &$a_qpl_obj->getAllQuestionIds();
        }

        $this->err = &$ilErr;
        $this->ilias = &$ilias;
        $this->db = &$ilDB;
        $this->mode = $a_mode;
        $this->lng = &$lng;
        $settings = $this->ilias->getAllSettings();
        $this->inst_id = IL_INST_ID;
        $this->questions = $array_questions;
        $date = time();
        $this->qpl_obj->createExportDirectory();
        switch ($this->mode) {
            case "xml":
                $this->export_dir = $this->qpl_obj->getExportDirectory('xml');
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "qpl" . "_" . $this->qpl_obj->getId();
                $this->filename = $this->subdir . ".xml";
                $this->qti_filename = $date . "__" . $this->inst_id . "__" .
                    "qti" . "_" . $this->qpl_obj->getId() . ".xml";
                break;
            case "xls":
                $this->export_dir = $this->qpl_obj->getExportDirectory('xls');
                $this->filename = $date . "__" . $this->inst_id . "__" .
                    "qpl" . "_" . $this->qpl_obj->getId() . ".xlsx";
                $this->zipfilename = $date . "__" . $this->inst_id . "__" .
                    "qpl" . "_" . $this->qpl_obj->getId() . ".zip";
                break;
            default:
                $this->export_dir = $this->qpl_obj->getExportDirectory('zip');
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "qpl" . "_" . $this->qpl_obj->getId();
                $this->filename = $this->subdir . ".xml";
                $this->qti_filename = $date . "__" . $this->inst_id . "__" .
                    "qti" . "_" . $this->qpl_obj->getId() . ".xml";
                break;
        }
    }

    public function getInstId()
    {
        return $this->inst_id;
    }


    public function buildExportFile(): string
    {
        switch ($this->mode) {
            case "xls":
                return $this->buildExportFileXLS();
            case "xml":
            default:
                return $this->buildExportFileXML();
        }
    }

    public function buildExportFileXML(): string
    {
        global $DIC;
        $ilBench = $DIC['ilBench'];

        $ilBench->start("QuestionpoolExport", "buildExportFile");

        include_once("./Services/Xml/classes/class.ilXmlWriter.php");
        $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 Questionpool " .
            $this->qpl_obj->getId() . " of installation " . $this->inst_id);

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

        // create directories
        include_once "./Services/Utilities/classes/class.ilUtil.php";
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir);
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir . "/objects");

        // get Log File
        $expDir = $this->qpl_obj->getExportDirectory();
        ilFileUtils::makeDirParents($expDir);

        include_once "./Services/Logging/classes/class.ilLog.php";
        $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, "w");
        fwrite($qti_file, $this->qpl_obj->questionsToXML($this->questions));
        fclose($qti_file);

        // get xml content
        $ilBench->start("QuestionpoolExport", "buildExportFile_getXML");
        $this->qpl_obj->objectToXmlWriter(
            $this->xml,
            $this->inst_id,
            $this->export_dir . "/" . $this->subdir,
            $expLog,
            $this->questions
        );
        $ilBench->stop("QuestionpoolExport", "buildExportFile_getXML");
        $ilBench->start("QuestionpoolExport", "buildExportFile_dumpToFile");
        $this->xml->xmlDumpFile($this->export_dir . "/" . $this->subdir . "/" . $this->filename, false);
        $ilBench->stop("QuestionpoolExport", "buildExportFile_dumpToFile");

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

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

        $ilBench->stop("QuestionpoolExport", "buildExportFile_zipFile");

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

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

    public function exportXHTMLMediaObjects($a_export_dir): void
    {
        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");

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

    protected function buildExportFileXLS(): string
    {
        require_once 'Modules/TestQuestionPool/classes/class.ilAssExcelFormatHelper.php';
        require_once 'Modules/TestQuestionPool/classes/class.assQuestion.php';

        $worksheet = new ilAssExcelFormatHelper();
        $worksheet->addSheet('Sheet 1');
        $row = 1;
        $col = 0;

        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col++) . $row, $this->lng->txt("title"));
        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col++) . $row, $this->lng->txt("description"));
        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col++) . $row, $this->lng->txt("question_type"));
        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col++) . $row, $this->lng->txt("author"));
        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col++) . $row, $this->lng->txt("create_date"));
        $worksheet->setFormattedExcelTitle($worksheet->getColumnCoord($col) . $row, $this->lng->txt("last_update"));

        $col = 0;
        $row++;
        $questions = $this->qpl_obj->getQuestionList();
        foreach ($questions as $question) {
            $worksheet->setCell($row, $col++, $question["title"]);
            $worksheet->setCell($row, $col++, $question["description"]);
            $worksheet->setCell($row, $col++, $this->lng->txt($question["type_tag"]));
            $worksheet->setCell($row, $col++, $question["author"]);
            $created = new ilDate($question["created"], IL_CAL_UNIX);
            $worksheet->setCell($row, $col++, $created);
            $updated = new ilDate($question["tstamp"], IL_CAL_UNIX);
            $worksheet->setCell($row, $col++, $updated);
            $col = 0;
            $row++;
        }

        $excelfile = $this->export_dir . '/' . $this->filename;
        $worksheet->writeToFile($excelfile);
        ilFileUtils::zip($excelfile, $this->export_dir . "/" . $this->zipfilename);
        if (@file_exists($this->export_dir . "/" . $this->filename)) {
            @unlink($this->export_dir . "/" . $this->filename);
        }
        return $this->export_dir . "/" . $this->zipfilename;
    }
}