Inheritance diagram for ilScormAiccDataSet:

Collaboration diagram for ilScormAiccDataSet:

Public Member Functions
	__construct ()

	readData ($a_entity, $a_version, $a_id, $a_field="")
	Read data. More...

	writeData ($a_entity, $a_version, $a_id, $data)
	Write properties for imported object (actually updates !!) More...

	getElementNameByDbColumn ($db_col_name)

	getExtendedXmlRepresentation ($a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)

	buildMetaData ($id)

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	getDependencies ()

	getSupportedVersions ()

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

	init ($a_entity, $a_schema_version)
	Init. More...

	getSupportedVersions ()
	Get supported version. More...

	readData ($a_entity, $a_version, $a_ids)
	Read data from DB. More...

	setExportDirectories ($a_relative, $a_absolute)
	Set export directories. More...

	setImportDirectory ($a_val)
	Set import directory. More...

	getImportDirectory ()
	Get import directory. More...

	setDSPrefix ($a_val)
	Set XML dataset namespace prefix. More...

	getDSPrefix ()
	Get XML dataset namespace prefix. More...

	getDSPrefixString ()

	getDirectDataFromQuery ($a_query, $a_convert_to_leading_upper=true, $a_set=true)
	Get data from query.This is a standard procedure, all db field names are directly mapped to abstract fields. More...

	convertToLeadingUpper ($a_str)
	Make xyz_abc a XyzAbc string. More...

	getJsonRepresentation ()
	Get json representation. More...

	getXmlRepresentation ($a_entity, $a_schema_version, $a_ids, $a_field="", $a_omit_header=false, $a_omit_types=false)
	Get xml representation <dataset install_id="123" install_url="..."> <types entity="table_name" version="4.0.1"> <ftype name="field_1" type="text"> <ftype name="field_2" type="date"> <ftype name="field_3" type="integer"> </types> <types ...> ... More...

	addRecordsXml ($a_writer, $a_prefixes, $a_entity, $a_schema_version, $a_ids, $a_field="")
	Add records xml. More...

	afterXmlRecordWriting ($a_entity, $a_version, $a_set)
	After xml record writing hook record. More...

	getNamespaces (&$namespaces, $a_entity, $a_schema_version)
	Get xml namespaces. More...

	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record for version. More...

	getJsonRecord ($a_set)
	Get json record for version. More...

	getXmlTypes ($a_entity, $a_version)
	Get xml types. More...

	getJsonTypes ($a_entity, $a_version)
	Get json types. More...

	getXMLEntityName ($a_entity, $a_version)
	Get entity name for xml (may be overwritten) More...

	getXMLEntityTag ($a_entity, $a_schema_version)
	Get entity tag. More...

	getJsonEntityName ($a_entity, $a_version)
	Get entity name for json (may be overwritten) More...

	setImport ($a_val)
	Set import object. More...

	getImport ()
	Get import object. More...

	setCurrentInstallationId ($a_val)
	Set current installation id. More...

	getCurrentInstallationId ()
	Get current installation id. More...

Protected Member Functions
	getTypes ($a_entity, $a_version)
	Get field types for entity. More...

Protected Member Functions inherited from ilDataSet
	getTypes ($a_entity, $a_version)
	Get (abstract) types for (abstract) field names. More...

	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...

	createObjectExportId ($a_type, $a_id)
	Build ilias export id. More...

	parseObjectExportId ($a_id, $a_fallback_id=NULL)
	Parse export id. More...

Additional Inherited Members
Data Fields inherited from ilDataSet
	$dircnt

const	EXPORT_NO_INST_ID = 1

const	EXPORT_ID_ILIAS_LOCAL = 2

const	EXPORT_ID_ILIAS_LOCAL_INVALID = 3

const	EXPORT_ID_ILIAS_REMOTE = 4

const	EXPORT_ID_ILIAS_REMOTE_INVALID = 5

const	EXPORT_ID = 6

const	EXPORT_ID_INVALID = 7

Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

Detailed Description

Definition at line 5 of file class.ilScormAiccDataSet.php.

Constructor & Destructor Documentation

◆ __construct()

ilScormAiccDataSet::__construct ( )

Definition at line 7 of file class.ilScormAiccDataSet.php.

