ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
class.ilQuestionpoolExport.php
Go to the documentation of this file.
1<?php
2/* Copyright (c) 1998-2013 ILIAS open source, Extended GPL, see docs/LICENSE */
3
4include_once "./Modules/Test/classes/inc.AssessmentConstants.php";
5
15class ilQuestionpoolExport
16{
17 var $err; // error object
18 var $db; // database object
19 var $ilias; // ilias object
23 var $qpl_obj; // questionpool object
24 var $questions; // array with question ids to export
25 var $inst_id; // installation id
26 var $mode;
27 var $lng;
28
33 function ilQuestionpoolExport(&$a_qpl_obj, $a_mode = "xml", $array_questions = null)
34 {
35 global $ilErr, $ilDB, $ilias, $lng;
36
37 $this->qpl_obj =& $a_qpl_obj;
38 if (!is_array($array_questions))
39 {
40 $array_questions =& $a_qpl_obj->getAllQuestionIds();
41 }
42
43 $this->err =& $ilErr;
44 $this->ilias =& $ilias;
45 $this->db =& $ilDB;
46 $this->mode = $a_mode;
47 $this->lng =& $lng;
48
49 $settings = $this->ilias->getAllSettings();
50 $this->inst_id = IL_INST_ID;
51 $this->questions = $array_questions;
52 $date = time();
53 $this->qpl_obj->createExportDirectory();
54 switch($this->mode)
55 {
56 case "xml":
57 $this->export_dir = $this->qpl_obj->getExportDirectory('xml');
58 $this->subdir = $date."__".$this->inst_id."__".
59 "qpl"."_".$this->qpl_obj->getId();
60 $this->filename = $this->subdir.".xml";
61 $this->qti_filename = $date."__".$this->inst_id."__".
62 "qti"."_".$this->qpl_obj->getId().".xml";
63 break;
64 case "xls":
65 $this->export_dir = $this->qpl_obj->getExportDirectory('xls');
66 $this->filename = $date."__".$this->inst_id."__".
67 "qpl"."_".$this->qpl_obj->getId() . ".xls";
68 $this->zipfilename = $date."__".$this->inst_id."__".
69 "qpl"."_".$this->qpl_obj->getId() . ".zip";
70 break;
71 default:
72 $this->export_dir = $this->qpl_obj->getExportDirectory('zip');
73 $this->subdir = $date."__".$this->inst_id."__".
74 "qpl"."_".$this->qpl_obj->getId();
75 $this->filename = $this->subdir.".xml";
76 $this->qti_filename = $date."__".$this->inst_id."__".
77 "qti"."_".$this->qpl_obj->getId().".xml";
78 break;
79 }
80 }
81
82 function getInstId()
83 {
84 return $this->inst_id;
85 }
86
87
94 function buildExportFile()
95 {
96 switch ($this->mode)
97 {
98 case "xls":
99 return $this->buildExportFileXLS();
100 break;
101 case "xml":
102 default:
103 return $this->buildExportFileXML();
104 break;
105 }
106 }
107
111 function buildExportFileXML()
112 {
113 global $ilBench;
114
115 $ilBench->start("QuestionpoolExport", "buildExportFile");
116
117 include_once("./Services/Xml/classes/class.ilXmlWriter.php");
118 $this->xml = new ilXmlWriter;
119
120 // set dtd definition
121 $this->xml->xmlSetDtdDef("<!DOCTYPE Test SYSTEM \"http://www.ilias.uni-koeln.de/download/dtd/ilias_co.dtd\">");
122
123 // set generated comment
124 $this->xml->xmlSetGenCmt("Export of ILIAS Test Questionpool ".
125 $this->qpl_obj->getId()." of installation ".$this->inst.".");
126
127 // set xml header
128 $this->xml->xmlHeader();
129
130 // create directories
131 include_once "./Services/Utilities/classes/class.ilUtil.php";
132 ilUtil::makeDir($this->export_dir."/".$this->subdir);
133 ilUtil::makeDir($this->export_dir."/".$this->subdir."/objects");
134
135 // get Log File
136 $expDir = $this->qpl_obj->getExportDirectory();
137 ilUtil::makeDirParents($expDir);
138
139 include_once "./Services/Logging/classes/class.ilLog.php";
140 $expLog = new ilLog($expDir, "export.log");
141 $expLog->delete();
142 $expLog->setLogFormat("");
143 $expLog->write(date("[y-m-d H:i:s] ")."Start Export");
144
145 // write qti file
146 $qti_file = fopen($this->export_dir."/".$this->subdir."/".$this->qti_filename, "w");
147 fwrite($qti_file, $this->qpl_obj->toXML($this->questions));
148 fclose($qti_file);
149
150 // get xml content
151 $ilBench->start("QuestionpoolExport", "buildExportFile_getXML");
152 $this->qpl_obj->exportPagesXML($this->xml, $this->inst_id,
153 $this->export_dir."/".$this->subdir, $expLog, $this->questions);
154 $ilBench->stop("QuestionpoolExport", "buildExportFile_getXML");
155
156 // dump xml document to screen (only for debugging reasons)
157 /*
158 echo "<PRE>";
159 echo htmlentities($this->xml->xmlDumpMem($format));
160 echo "</PRE>";
161 */
162
163 // dump xml document to file
164 $ilBench->start("QuestionpoolExport", "buildExportFile_dumpToFile");
165 $this->xml->xmlDumpFile($this->export_dir."/".$this->subdir."/".$this->filename
166 , false);
167 $ilBench->stop("QuestionpoolExport", "buildExportFile_dumpToFile");
168
169 // add media objects which were added with tiny mce
170 $ilBench->start("QuestionpoolExport", "buildExportFile_saveAdditionalMobs");
171 $this->exportXHTMLMediaObjects($this->export_dir."/".$this->subdir);
172 $ilBench->stop("QuestionpoolExport", "buildExportFile_saveAdditionalMobs");
173
174 // zip the file
175 $ilBench->start("QuestionpoolExport", "buildExportFile_zipFile");
176 ilUtil::zip($this->export_dir."/".$this->subdir, $this->export_dir."/".$this->subdir.".zip");
177 if (@is_dir($this->export_dir."/".$this->subdir))
178 {
179 // Do not delete this dir, since it is required for container exports
180 #ilUtil::delDir($this->export_dir."/".$this->subdir);
181 }
182
183 $ilBench->stop("QuestionpoolExport", "buildExportFile_zipFile");
184
185 // destroy writer object
186 $this->xml->_XmlWriter;
187
188 $expLog->write(date("[y-m-d H:i:s] ")."Finished Export");
189 $ilBench->stop("QuestionpoolExport", "buildExportFile");
190
191 return $this->export_dir."/".$this->subdir.".zip";
192 }
193
194 function exportXHTMLMediaObjects($a_export_dir)
195 {
196 include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
197
198 foreach ($this->questions as $question_id)
199 {
200 $mobs = ilObjMediaObject::_getMobsOfObject("qpl:html", $question_id);
201 foreach ($mobs as $mob)
202 {
203 if (ilObjMediaObject::_exists($mob))
204 {
205 $mob_obj =& new ilObjMediaObject($mob);
206 $mob_obj->exportFiles($a_export_dir);
207 unset($mob_obj);
208 }
209 }
210 }
211 }
212
216 function buildExportFileXLS()
217 {
218 global $ilBench;
219
220 $ilBench->start("QuestionpoolExport", "buildExportFile");
221 include_once "./Services/Excel/classes/class.ilExcelWriterAdapter.php";
222 $adapter = new ilExcelWriterAdapter($this->export_dir . "/" . $this->filename, FALSE);
223 $workbook = $adapter->getWorkbook();
224 $workbook->setVersion(8); // Use Excel97/2000 Format
225 $format_bold =& $workbook->addFormat();
226 $format_bold->setBold();
227 $format_percent =& $workbook->addFormat();
228 $format_percent->setNumFormat("0.00%");
229 $format_datetime =& $workbook->addFormat();
230 $format_datetime->setNumFormat("DD/MM/YYYY hh:mm:ss");
231 $format_title =& $workbook->addFormat();
232 $format_title->setBold();
233 $format_title->setColor('black');
234 $format_title->setPattern(1);
235 $format_title->setFgColor('silver');
236 $worksheet =& $workbook->addWorksheet();
237 $row = 0;
238 $col = 0;
239 // title row
240 include_once "./Services/Excel/classes/class.ilExcelUtils.php";
241 include_once "./Modules/TestQuestionPool/classes/class.assQuestion.php";
242 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("title"), "latin1"), $format_title);
243 $col++;
244 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("description"), "latin1"), $format_title);
245 $col++;
246 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("question_type"), "latin1"), $format_title);
247 $col++;
248 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("author"), "latin1"), $format_title);
249 $col++;
250 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("create_date"), "latin1"), $format_title);
251 $col++;
252 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt("last_update"), "latin1"), $format_title);
253 $col = 0;
254 $row++;
255 $questions = $this->qpl_obj->getQuestionList();
256 foreach ($questions as $question)
257 {
258 $worksheet->write($row, $col, ilExcelUtils::_convert_text($question["title"], "latin1"));
259 $col++;
260 $worksheet->write($row, $col, ilExcelUtils::_convert_text($question["description"], "latin1"));
261 $col++;
262 $worksheet->write($row, $col, ilExcelUtils::_convert_text($this->lng->txt($question["type_tag"]), "latin1"));
263 $col++;
264 $worksheet->write($row, $col, ilExcelUtils::_convert_text($question["author"], "latin1"));
265 $col++;
266
267// ilDatePresentation::formatDate(new ilDateTime($question["created"],IL_CAL_UNIX))
268 $worksheet->write($row, $col, ilExcelUtils::_convert_text(ilFormat::formatDate(date('Y-m-d', $question["created"]), "date", false, false), "latin1"));
269 $col++;
270 $worksheet->write($row, $col, ilExcelUtils::_convert_text(ilFormat::formatDate(date('Y-m-d', $question["tstamp"]), "date", false, false), "latin1"));
271 $col = 0;
272 $row++;
273 }
274 $workbook->close();
275 ilUtil::zip($this->export_dir . "/" . $this->filename, $this->export_dir . "/" . $this->zipfilename);
276 if (@file_exists($this->export_dir . "/" . $this->filename)) @unlink($this->export_dir . "/" . $this->filename);
277 }
278}
279
280?>
ilExcelUtils\_convert_text
_convert_text($a_text, $a_target="has been removed")
Definition: class.ilExcelUtils.php:14
ilExcelWriterAdapter
Class ilExcelWriterAdapter.
Definition: class.ilExcelWriterAdapter.php:17
ilFormat\formatDate
formatDate($a_date, $a_mode="datetime", $a_omit_seconds=false, $a_relative=TRUE)
format a date according to the user language shortcut for Format::fmtDateTime @access public
Definition: class.ilFormat.php:440
ilLog
logging
Definition: class.ilLog.php:19
ilObjMediaObject
Class ilObjMediaObject.
Definition: class.ilObjMediaObject.php:27
ilObjMediaObject\_getMobsOfObject
_getMobsOfObject($a_type, $a_id, $a_usage_hist_nr=0, $a_lang="-")
get mobs of object
Definition: class.ilObjMediaObject.php:1054
ilObjMediaObject\_exists
static _exists($a_id)
checks wether a lm content object with specified id exists or not
Definition: class.ilObjMediaObject.php:84
ilQuestionpoolExport
Export class for questionpools.
Definition: class.ilQuestionpoolExport.php:16
ilQuestionpoolExport\ilQuestionpoolExport
ilQuestionpoolExport(&$a_qpl_obj, $a_mode="xml", $array_questions=null)
Constructor @access public.
Definition: class.ilQuestionpoolExport.php:33
ilQuestionpoolExport\buildExportFileXLS
buildExportFileXLS()
build xml export file
Definition: class.ilQuestionpoolExport.php:216
ilQuestionpoolExport\buildExportFileXML
buildExportFileXML()
build xml export file
Definition: class.ilQuestionpoolExport.php:111
ilQuestionpoolExport\buildExportFile
buildExportFile()
build export file (complete zip file)
Definition: class.ilQuestionpoolExport.php:94
ilUtil\zip
static zip($a_dir, $a_file, $compress_content=false)
Definition: class.ilUtil.php:1876
ilUtil\makeDirParents
static makeDirParents($a_dir)
Create a new directory and all parent directories.
Definition: class.ilUtil.php:2482
ilUtil\makeDir
static makeDir($a_dir)
creates a new directory and inherits all filesystem permissions of the parent directory You may pass ...
Definition: class.ilUtil.php:2446
ilXmlWriter
XML writer class.
Definition: class.ilXmlWriter.php:18
ilXmlWriter\xmlSetDtdDef
xmlSetDtdDef($dtdDef)
Sets dtd definition.
Definition: class.ilXmlWriter.php:101
$ilBench
global $ilBench
Definition: ilias.php:18
$ilErr
$ilErr
Definition: inc.setup_header.php:67
ilias
redirection script todo: (a better solution should control the processing via a xml file)
$ilDB
global $ilDB
Definition: storeScorm2004.php:19
$mobs
$mobs
Definition: imagemanager.php:67