ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes
ilSurveyImporter Class Reference
Modules/Survey

Importer class for files. More...

+ Inheritance diagram for ilSurveyImporter:
+ Collaboration diagram for ilSurveyImporter:

Public Member Functions

 __construct ()
 Constructor. More...
 
 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

 $log
 
 $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.

Constructor & Destructor Documentation

◆ __construct()

ilSurveyImporter::__construct ( )

Constructor.

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

References $DIC.

25  {
26  parent::__construct();
27  global $DIC;
28 
29  $this->log = $DIC["ilLog"];
30  }
$DIC
global $DIC
Definition: saml.php:7

Member Function Documentation

◆ getSurvey()

ilSurveyImporter::getSurvey ( )

Get current survey object.

Returns
ilObjSurvey survey

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

77  {
78  return self::$survey;
79  }

◆ importXmlRepresentation()

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

Import XML.

Parameters
$a_entity
$a_id
$a_xml
ilImportMapping$a_mapping
Returns
bool|string
Exceptions
ilDatabaseException
ilImportException
ilObjectNotFoundException

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

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

94  {
95  if ($a_entity == "svy") {
96  // Container import => test object already created
97  if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
98  $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
99  #$newObj->setImportDirectory(dirname(rtrim($this->getImportDirectory(),'/')));
100  } else { // case ii, non container
101  $new_id = $a_mapping->getMapping("Modules/Survey", "svy", 0);
102  $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);
103  }
104  $this->setSurvey($newObj);
105 
106  include_once "./Services/Survey/classes/class.SurveyImportParser.php";
107 
108  list($xml_file) = $this->parseXmlFileNames();
109 
110  if (!@file_exists($xml_file)) {
111  $GLOBALS['ilLog']->write(__METHOD__ . ': Cannot find xml definition: ' . $xml_file);
112  return false;
113  }
114  $GLOBALS['ilLog']->write("getQuestionPoolID = " . $this->getImport()->getConfig("Modules/Survey")->getQuestionPoolID());
115 
116  $import = new SurveyImportParser($this->getImport()->getConfig("Modules/Survey")->getQuestionPoolID(), $xml_file, true, $a_mapping);
117 
118  $import->setSurveyObject($newObj);
119  $import->startParsing();
120 
121  $this->svy_log->debug("is array import_mob_xml: -" . is_array($_SESSION["import_mob_xhtml"]) . "-");
122 
123  // this is "written" by Services/Survey/classes/class.ilSurveyImportParser
124  if (is_array($_SESSION["import_mob_xhtml"])) {
125  include_once "./Services/MediaObjects/classes/class.ilObjMediaObject.php";
126  include_once "./Services/RTE/classes/class.ilRTE.php";
127  include_once "./Modules/TestQuestionPool/classes/class.ilObjQuestionPool.php";
128  foreach ($_SESSION["import_mob_xhtml"] as $mob) {
129  $this->svy_log->debug("import mob xhtml, type: " . $mob["type"] . ", id: " . $mob["mob"]);
130 
131  if (!$mob["type"]) {
132  $mob["type"] = "svy:html";
133  }
134 
135  $importfile = dirname($xml_file) . "/" . $mob["uri"];
136  $this->svy_log->debug("import file: " . $importfile);
137 
138  if (file_exists($importfile)) {
139  $media_object = ilObjMediaObject::_saveTempFileAsMediaObject(basename($importfile), $importfile, false);
140 
141  // survey mob
142  if ($mob["type"] == "svy:html") {
143  ilObjMediaObject::_saveUsage($media_object->getId(), "svy:html", $newObj->getId());
144  $this->svy_log->debug("old introduction: " . $newObj->getIntroduction());
145  $newObj->setIntroduction(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $newObj->getIntroduction()));
146  $newObj->setOutro(str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $newObj->getOutro()));
147 
148  $this->svy_log->debug("new introduction: " . $newObj->getIntroduction());
149  } elseif ($import->questions[$mob["id"]]) {
150  $new_qid = $import->questions[$mob["id"]];
151  ilObjMediaObject::_saveUsage($media_object->getId(), $mob["type"], $new_qid);
152  $new_question = SurveyQuestion::_instanciateQuestion($new_qid);
153  $qtext = $new_question->getQuestiontext();
154 
155  $this->svy_log->debug("old question text: " . $qtext);
156 
157  $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 0);
158  $qtext = str_replace("src=\"" . $mob["mob"] . "\"", "src=\"" . "il_" . IL_INST_ID . "_mob_" . $media_object->getId() . "\"", $qtext);
159  $qtext = ilRTE::_replaceMediaObjectImageSrc($qtext, 1);
160  $new_question->setQuestiontext($qtext);
161  $new_question->saveToDb();
162 
163  $this->svy_log->debug("new question text: " . $qtext);
164 
165  // also fix existing original in pool
166  if ($new_question->getOriginalId()) {
167  $pool_question = SurveyQuestion::_instanciateQuestion($new_question->getOriginalId());
168  $pool_question->setQuestiontext($qtext);
169  $pool_question->saveToDb();
170  }
171  }
172  } else {
173  $this->svy_log->error("Error: Could not open XHTML mob file for test introduction during test import. File $importfile does not exist!");
174  }
175  }
176  $newObj->setIntroduction(ilRTE::_replaceMediaObjectImageSrc($newObj->getIntroduction(), 1));
177  $newObj->setOutro(ilRTE::_replaceMediaObjectImageSrc($newObj->getOutro(), 1));
178  $newObj->saveToDb();
179  }
180  $a_mapping->addMapping("Modules/Survey", "svy", (int) $a_id, (int) $newObj->getId());
181  return $newObj->getId();
182  } else {
183  include_once("./Services/DataSet/classes/class.ilDataSetImportParser.php");
184  $parser = new ilDataSetImportParser(
185  $a_entity,
186  $this->getSchemaVersion(),
187  $a_xml,
188  $this->ds,
189  $a_mapping
190  );
191  }
192 
193  return true;
194  }
ilXmlImporter\getSchemaVersion
getSchemaVersion()
Get schema version.
Definition: class.ilXmlImporter.php:107
$_SESSION
$_SESSION["AccountId"]
Definition: cfg.phpunit.template.php:10
SurveyImportParser
Survey Question Import Parser.
Definition: class.SurveyImportParser.php:35
ilObjMediaObject\_saveTempFileAsMediaObject
static _saveTempFileAsMediaObject($name, $tmp_name, $upload=true)
Create new media object and update page in db and return new media object.
Definition: class.ilObjMediaObject.php:1638
ilDataSetImportParser
Manifest parser for ILIAS standard export files.
Definition: class.ilDataSetImportParser.php:13
ilRTE\_replaceMediaObjectImageSrc
static _replaceMediaObjectImageSrc($a_text, $a_direction=0, $nic=IL_INST_ID)
Replaces image source from mob image urls with the mob id or replaces mob id with the correct image s...
Definition: class.ilRTE.php:228
ilSurveyImporter\setSurvey
setSurvey(ilObjSurvey $a_val)
Set current survey object (being imported).
Definition: class.ilSurveyImporter.php:66
ilXmlImporter\getImport
getImport()
Get import.
Definition: class.ilXmlImporter.php:41
ilSurveyImporter\parseXmlFileNames
parseXmlFileNames()
Create qti and xml file name.
Definition: class.ilSurveyImporter.php:201
SurveyQuestion\_instanciateQuestion
static _instanciateQuestion($question_id)
Creates an instance of a question with a given question id.
Definition: class.SurveyQuestion.php:1727
ilObjectFactory\getInstanceByObjId
static getInstanceByObjId($a_obj_id, $stop_on_error=true)
get an instance of an Ilias object by object id
Definition: class.ilObjectFactory.php:77
$parser
$parser
Definition: BPMN2Parser.php:23
League\Flysystem\getConfig
getConfig()
Get the Config.
Definition: ConfigAwareTrait.php:30
ilObjMediaObject\_saveUsage
static _saveUsage($a_mob_id, $a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
Save usage of mob within another container (e.g.
Definition: class.ilObjMediaObject.php:1111
$GLOBALS
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.
Definition: module.tag.xmp.php:702
+ Here is the call graph for this function:

◆ init()

ilSurveyImporter::init ( )

Init.

Parameters

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

References ilLoggerFactory\getLogger().

49  {
50  include_once("./Modules/Survey/classes/class.ilSurveyDataSet.php");
51  $this->ds = new ilSurveyDataSet();
52  $this->ds->setDSPrefix("ds");
53  $this->ds->setImport($this);
54 
55  $this->svy_log = ilLoggerFactory::getLogger("svy");
56  }
ilSurveyDataSet
Survey Data set class.
Definition: class.ilSurveyDataSet.php:20
ilLoggerFactory\getLogger
static getLogger($a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:74
+ Here is the call graph for this function:

◆ parseXmlFileNames()

ilSurveyImporter::parseXmlFileNames ( )
protected

Create qti and xml file name.

Returns
array

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

References $GLOBALS, $xml, and ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

202  {
203  $GLOBALS['ilLog']->write(__METHOD__ . ': ' . $this->getImportDirectory());
204 
205  $basename = basename($this->getImportDirectory());
206  $xml = $this->getImportDirectory() . '/' . $basename . '.xml';
207 
208  return array($xml);
209  }
ilXmlImporter\getImportDirectory
getImportDirectory()
Get import directory.
Definition: class.ilXmlImporter.php:127
$xml
$xml
Definition: fetch_windows_zones.php:11
$GLOBALS
$GLOBALS['JPEG_Segment_Names']
Global Variable: XMP_tag_captions.
Definition: module.tag.xmp.php:702
+ 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_valsurvey

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

Referenced by importXmlRepresentation().

67  {
68  self::$survey = $a_val;
69  }
+ Here is the caller graph for this function:

Field Documentation

◆ $log

ilSurveyImporter::$log
protected

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

◆ $survey

ilSurveyImporter::$survey
staticprotected

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

◆ $svy_log

ilSurveyImporter::$svy_log
protected

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

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