ilSurveyImporter Class Reference

Importer class for files. More...

Inheritance diagram for ilSurveyImporter:

Collaboration diagram for ilSurveyImporter:

Public Member Functions
	init ()
	Init. More...
	setSurvey (ilObjSurvey $a_val)
	Set current survey object (being imported). More...
	getSurvey ()
	Get current survey object. More...
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import XML. More...
Public Member Functions inherited from ilXmlImporter
	__construct ()
	Constructor. More...
	setImport ($a_val)
	Set import. More...
	getImport ()
	Get import. More...
	init ()
	Init. More...
	setInstallId ($a_val)
	Set installation id. More...
	getInstallId ()
	Get installation id. More...
	setInstallUrl ($a_val)
	Set installation url. More...
	getInstallUrl ()
	Get installation url. More...
	setSchemaVersion ($a_val)
	Set schema version. More...
	getSchemaVersion ()
	Get schema version. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setSkipEntities ($a_val)
	Set skip entities. More...
	getSkipEntities ()
	Get skip entities. More...
	exportedFromSameInstallation ()
	Is exporting and importing installation identical? More...
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import xml representation. More...
	finalProcessing ($a_mapping)
	Final processing. More...
	afterContainerImportProcessing (ilImportMapping $mapping)
	Called after all container objects have been implemented. More...

Protected Member Functions
	parseXmlFileNames ()
	Create qti and xml file name. More...

Protected Attributes
	$svy_log
Protected Attributes inherited from ilXmlImporter
	$skip_entities = array()
	$imp

Static Protected Attributes
static	$survey

Detailed Description

Importer class for files.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

Id

Definition at line 13 of file class.ilSurveyImporter.php.

Member Function Documentation

getSurvey()

ilSurveyImporter::getSurvey

(

)

Get current survey object.

Returns

ilObjSurvey survey

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

        {
                return self::$survey;
        }

References $survey.

importXmlRepresentation()

ilSurveyImporter::importXmlRepresentation	(		$a_entity,
			$a_id,
			$a_xml,
			$a_mapping
	)

Import XML.

Parameters

return

Reimplemented from ilXmlImporter.

Definition at line 70 of file class.ilSurveyImporter.php.

        {
                if ($a_entity == "svy")
                {
                        // Container import => test object already created
                        if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id))
                        {
                                $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                                #$newObj->setImportDirectory(dirname(rtrim($this->getImportDirectory(),'/')));
                        } else    // case ii, non container
                        {
                                $new_id = $a_mapping->getMapping("Modules/Survey", "svy", 0);
                                $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
                        }
                        $this->setSurvey($newObj);
 
                        include_once "./Services/Survey/classes/class.SurveyImportParser.php";
 
                        list($xml_file) = $this->parseXmlFileNames();
 
                        if (!@file_exists($xml_file))
                        {
                                $GLOBALS['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $xml_file);
                                return false;
                        }
                        $GLOBALS['ilLog']->write("getQuestionPoolID = ".$this->getImport()->getConfig("Modules/Survey")->getQuestionPoolID());
 
                        $import = new SurveyImportParser($this->getImport()->getConfig("Modules/Survey")->getQuestionPoolID(), $xml_file, true, $a_mapping);
 
                        $import->setSurveyObject($newObj);
                        $import->startParsing();
 
                        $this->svy_log->debug("is array import_mob_xml: -".is_array($_SESSION["import_mob_xhtml"])."-");
 
                        // this is "written" by Services/Survey/classes/class.ilSurveyImportParser
                        if (is_array($_SESSION["import_mob_xhtml"]))
                        {
                                include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
                                include_once "./Services/RTE/classes/class.ilRTE.php";
                                include_once "./Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php";
                                foreach ($_SESSION["import_mob_xhtml"] as $mob)
                                {
                                        $this->svy_log->debug("import mob xhtml, type: ".$mob["type"].", id: ".$mob["mob"]);
 
                                        if (!$mob["type"])
                                        {
                                                $mob["type"] = "svy:html";
                                        }
 
                                        $importfile = dirname($xml_file) . "/" . $mob["uri"];
                                        $this->svy_log->debug("import file: ".$importfile);
 
                                        if (file_exists($importfile))
                                        {
                                                $media_object = ilObjMediaObject::_saveTempFileAsMediaObject(basename($importfile), $importfile, false);
 
                                                // survey mob
                                                if ($mob["type"] == "svy:html")
                                                {
                                                        ilObjMediaObject::_saveUsage($media_object->getId(), "svy:html", $newObj->getId());
                                                        $this->svy_log->debug("old introduction: ".$newObj->getIntroduction());
                                                        $newObj->setIntroduction(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $newObj->getIntroduction()));
                                                        $newObj->setOutro(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $newObj->getOutro()));
 
                                                        $this->svy_log->debug("new introduction: ".$newObj->getIntroduction());
                                                }
                                                else if($import->questions[$mob["id"]])
                                                {
                                                        $new_qid = $import->questions[$mob["id"]];
                                                        ilObjMediaObject::_saveUsage($media_object->getId(), $mob["type"], $new_qid);
                                                        $new_question = SurveyQuestion::_instanciateQuestion($new_qid);
                                                        $qtext = $new_question->getQuestiontext();
 
                                                        $this->svy_log->debug("old question text: ".$qtext);
 
                                                        $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 0);
                                                        $qtext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $qtext);
                                                        $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 1);
                                                        $new_question->setQuestiontext($qtext);
                                                        $new_question->saveToDb();
 
                                                        $this->svy_log->debug("new question text: ".$qtext);
 
                                                        // also fix existing original in pool
                                                        if($new_question->getOriginalId())
                                                        {
                                                                $pool_question = SurveyQuestion::_instanciateQuestion($new_question->getOriginalId());
                                                                $pool_question->setQuestiontext($qtext);
                                                                $pool_question->saveToDb();
                                                        }
                                                }
                                        }
                                        else
                                        {
                                                $this->svy_log->error("Error: Could not open XHTML mob file for test introduction during test import. File $importfile does not exist!");
                                        }
                                }
                                $newObj->setIntroduction(ilRTE::_replaceMediaObjectImageSrc($newObj->getIntroduction(), 1));
                                $newObj->setOutro(ilRTE::_replaceMediaObjectImageSrc($newObj->getOutro(), 1));
                                $newObj->saveToDb();
                        }
 
                        $a_mapping->addMapping("Modules/Survey", "svy", $a_id, $newObj->getId());
                }
                else
                {
                        include_once("./Services/DataSet/classes/class.ilDataSetImportParser.php");
                        $parser = new ilDataSetImportParser($a_entity, $this->getSchemaVersion(),
                                        $a_xml, $this->ds, $a_mapping);
                }
 
                return true;
 
        }

