This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilScormAiccDataSet:

Collaboration diagram for ilScormAiccDataSet:

Public Member Functions
	__construct ()

	writeData (string $a_entity, string $a_version, int $a_id, array $data)

	getExtendedXmlRepresentation (string $a_entity, string $a_schema_version, array $a_ids, string $a_field="", bool $a_omit_header=false, bool $a_omit_types=false)
	own getXmlRepresentation function to embed zipfile in xml More...

	readData (string $a_entity, string $a_version, array $a_ids, string $a_field="")

	getElementNameByDbColumn (string $db_col_name)
	retrieve element name by database column name More...

	buildMetaData (int $id)

	getSupportedVersions ()

Public Member Functions inherited from ilDataSet
	__construct ()

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

	getSupportedVersions ()

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

	setExportDirectories (string $a_relative, string $a_absolute)

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setDSPrefix (string $a_val)

	getDSPrefix ()

	getDSPrefixString ()

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

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

	getXmlRepresentation (string $a_entity, string $a_schema_version, ?array $a_ids, string $a_field="", bool $a_omit_header=false, bool $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 (ilXmlWriter $a_writer, array $a_prefixes, string $a_entity, string $a_schema_version, array $a_ids, ?string $a_field="")

	afterXmlRecordWriting (string $a_entity, string $a_version, array $a_set)

	getNamespaces (array &$namespaces, string $a_entity, string $a_schema_version)

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

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

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

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

	setImport (ilSurveyImporter $a_val)

	getImport ()

	setCurrentInstallationId (string $a_val)

	getCurrentInstallationId ()

	importRecord (string $a_entity, array $a_types, array $a_rec, ilImportMapping $a_mapping, string $a_schema_version)
	Needs to be overwritten for import use case. More...

	getCollection (array $record, string $entity, string $schema_version, string $field, string $value)

Data Fields
array	$properties

Data Fields inherited from ilDataSet
const	DATASET_NS = 'http://www.ilias.de/Services/DataSet/ds/4_3'

const	DATASET_NS_PREFIX = 'ds'

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

int	$dircnt = 0

Protected Member Functions
	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

	getTypes (string $a_entity, string $a_version)
	Get field types for entity. More...

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

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

	getXmlNamespace (string $a_entity, string $a_schema_version)

	getDependencies (string $a_entity, string $a_version, ?array $a_rec=null, ?array $a_ids=null)

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

	parseObjectExportId (string $a_id, ?string $a_fallback_id=null)
	Parse export id. More...

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

Private Member Functions
	buildManifest ()

	buildProperties ($a_entity, bool $a_omit_header=false)

Private Attributes
string	$db_table

array	$_archive

array	$element_db_mapping

Additional Inherited Members
Protected Attributes inherited from ilDataSet
ILIAS ResourceStorage Services	$irss

string	$current_installation_id = ""

array	$data = []

ilDBInterface	$db

ilLogger	$ds_log

string	$import_directory = ""

string	$entity = ""

string	$schema_version = ""

string	$relative_export_dir = ""

string	$absolute_export_dir = ""

string	$ds_prefix = "ds"

string	$version = ""

ilSurveyImporter	$import

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

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

Constructor & Destructor Documentation

◆ __construct()

ilScormAiccDataSet::__construct ( )

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

References ILIAS\LTI\ToolProvider\$key.

     {
         $this->db_table = "sahs_lm";
         $this->_archive = [];
         $this->properties = [
             "Id" => ["db_col" => "id", "db_type" => "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_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"],
             "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"],
             "IdSetting" => ["db_col" => "id_setting", "db_type" => "integer"],
             "NameSetting" => ["db_col" => "name_setting", "db_type" => "integer"]
         ];
 
         $this->element_db_mapping = [];
         foreach ($this->properties as $key => $value) {
             $this->element_db_mapping [$value["db_col"]] = $key;
         }
     }

Member Function Documentation

◆ buildManifest()

ilScormAiccDataSet::buildManifest ( )

private

Returns: string

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by getExtendedXmlRepresentation().

                                     : 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 ( int $id )

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

Referenced by getExtendedXmlRepresentation().

                                           : string
     {
         $md2xml = new ilMD2XML($id, $id, "sahs");
         $md2xml->startExport();
         return $md2xml->getXML();
     }