References properties.

         {
                 $this->db_table = "sahs_lm";
                 $this->properties = [
                         //"OfflineZipCreated" => "datetime",
                         "Id" => ["db_col" => "id", "db_type" => "integer"],
                         //"EntryPage" => "integer",
                         "APIAdapterName" => ["db_col" => "api_adapter", "db_type" => "text"],
                         "APIFunctionsPrefix" => ["db_col" => "api_func_prefix", "db_type" => "text"],
                         "AssignedGlossary" => ["db_col" => "glossary", "db_type" => "integer"],
                         "AutoContinue" => ["db_col" => "auto_continue", "db_type" => "text"],
                         "AutoReviewChar" => ["db_col" => "auto_review", "db_type" => "text"],
                         "AutoSuspend" => ["db_col" => "auto_suspend", "db_type" => "text"],
                         "Auto_last_visited" => ["db_col" => "auto_last_visited", "db_type" => "text"],
                         "Check_values" => ["db_col" => "check_values", "db_type" => "text"],
                         "Comments" => ["db_col" => "comments", "db_type" => "text"],
                         "CreditMode" => ["db_col" => "credit", "db_type" => "text"],
                         "Debug" => ["db_col" => "debug", "db_type" => "text"],
                         "DebugPw" => ["db_col" => "debugpw", "db_type" => "text"],
                         "DefaultLessonMode" => ["db_col" => "default_lesson_mode", "db_type" => "text"],
                         "Editable" => ["db_col" => "editable", "db_type" => "integer"],
                         "Fourth_edition" => ["db_col" => "fourth_edition", "db_type" => "text"],
                         "Height" => ["db_col" => "height", "db_type" => "integer"],
                         "HideNavig" => ["db_col" => "hide_navig", "db_type" => "text"],
                         "Ie_compatibility" => ["db_col" => "ie_compatibility", "db_type" => "text"],
                         "Ie_force_render" => ["db_col" => "ie_force_render", "db_type" => "text"],
                         "Interactions" => ["db_col" => "interactions", "db_type" => "text"],
                         "Localization" => ["db_col" => "localization", "db_type" => "text"],
                         "MasteryScore" => ["db_col" => "mastery_score", "db_type" => "integer"],
                         "MaxAttempt" => ["db_col" => "max_attempt", "db_type" => "integer"],
                         "ModuleVersion" => ["db_col" => "module_version", "db_type" => "integer"],
                         "NoMenu" => ["db_col" => "no_menu", "db_type" => "text"],
                         "Objectives" => ["db_col" => "objectives", "db_type" => "text"],
                         "OfflineMode" => ["db_col" => "offline_mode", "db_type" => "text"],
                         "Online" => ["db_col" => "c_online", "db_type" => "text"],
                         "OpenMode" => ["db_col" => "open_mode", "db_type" => "integer"],
                         "Sequencing" => ["db_col" => "sequencing", "db_type" => "text"],
                         "SequencingExpertMode" => ["db_col" => "seq_exp_mode", "db_type" => "integer"],
                         "Session" => ["db_col" => "unlimited_session", "db_type" => "text"],
                         "StyleSheetId" => ["db_col" => "stylesheet", "db_type" => "integer"],
                         "SubType" => ["db_col" => "c_type", "db_type" => "text"],
                         "Time_from_lms" => ["db_col" => "time_from_lms", "db_type" => "text"],
                         "Tries" => ["db_col" => "question_tries", "db_type" => "integer"],
                         "Width" => ["db_col" => "width", "db_type" => "integer"]
                 ];
 
                 $this->element_db_mapping = [];
                 foreach ($this->properties as $key => $value)
                 {
                         $this->element_db_mapping [$value["db_col"]] = $key;
                 }
         }

Member Function Documentation

◆ buildMetaData()

ilScormAiccDataSet::buildMetaData ( $id )

Definition at line 269 of file class.ilScormAiccDataSet.php.

Referenced by getExtendedXmlRepresentation().

         {
                 require_once ("Services/MetaData/classes/class.ilMD2XML.php");
                 $md2xml = new ilMD2XML ($id, $id, "sahs");
                 $md2xml->startExport();
                 $xml = $md2xml->getXML();
                 return $xml;
         }

Here is the caller graph for this function:

◆ getDependencies()

ilScormAiccDataSet::getDependencies ( )

Definition at line 311 of file class.ilScormAiccDataSet.php.

         {
                 return null;
         }

◆ getElementNameByDbColumn()

ilScormAiccDataSet::getElementNameByDbColumn ( $db_col_name )

Definition at line 145 of file class.ilScormAiccDataSet.php.

Referenced by getExtendedXmlRepresentation().

         {
                 if ($db_col_name == "title") return "Title";
                 if ($db_col_name == "description") return "Description";
                 return $this->element_db_mapping[$db_col_name];
         }

Here is the caller graph for this function:

◆ getExtendedXmlRepresentation()

ilScormAiccDataSet::getExtendedXmlRepresentation	(	$a_entity,
		$a_schema_version,
		$a_ids,
		$a_field = `""`,
		$a_omit_header = `false`,
		$a_omit_types = `false`
	)

Definition at line 155 of file class.ilScormAiccDataSet.php.