References $_SESSION, $GLOBALS, $parser, SurveyQuestion\_instanciateQuestion(), ilRTE\_replaceMediaObjectImageSrc(), ilObjMediaObject\_saveTempFileAsMediaObject(), ilObjMediaObject\_saveUsage(), ilXmlImporter\getImport(), ilObjectFactory\getInstanceByObjId(), ilXmlImporter\getSchemaVersion(), parseXmlFileNames(), and setSurvey().

Here is the call graph for this function:

init()

ilSurveyImporter::init

(

)

Init.

Parameters

return

Reimplemented from ilXmlImporter.

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

        {
                include_once("./Modules/Survey/classes/class.ilSurveyDataSet.php");
                $this->ds = new ilSurveyDataSet();
                $this->ds->setDSPrefix("ds");
                $this->ds->setImport($this);
 
                $this->svy_log = ilLoggerFactory::getLogger("svy");
        }

References ilLoggerFactory\getLogger().

Here is the call graph for this function:

parseXmlFileNames()

ilSurveyImporter::parseXmlFileNames ( )

protected

Create qti and xml file name.

Returns

array

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

        {
                $GLOBALS['ilLog']->write(__METHOD__.': '.$this->getImportDirectory());
                
                $basename = basename($this->getImportDirectory());
                $xml = $this->getImportDirectory().'/'.$basename.'.xml';
                
                return array($xml);
        }

References $GLOBALS, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

Here is the call graph for this function:

Here is the caller graph for this function:

setSurvey()

ilSurveyImporter::setSurvey

(

ilObjSurvey

$a_val

)

Set current survey object (being imported).

This is done statically, since the survey import uses multiple input files being processed for every survey and all of these need the current survey object (ilSurveyImporter is intantiated multiple times)

Parameters

ilObjSurvey

$a_val

survey

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

        {
                self::$survey = $a_val;
        }

Referenced by importXmlRepresentation().

Here is the caller graph for this function:

Field Documentation

$survey

ilSurveyImporter::$survey

staticprotected

Definition at line 18 of file class.ilSurveyImporter.php.

Referenced by getSurvey().

$svy_log

ilSurveyImporter::$svy_log

protected

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

---

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

• Modules/Survey/classes/class.ilSurveyImporter.php