ilSurveyExport Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSurveyExport:

Public Member Functions
	__construct (ilObjSurvey $a_survey_obj, $a_mode="xml")
	getInstId ()
	buildExportFile ()
	buildExportFileXML ()
	build xml export file More...
	exportXHTMLMediaObjects (string $a_export_dir)

Data Fields
ilDBInterface	$db
ilObjSurvey	$survey_obj
int	$inst_id
string	$mode
string	$subdir
string	$filename
string	$export_dir

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Export class for surveys

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

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

Constructor & Destructor Documentation

__construct()

ilSurveyExport::__construct	(	ilObjSurvey	$a_survey_obj,
			$a_mode = "xml"
	)

Definition at line 33 of file class.ilSurveyExport.php.

      {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $this->survey_obj = $a_survey_obj;
 
        $this->db = $ilDB;
        $this->mode = $a_mode;
        $this->inst_id = (int) IL_INST_ID;
 
        $date = time();
        switch ($this->mode) {
            default:
                $this->export_dir = $this->survey_obj->getExportDirectory();
                $this->subdir = $date . "__" . $this->inst_id . "__" .
                    "svy" . "_" . $this->survey_obj->getId();
                $this->filename = $this->subdir . ".xml";
                break;
        }
    }

References $DIC, $ilDB, IL_INST_ID, and ILIAS\Repository\int().

Here is the call graph for this function:

Member Function Documentation

buildExportFile()

ilSurveyExport::buildExportFile

(

)

Returns

string export file name

Definition at line 67 of file class.ilSurveyExport.php.

                                     : string
    {
        switch ($this->mode) {
            default:
                return $this->buildExportFileXML();
        }
    }

References buildExportFileXML().

Here is the call graph for this function:

buildExportFileXML()

ilSurveyExport::buildExportFileXML

(

)

build xml export file

Returns

string export file name

Exceptions

ilLogException
ilSurveyException

Definition at line 81 of file class.ilSurveyExport.php.

                                        : string
    {
        // create directories
        $this->survey_obj->createExportDirectory();
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir);
        ilFileUtils::makeDir($this->export_dir . "/" . $this->subdir . "/objects");
 
        // get Log File
        $expDir = $this->survey_obj->getExportDirectory();
        $expLog = new ilLog($expDir, "export.log");
        $expLog->delete();
        $expLog->setLogFormat("");
        $expLog->write(date("[y-m-d H:i:s] ") . "Start Export");
 
        // write xml file
        $xmlFile = fopen($this->export_dir . "/" . $this->subdir . "/" . $this->filename, 'wb');
        fwrite($xmlFile, $this->survey_obj->toXML());
        fclose($xmlFile);
 
        // add media objects which were added with tiny mce
        $this->exportXHTMLMediaObjects($this->export_dir . "/" . $this->subdir);
 
        // zip the file
        ilFileUtils::zip($this->export_dir . "/" . $this->subdir, $this->export_dir . "/" . $this->subdir . ".zip");
 
        if (file_exists($this->export_dir . "/" . $this->subdir . ".zip")) {
            // remove export directory and contents
            if (is_dir($this->export_dir . "/" . $this->subdir)) {
                ilFileUtils::delDir($this->export_dir . "/" . $this->subdir);
            }
        }
        $expLog->write(date("[y-m-d H:i:s] ") . "Finished Export");
 
        return $this->export_dir . "/" . $this->subdir . ".zip";
    }

References ilFileUtils\delDir(), exportXHTMLMediaObjects(), ilFileUtils\makeDir(), and ilFileUtils\zip().

Referenced by buildExportFile().

Here is the call graph for this function:

Here is the caller graph for this function:

exportXHTMLMediaObjects()

ilSurveyExport::exportXHTMLMediaObjects

(

string

$a_export_dir

)

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

     : void {
        $mobs = ilObjMediaObject::_getMobsOfObject("svy:html", $this->survey_obj->getId());
        foreach ($mobs as $mob) {
            $mob_obj = new ilObjMediaObject($mob);
            $mob_obj->exportFiles($a_export_dir);
            unset($mob_obj);
        }
        // #14850
        foreach ($this->survey_obj->questions as $question_id) {
            $mobs = ilObjMediaObject::_getMobsOfObject("spl:html", $question_id);
            foreach ($mobs as $mob) {
                $mob_obj = new ilObjMediaObject($mob);
                $mob_obj->exportFiles($a_export_dir);
                unset($mob_obj);
            }
        }
    }

Referenced by buildExportFileXML().

Here is the caller graph for this function:

getInstId()

ilSurveyExport::getInstId

(

)

Definition at line 58 of file class.ilSurveyExport.php.

                               : int
    {
        return $this->inst_id;
    }

References $inst_id.

Field Documentation

$db

ilDBInterface ilSurveyExport::$db

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

$export_dir

string ilSurveyExport::$export_dir

Definition at line 31 of file class.ilSurveyExport.php.

$filename

string ilSurveyExport::$filename

Definition at line 30 of file class.ilSurveyExport.php.

$inst_id

int ilSurveyExport::$inst_id

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

Referenced by getInstId().

$mode

string ilSurveyExport::$mode

Definition at line 28 of file class.ilSurveyExport.php.

$subdir

string ilSurveyExport::$subdir

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

$survey_obj

ilObjSurvey ilSurveyExport::$survey_obj

Definition at line 26 of file class.ilSurveyExport.php.

---

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

• components/ILIAS/Survey/Export/class.ilSurveyExport.php