References $files, $GLOBALS, $ilCtrl, $ilDB, ilExport\_getExportDirectory(), array, buildMetaData(), data, exit, ilDataSet\getDSPrefixString(), getElementNameByDbColumn(), getTypes(), ilUtil\getWebspaceDir(), readData(), time, and ilUtil\zip().

         {
                 $GLOBALS["ilLog"]->write(json_encode($this->getTypes("sahs", "5.1.0"), JSON_PRETTY_PRINT));
 
                 global $ilCtrl, $ilDB;
                 $this->dircnt = 1;
 
                 $this->readData($a_entity, $a_schema_version, $a_ids, $a_field = "");
                 $id = $this->data["id"];
 
                 require_once ("./Services/Export/classes/class.ilExport.php");
                 $exportDir = ilExport::_getExportDirectory($id);
 
                 // step 1: check target release and supported versions
                 // step 2: init writer
                 require_once ("./Services/Xml/classes/class.ilXmlWriter.php");
                 $writer = new ilXmlWriter();
                 if (!$a_omit_header) { $writer->xmlHeader(); }
 
                 $atts = array("InstallationId" => IL_INST_ID,
                         "InstallationUrl" => ILIAS_HTTP_PATH, "TopEntity" => $a_entity);
 
                 $writer->appendXML ("\n");
                 $writer->xmlStartTag($this->getDSPrefixString().'DataSet', $atts);
                 $writer->appendXML ("\n");
 
                 foreach ($this->data as $key => $value)
                 {
                         $writer->xmlElement($this->getElementNameByDbColumn ($key), Null, $value, TRUE, TRUE);
                         $writer->appendXML ("\n");
                 }
 
                 $lmDir = ilUtil::getWebspaceDir ("filesystem")."/lm_data/lm_".$id;
                 $baseFileName = "sahs_" . $id;
                 $scormBasePath=$exportDir . "/" . $baseFileName;
                 if (!file_exists ($exportDir)) mkdir ($exportDir, 0755, true);
 
                 ilUtil::zip($lmDir, $scormBasePath, true);
                 $scormFilePath = $scormBasePath . ".zip";
 
                 $writer->xmlEndTag($this->getDSPrefixString()."DataSet");
                 $writer->appendXML ("\n");
 
                 $xml = $writer->xmlDumpMem(false);
                 $baseExportName = time() . "__" . IL_INST_ID . "__". $baseFileName;
                 $xmlFilePath = $exportDir . "/" . $baseExportName . ".xml";
 
                 if (!file_exists ($xmlFilePath))
                 {
                         $xmlFile = fopen ($xmlFilePath, "w");
                         fwrite ($xmlFile, $xml);
                         fclose($xmlFile);
                 }
 
                 //create metadata
                 $metaData = $this->buildMetaData ($id);
 
                 $metaDataFilePath = $exportDir . "/" . $baseExportName . "_metadata.xml";
                 if (!file_exists ($metaDataFilePath))
                 {
                         $metaDataFile = fopen ($metaDataFilePath, "w");
                         fwrite ($metaDataFile, $metaData);
                         fclose($metaDataFile);
                 }
 
                 //create manifest file
                 $manWriter = new ilXmlWriter();
                 $manWriter->xmlHeader(); 
                 $manWriter->appendXML ("\n<content>\n");
 
                 $files = [
                         "scormFile" => $baseFileName . ".zip",
                         "properties" => $baseFileName . ".xml",
                         "metadata" => "metadata.xml"
                 ];
                 foreach ($files as $key => $value)
                 {
                         $manWriter->xmlElement($key, Null, $value, TRUE, TRUE);
                         $manWriter->appendXML ("\n");
                 }
 
                 $manWriter->appendXML ("</content>\n");
                 $manifest = $manWriter->xmlDumpMem(false);
 
                 $manifestFilePath = $exportDir . "/" . $baseExportName . "_manifest.xml";
                 if (!file_exists ($manifestFilePath))
                 {
                         $manifestFile = fopen ($manifestFilePath, "w");
                         fwrite ($manifestFile, $manifest);
                         fclose($manifestFile);
                 }
 
                 $zArchive = new zipArchive();
                 $fileName = $exportDir . "/" . $baseExportName . ".zip";
 
                 if ($zArchive->open($fileName, ZipArchive::CREATE)!==TRUE) {
                         exit("cannot open <$fileName>\n");
                 }
 
                 //creating final zip file
                 $zArchive->addFile($xmlFilePath, $baseFileName . ".xml");
                 $zArchive->addFile($scormFilePath, $baseFileName . ".zip");
                 $zArchive->addFile($manifestFilePath, "manifest.xml");
                 $zArchive->addFile($metaDataFilePath, "metadata.xml");
                 $zArchive->close();
                 //delete temporary files
                 unlink ($xmlFilePath);
                 unlink ($scormFilePath);
                 unlink ($manifestFilePath);
                 unlink ($metaDataFilePath);
 
                 return $fileName;
         }

