Exporter class for html learning modules. More...

Inheritance diagram for ilLearningModuleExporter:

Collaboration diagram for ilLearningModuleExporter:

Public Member Functions
	init ()
	Initialisation. More...

	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...

	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...

Public Member Functions inherited from ilXmlExporter
	__construct ()
	Constructor. More...

	setExport (ilExport $a_exp)
	Set export object. More...

	getExport ()
	Get export. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_id)
	Get xml representation. More...

	init ()

	setExportDirectories ($a_dir_relative, $a_dir_absolute)
	Export directories. More...

	getRelativeExportDirectory ()
	Get relative export directory. More...

	getAbsoluteExportDirectory ()
	Get absolute export directory. More...

	getXmlExportHeadDependencies ($a_entity, $a_target_release, $a_ids)
	Get head dependencies. More...

	getXmlExportTailDependencies ($a_entity, $a_target_release, $a_ids)
	Get tail dependencies. More...

	getValidSchemaVersions ($a_entity)
	Returns schema versions that the component can export to. More...

	determineSchemaVersion ($a_entity, $a_target_release)
	Determine schema version. More...

Private Attributes
	$ds

	$config

Additional Inherited Members
Static Public Member Functions inherited from ilXmlExporter
static	lookupExportDirectory ($a_obj_type, $a_obj_id, $a_export_type='xml', $a_entity="")
	export directory lookup More...

Protected Attributes inherited from ilXmlExporter
	$dir_relative

	$dir_absolute

	$exp

Detailed Description

Exporter class for html learning modules.

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

Version

Id

Definition at line 12 of file class.ilLearningModuleExporter.php.

Member Function Documentation

◆ getValidSchemaVersions()

ilLearningModuleExporter::getValidSchemaVersions ( $a_entity )

Returns schema versions that the component can export to.

ILIAS chooses the first one, that has min/max constraints which fit to the target release. Please put the newest on top.

Returns

Definition at line 173 of file class.ilLearningModuleExporter.php.

     {
         return array(
             "5.4.0" => array(
                 "namespace" => "http://www.ilias.de/Modules/LearningModule/lm/5_4",
                 "xsd_file" => "ilias_lm_5_4.xsd",
                 "uses_dataset" => true,
                 "min" => "5.4.0",
                 "max" => ""),
             "5.1.0" => array(
                 "namespace" => "http://www.ilias.de/Modules/LearningModule/lm/5_1",
                 "xsd_file" => "ilias_lm_5_1.xsd",
                 "uses_dataset" => true,
                 "min" => "5.1.0",
                 "max" => ""),
             "4.1.0" => array(
                 "namespace" => "http://www.ilias.de/Modules/LearningModule/lm/4_1",
                 "xsd_file" => "ilias_lm_4_1.xsd",
                 "uses_dataset" => false,
                 "min" => "4.1.0",
                 "max" => "")
         );
     }

◆ getXmlExportTailDependencies()

ilLearningModuleExporter::getXmlExportTailDependencies	(	$a_entity,
		$a_target_release,
		$a_ids
	)

Get tail dependencies.

Parameters

string	entity
string	target release
array	ids

Returns: array array of array with keys "component", entity", "ids"

Definition at line 44 of file class.ilLearningModuleExporter.php.