Here is the caller graph for this function:

◆ buildProperties()

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

private

Parameters

	$a_entity
bool	$a_omit_header

Returns: string

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

References ILIAS\LTI\ToolProvider\$key, getElementNameByDbColumn(), and IL_INST_ID.

Referenced by getExtendedXmlRepresentation().

                                                                             : string
     {
         $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	(	string	$a_entity,
		string	$a_version,
		?array	$a_rec = `null`,
		?array	$a_ids = `null`
	)

protected

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

      : array {
         return [];
     }

◆ getElementNameByDbColumn()

ilScormAiccDataSet::getElementNameByDbColumn ( string $db_col_name )

retrieve element name by database column name

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

Referenced by buildProperties().

                                                                  : string
     {
         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	(	string	$a_entity,
		string	$a_schema_version,
		array	$a_ids,
		string	$a_field = `""`,
		bool	$a_omit_header = `false`,
		bool	$a_omit_types = `false`
	)

own getXmlRepresentation function to embed zipfile in xml

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

References $GLOBALS, $id, ilExport\_getExportDirectory(), buildManifest(), buildMetaData(), buildProperties(), exit, getTypes(), ilFileUtils\getWebspaceDir(), IL_INST_ID, ILIAS\Repository\int(), readData(), and ilFileUtils\zip().

      : string {
         $GLOBALS['DIC']["ilLog"]->write(json_encode($this->getTypes("sahs", "5.1.0"), JSON_PRETTY_PRINT));
 
         $this->dircnt = 1;
 
         $this->readData($a_entity, $a_schema_version, $a_ids, $a_field = "");
         $id = (int) $this->data["id"];
         $exportDir = ilExport::_getExportDirectory((int) $id, "xml", "sahs");
 
         // prepare archive skeleton
         $objTypeAndId = "sahs_" . $id;
         $this->_archive['directories'] = [
             "exportDir" => ilExport::_getExportDirectory($id)
             ,"tempDir" => ilExport::_getExportDirectory($id) . "/temp"
             ,"archiveDir" => time() . "__" . IL_INST_ID . "__" . $objTypeAndId
             ,"moduleDir" => $objTypeAndId
         ];
 
         $this->_archive['files'] = [
             "properties" => "properties.xml",
             "metadata" => "metadata.xml",
             "manifest" => 'manifest.xml',
             'scormFile' => "content.zip"
         ];
 
         // Prepare temp storage on the local filesystem
         if (!file_exists($this->_archive['directories']['exportDir'])) {
             mkdir($this->_archive['directories']['exportDir'], 0755, true);
             //$DIC->filesystem()->storage()->createDir($this->_archive['directories']['tempDir']);
         }
         if (!file_exists($this->_archive['directories']['tempDir'])) {
             mkdir($this->_archive['directories']['tempDir'], 0755, true);
         }
 
         // build metadata xml file
         file_put_contents(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['metadata'],
             $this->buildMetaData($id)
         );
 
         // build manifest xml file
         file_put_contents(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['manifest'],
             $this->buildManifest()
         );
 
         // build content zip file
         if (isset($this->_archive['files']['scormFile'])) {
             $lmDir = ilFileUtils::getWebspaceDir("filesystem") . "/lm_data/lm_" . $id;
             ilFileUtils::zip($lmDir, $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['scormFile'], true);
         }
 
         // build property xml file
         file_put_contents(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['properties'],
             $this->buildProperties($a_entity, $a_omit_header)
         );
 
         // zip tempDir and append to export folder
         $fileName = $this->_archive['directories']['exportDir'] . "/" . $this->_archive['directories']['archiveDir'] . ".zip";
         $zArchive = new ZipArchive();
         if ($zArchive->open($fileName, ZipArchive::CREATE) !== true) {
             exit("cannot open <$fileName>\n");
         }
         $zArchive->addFile(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['properties'],
             $this->_archive['directories']['archiveDir'] . '/properties.xml'
         );
         $zArchive->addFile(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['manifest'],
             $this->_archive['directories']['archiveDir'] . '/' . "manifest.xml"
         );
         $zArchive->addFile(
             $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['metadata'],
             $this->_archive['directories']['archiveDir'] . '/' . "metadata.xml"
         );
         if (isset($this->_archive['files']['scormFile'])) {
             $zArchive->addFile(
                 $this->_archive['directories']['tempDir'] . "/" . $this->_archive['files']['scormFile'],
                 $this->_archive['directories']['archiveDir'] . '/content.zip'
             );
         }
         $zArchive->close();
 
         // unlink tempDir and its content
         unlink($this->_archive['directories']['tempDir'] . "/metadata.xml");
         unlink($this->_archive['directories']['tempDir'] . "/manifest.xml");
         unlink($this->_archive['directories']['tempDir'] . "/properties.xml");
         if (isset($this->_archive['files']['scormFile']) && file_exists($this->_archive['directories']['tempDir'] . "/content.zip")) {
             unlink($this->_archive['directories']['tempDir'] . "/content.zip");
         }
 
         return $fileName;
     }

Here is the call graph for this function:

◆ getSupportedVersions()

ilScormAiccDataSet::getSupportedVersions ( )

Returns: string[]

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

                                           : array
     {
         return ["5.1.0"];
     }

◆ getTypes()

ilScormAiccDataSet::getTypes	(	string	$a_entity,
		string	$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 272 of file class.ilScormAiccDataSet.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by getExtendedXmlRepresentation().

                                                                     : array
     {
         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;
             }
         }
         return [];
     }

Here is the caller graph for this function:

◆ getXmlNamespace()

ilScormAiccDataSet::getXmlNamespace	(	string	$a_entity,
		string	$a_schema_version
	)

protected

Get xml namespace.

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

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

◆ readData()

ilScormAiccDataSet::readData	(	string	$a_entity,
		string	$a_version,
		array	$a_ids,
		string	$a_field = `""`
	)

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

References $db_table, $DIC, $ilDB, and ILIAS\Repository\int().

Referenced by getExtendedXmlRepresentation().

                                                                                                      : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $obj_id = (int) $a_ids[0];
         $columns = [];
         foreach ($this->properties as $property) {
             $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	(	string	$a_entity,
		string	$a_version,
		int	$a_id,
		array	$data
	)

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

References $DIC, $ilDB, ILIAS\LTI\ToolProvider\$key, and ilLoggerFactory\getLogger().

                                                                                           : void
     {
         global $DIC;
         $ilDB = $DIC->database();
         $ilLog = ilLoggerFactory::getLogger('sahs');
         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" && isset($data[$key][0]) && $data[$key][0] == 0) {
                     continue;
                 }
                 if ($key === "Localization" && isset($data[$key][0]) && $data[$key][0] == "") {
                     continue;
                 }
                 //end fix
                                 if ( isset( $data[ $key ] ) ) {
                                         $data_value = '';
                                         if ( is_array( $data[ $key ] ) ) {
                                                 $data_value = $data[ $key ][ 0 ] ?? '';
                                         }
                                         else {
                                                 $data_value = $data[ $key ];
                                         }
                                         $columns [ $value[ "db_col" ] ] = [
                                                 $value[ "db_type" ],
                                                 $data_value
                                         ];
                                 }
             }
             if (is_array($columns)) {
                 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 ] ) ) {
                                         $data_value = '';
                                         if ( is_array( $data[ $key ] ) ) {
                                                 $data_value = $data[ $key ][ 0 ] ?? '';
                                         }
                                         else {
                                                 $data_value = $data[ $key ];
                                         }
                                         $od_columns [ $value[ "db_col" ] ] = [
                                                 $value[ "db_type" ],
                                                 $data_value
                                         ];
                                 }
 
                 if (isset($od_columns) && is_array($od_columns)) {
                     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");
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $_archive

array ilScormAiccDataSet::$_archive

private

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

◆ $db_table

string ilScormAiccDataSet::$db_table

private

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

Referenced by readData().

◆ $element_db_mapping

array ilScormAiccDataSet::$element_db_mapping

private

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

◆ $properties

array ilScormAiccDataSet::$properties

Definition at line 24 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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildManifest()

◆ buildMetaData()

◆ buildProperties()

◆ getDependencies()

◆ getElementNameByDbColumn()

◆ getExtendedXmlRepresentation()

◆ getSupportedVersions()

◆ getTypes()

◆ getXmlNamespace()

◆ readData()

◆ writeData()

Field Documentation

◆ $_archive

◆ $db_table

◆ $element_db_mapping

◆ $properties