Here is the call graph for this function:

◆ getSupportedVersions()

ilScormAiccDataSet::getSupportedVersions ( )

Definition at line 316 of file class.ilScormAiccDataSet.php.

         {
                 return ["5.1.0"];
         }

◆ getTypes()

ilScormAiccDataSet::getTypes	(	$a_entity,
		$a_version
	)

protected

Get field types for entity.

Parameters

string	$a_entity	entity
string	$a_version	version number

Returns: array types array

Definition at line 285 of file class.ilScormAiccDataSet.php.

References properties.

Referenced by getExtendedXmlRepresentation().

         {
                 if ($a_entity == "sahs")
                 {
                         switch ($a_version)
                         {
                         case "5.1.0":
                                 $types = [];
                                 foreach ($this->properties as $key => $value)
                                         $types[$key] = $value["db_type"];
                                 return $types;
                                 break;
                         }
                 }
         }

Here is the caller graph for this function:

◆ getXmlNamespace()

ilScormAiccDataSet::getXmlNamespace	(	$a_entity,
		$a_schema_version
	)

Get xml namespace.

Parameters

Definition at line 306 of file class.ilScormAiccDataSet.php.

         {
                 return "http://www.ilias.de/xml/Modules/ScormAicc/".$a_entity;
         }

◆ readData()

ilScormAiccDataSet::readData	(	$a_entity,
		$a_version,
		$a_id,
		$a_field = `""`
	)

Read data.

Parameters

Definition at line 65 of file class.ilScormAiccDataSet.php.

References $columns, $ilDB, $query, $result, ilObject\_lookupObjectId(), data, and properties.

Referenced by getExtendedXmlRepresentation().

         {
                 global $ilDB;
 
                 $obj_id = ilObject::_lookupObjectId ($a_id);
                 $columns = [];
                 foreach ($this->properties as $property)
                         array_push ($columns, $property["db_col"]);
 
                 $query = "SELECT " . implode (",", $columns) . " FROM " . $this->db_table;
                 $query .= " WHERE id=" . $ilDB->quote($obj_id, "integer");
                 $result = $ilDB->query($query);
                 $this->data = [];
                 if ($dataset = $ilDB->fetchAssoc($result))
                 {
                         $this->data = $dataset;
                 }
 
                 $query = "SELECT title,description FROM object_data";
                 $query .= " WHERE obj_id=" . $ilDB->quote($obj_id, "integer");
                 $result = $ilDB->query($query);
                 while ($dataset = $ilDB->fetchAssoc($result))
                 {
                         $this->data ["title"] = $dataset["title"];
                         $this->data ["description"] = $dataset["description"];
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

ilScormAiccDataSet::writeData	(	$a_entity,
		$a_version,
		$a_id,
		$data
	)

Write properties for imported object (actually updates !!)

Parameters

$data contains imported module properties from xml file

Returns

Definition at line 99 of file class.ilScormAiccDataSet.php.

References $columns, $data, $ilDB, $ilLog, and properties.

         {
                 global $ilDB, $ilLog;
                 if (count ($data) > 0)
                 {
                         $columns = [];
                         foreach ($this->properties as $key => $value)
                         {
                                 if ($key == "Id" || $key == "title"|| $key == "description") continue;
                                 if (isset ($data[$key]))
                                         if (count ($data[$key]) > 0)
                                                 $columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];
                         }
                         if (count ($columns) > 0)
                         {
                                 $conditions ["id"] = ["integer", $a_id];
                                 $ilDB->update ($this->db_table, $columns, $conditions);
                         }
 
                         //setting title and description in table object_data
                         $od_table = "object_data";
                         $od_properties = [
                                 "Title" => ["db_col" => "title", "db_type" => "text"],
                                 "Description" => ["db_col" => "description", "db_type" => "text"]
                         ];
                         foreach ($od_properties as $key => $value)
                         {
                                 if (isset ($data[$key]))
                                         if (count ($data[$key]) > 0)
                                                 $od_columns [$value["db_col"]] = [$value["db_type"], $data[$key][0]];
 
                                 if (count ($od_columns) > 0)
                                 {
                                         $od_conditions ["obj_id"] = ["integer", $a_id];
                                         $ilDB->update ("object_data", $od_columns, $od_conditions);
                                 }
                         }
                 }
                 else
                 {
                         $ilLog->write ("no module properties for imported object");
                 }
         }

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

Modules/ScormAicc/classes/class.ilScormAiccDataSet.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildMetaData()

◆ getDependencies()

◆ getElementNameByDbColumn()

◆ getExtendedXmlRepresentation()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ readData()

◆ writeData()