Inheritance diagram for ilScormAiccDataSet:

Collaboration diagram for ilScormAiccDataSet:

Public Member Functions
	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)

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

Data Fields
	$data = []

	$properties

	db_type

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

	stripTags (array $rec, array $omit_keys=[])

Private Member Functions
	buildManifest ()

	buildProperties ($a_entity, $a_omit_header=false)

Private Attributes
	$dic

	$db_table = "sahs_lm"

	$_archive = []

	$element_db_mapping = []

Additional Inherited Members
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""

	$db

	$ds_log

	$ds_namespace = 'ds'

Detailed Description

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

Member Function Documentation

◆ buildManifest()

ilScormAiccDataSet::buildManifest ( )

private

Returns: string

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

Referenced by getElementNameByDbColumn().

                                      : string
     {
         $manWriter = new ilXmlWriter();
         $manWriter->xmlHeader();
         foreach ($this->_archive['files'] as $key => $value) {
             $manWriter->xmlElement($key, null, $value, true, true);
         }
 
         return $manWriter->xmlDumpMem(true);
     }

Here is the caller graph for this function:

◆ buildMetaData()

ilScormAiccDataSet::buildMetaData ( $id )

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

References $xml.

Referenced by getElementNameByDbColumn().

     {
         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:

◆ buildProperties()

ilScormAiccDataSet::buildProperties	(	$a_entity,
		$a_omit_header = `false`
	)

private

Parameters

	$a_entity
bool	$a_omit_header

Returns: string

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

References getElementNameByDbColumn(), and IL_INST_ID.

Referenced by getElementNameByDbColumn().

     {
         $writer = new ilXmlWriter();
 
         if (!$a_omit_header) {
             $writer->xmlHeader();
         }
 
         $writer->appendXML("\n");
         $writer->xmlStartTag('DataSet', array(
             "InstallationId" => IL_INST_ID,
             "InstallationUrl" => ILIAS_HTTP_PATH,
             "TopEntity" => $a_entity
         ));
 
         $writer->appendXML("\n");
 
         foreach ($this->data as $key => $value) {
             $writer->xmlElement($this->getElementNameByDbColumn($key), null, $value, true, true);
             $writer->appendXML("\n");
         }
 
         $writer->xmlEndTag("DataSet");
 
         return $writer->xmlDumpMem(false);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDependencies()

ilScormAiccDataSet::getDependencies ( )

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

     {
         return null;
     }

◆ getElementNameByDbColumn()

ilScormAiccDataSet::getElementNameByDbColumn ( $db_col_name )

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

References $DIC, $GLOBALS, ilExport\_getExportDirectory(), buildManifest(), buildMetaData(), buildProperties(), exit, getTypes(), ilUtil\getWebspaceDir(), IL_INST_ID, readData(), and ilUtil\zip().

Referenced by buildProperties().

     {
         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 call graph for this function:

Here is the caller graph for this function:

◆ getSupportedVersions()

ilScormAiccDataSet::getSupportedVersions ( )

Definition at line 355 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 325 of file class.ilScormAiccDataSet.php.

Referenced by getElementNameByDbColumn().

     {
         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 345 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 98 of file class.ilScormAiccDataSet.php.

References $columns, $db_table, $DIC, $ilDB, $query, and $result.

Referenced by getElementNameByDbColumn().

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
 
         $obj_id = $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 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 132 of file class.ilScormAiccDataSet.php.

References $columns, $data, $DIC, and $ilDB.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $ilLog = $DIC['ilLog'];
         if (count($data) > 0) {
             $columns = [];
             foreach ($this->properties as $key => $value) {
                 if ($key == "Id" || $key == "title" || $key == "description") {
                     continue;
                 }
                 //fix localization and mastery_score
                 if ($key == "MasteryScore" && $data[$key][0] == 0) {
                     continue;
                 }
                 if ($key == "Localization" && $data[$key][0] == "") {
                     continue;
                 }
                 //end fix
                 if (isset($data[$key])) {
                     $columns [$value["db_col"]] = [$value["db_type"], $data[$key]];
                 }
             }
             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])) {
                     $od_columns [$value["db_col"]] = [$value["db_type"], $data[$key]];
                 }
 
                 if (isset($od_columns) && 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");
         }
     }

Field Documentation

◆ $_archive

ilScormAiccDataSet::$_archive = []

private

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

◆ $data

ilScormAiccDataSet::$data = []

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

Referenced by writeData().

◆ $db_table

ilScormAiccDataSet::$db_table = "sahs_lm"

private

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

Referenced by readData().

◆ $dic

ilScormAiccDataSet::$dic

private

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

◆ $element_db_mapping

ilScormAiccDataSet::$element_db_mapping = []

private

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

◆ $properties

ilScormAiccDataSet::$properties

Initial value:

= [
        
        "Id" => ["db_col" => "id"

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

◆ db_type

ilScormAiccDataSet::db_type

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

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

Modules/ScormAicc/classes/class.ilScormAiccDataSet.php

Public Member Functions

Data Fields

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ buildManifest()

◆ buildMetaData()

◆ buildProperties()

◆ getDependencies()

◆ getElementNameByDbColumn()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ readData()

◆ writeData()

Field Documentation

◆ $_archive

◆ $data

◆ $db_table

◆ $dic

◆ $element_db_mapping

◆ $properties

◆ db_type