References Vendor\Package\$c, ilObjContentObject\_lookupStyleSheetId(), ilLMObject\getObjectList(), ilLMPageObject\getPageList(), and ilObjContentObject\isOnlineHelpModule().

     {
         $deps = array();
 
         if ($a_entity == "lm") {
             $md_ids = array();
 
             // lm related ids
             foreach ($a_ids as $id) {
                 $md_ids[] = $id . ":0:lm";
             }
 
             // chapter related ids
             foreach ($a_ids as $id) {
                 $chaps = ilLMObject::getObjectList($id, "st");
                 foreach ($chaps as $c) {
                     $md_ids[] = $id . ":" . $c["obj_id"] . ":st";
                 }
             }
 
             // page related ids
             $pg_ids = array();
             foreach ($a_ids as $id) {
                 $pages = ilLMPageObject::getPageList($id);
                 foreach ($pages as $p) {
                     $pg_ids[] = "lm:" . $p["obj_id"];
                     $md_ids[] = $id . ":" . $p["obj_id"] . ":pg";
                 }
             }
 
             // style, multilang, metadata per page/chap?
 
             $deps = array(
                 array(
                     "component" => "Services/COPage",
                     "entity" => "pg",
                     "ids" => $pg_ids),
                 array(
                     "component" => "Services/MetaData",
                     "entity" => "md",
                     "ids" => $md_ids),
             );
 
             if (!$this->config->getMasterLanguageOnly()) {
                 $deps[] = array(
                     "component" => "Services/Object",
                     "entity" => "transl",
                     "ids" => $md_ids);
             }
             $deps[] = array(
                 "component" => "Services/Object",
                 "entity" => "tile",
                 "ids" => $a_ids);
 
             // help export
             foreach ($a_ids as $id) {
                 if (ilObjContentObject::isOnlineHelpModule($id, true)) {
                     $deps[] = array(
                         "component" => "Services/Help",
                         "entity" => "help",
                         "ids" => array($id));
                 }
             }
 
             // style
             foreach ($a_ids as $id) {
                 if (($s = ilObjContentObject::_lookupStyleSheetId($id)) > 0) {
                     $deps[] = array(
                         "component" => "Services/Style",
                         "entity" => "sty",
                         "ids" => $s
                     );
                 }
             }
         }
 
         return $deps;
     }

Here is the call graph for this function:

◆ getXmlRepresentation()

ilLearningModuleExporter::getXmlRepresentation	(	$a_entity,
		$a_schema_version,
		$a_id
	)

Get xml representation.

Parameters

string	entity
string	target release
string	id

Returns: string xml string

Definition at line 133 of file class.ilLearningModuleExporter.php.

References ilPCQuestion\_getQuestionIdsForPage(), ilXmlExporter\getExport(), ilLMPageObject\getPageList(), and ilPageObject\lookupTranslations().

     {
         // workaround: old question export
         $q_ids = array();
         $pages = ilLMPageObject::getPageList($a_id);
         foreach ($pages as $p) {
             $langs = array("-");
             if (!$this->config->getMasterLanguageOnly()) {
                 $trans = ilPageObject::lookupTranslations("lm", $p["obj_id"]);
                 foreach ($trans as $t) {
                     if ($t != "-") {
                         $langs[] = $t;
                     }
                 }
             }
             foreach ($langs as $l) {
                 // collect questions
                 foreach (ilPCQuestion::_getQuestionIdsForPage("lm", $p["obj_id"], $l) as $q_id) {
                     $q_ids[$q_id] = $q_id;
                 }
             }
         }
         if (count($q_ids) > 0) {
             $dir = $this->getExport()->export_run_dir;
             $qti_file = fopen($dir . "/qti.xml", "w");
             $pool = new ilObjQuestionPool();
             fwrite($qti_file, $pool->questionsToXML($q_ids));
             fclose($qti_file);
         }
 
         return $this->ds->getXmlRepresentation($a_entity, $a_schema_version, $a_id, "", true, true);
     }

Here is the call graph for this function:

◆ init()

ilLearningModuleExporter::init ( )

Initialisation.

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

References ilXmlExporter\getExport().

     {
         $this->ds = new ilLearningModuleDataSet();
         $this->ds->setExportDirectories($this->dir_relative, $this->dir_absolute);
         $this->ds->setDSPrefix("ds");
         $this->config = $this->getExport()->getConfig("Modules/LearningModule");
         if ($this->config->getMasterLanguageOnly()) {
             $conf = $this->getExport()->getConfig("Services/COPage");
             $conf->setMasterLanguageOnly(true, $this->config->getIncludeMedia());
             $this->ds->setMasterLanguageOnly(true);
         }
     }