ilScorm2004DataSet Class Reference

Inheritance diagram for ilScorm2004DataSet:

Collaboration diagram for ilScorm2004DataSet:

Public Member Functions
	getSupportedVersions ()
	Note: this is currently used for SCORM authoring lms. More...
	getXmlNamespace ($a_entity, $a_schema_version)
	Get xml namespace. More...
	readData ($a_entity, $a_version, $a_ids, $a_field="")
	Read data. More...
	getXmlRecord ($a_entity, $a_version, $a_set)
	Get xml record. More...
	afterXmlRecordWriting ($a_entity, $a_schema_version, $d)
	importRecord ($a_entity, $a_types, $a_rec, $a_mapping, $a_schema_version)
	Import record. More...
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 ...> ... </types> <set entity="table_name"> <rec> <field_1>content</field_1> <field_2>my_date</field_2> <field_3>my_number</field_3> </rec> ... </set> </dataset> 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...
	getDependencies ($a_entity, $a_version, $a_rec, $a_ids)
	Determine the dependent sets of data. 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...

Protected Attributes
	$temp_dir = array()
Protected Attributes inherited from ilDataSet
	$current_installation_id = ""
	$db
	$ds_log

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

Detailed Description

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

Member Function Documentation

afterXmlRecordWriting()

ilScorm2004DataSet::afterXmlRecordWriting	(		$a_entity,
			$a_schema_version,
			$d
	)

Parameters

return

Reimplemented from ilDataSet.

Definition at line 142 of file class.ilScorm2004DataSet.php.

    {
        if ($a_entity == "sahs") {
            // delete our temp dir
            if (isset($this->temp_dir[$d["Id"]]) && is_dir($this->temp_dir[$d["Id"]])) {
                ilUtil::delDir($this->temp_dir[$d["Id"]]);
            }
        }
    }

References $d, and ilUtil\delDir().

Here is the call graph for this function:

getDependencies()

ilScorm2004DataSet::getDependencies (   $a_entity,   $a_version,   $a_rec,   $a_ids  )

protected

Determine the dependent sets of data.

Definition at line 94 of file class.ilScorm2004DataSet.php.

    {
        switch ($a_entity) {
            case "sahs":
                return array();
 
        }
        return false;
    }

getSupportedVersions()

ilScorm2004DataSet::getSupportedVersions

(

)

Note: this is currently used for SCORM authoring lms.

Get supported versions

Returns

string[]

Reimplemented from ilDataSet.

Definition at line 16 of file class.ilScorm2004DataSet.php.

    {
        return array("5.1.0");
    }

getTypes()

ilScorm2004DataSet::getTypes (   $a_entity,   $a_version  )

protected

Get field types for entity.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 38 of file class.ilScorm2004DataSet.php.

    {
        if ($a_entity == "sahs") {
            switch ($a_version) {
                case "5.1.0":
                    return array(
                        "Id" => "integer",
                        "Title" => "text",
                        "Description" => "text",
                        "Editable" => "integer",
                        "Dir" => "directory",
                        "File" => "text"
                    );
            }
        }
    }

getXmlNamespace()

ilScorm2004DataSet::getXmlNamespace	(		$a_entity,
			$a_schema_version
	)

Get xml namespace.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 27 of file class.ilScorm2004DataSet.php.

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

getXmlRecord()

ilScorm2004DataSet::getXmlRecord	(		$a_entity,
			$a_version,
			$a_set
	)

Get xml record.

Parameters

return

Reimplemented from ilDataSet.

Definition at line 110 of file class.ilScorm2004DataSet.php.

    {
        if ($a_entity == "sahs") {
            // build traditional author export file
            include_once './Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php';
            $lm = new ilObjSCORM2004LearningModule($a_set["Id"], false);
            $export = new ilScorm2004Export($lm, 'SCORM 2004 3rd');
            $zip = $export->buildExportFile();
 
            // move it to temp dir
            $tmpdir = ilUtil::ilTempnam();
            ilUtil::makeDir($tmpdir);
            $exp_temp = $tmpdir . DIRECTORY_SEPARATOR . basename($zip);
            ilFileUtils::rename($zip, $exp_temp);
 
            $this->temp_dir[$a_set["Id"]] = $tmpdir;
 
            // include temp dir
            $a_set["Dir"] = $tmpdir;
            $a_set["File"] = basename($zip);
        }
 
        return $a_set;
    }

References ilUtil\ilTempnam(), ilUtil\makeDir(), and ilFileUtils\rename().

Here is the call graph for this function:

importRecord()

ilScorm2004DataSet::importRecord	(		$a_entity,
			$a_types,
			$a_rec,
			$a_mapping,
			$a_schema_version
	)

Import record.

Parameters

$a_entity
$a_types
$a_rec
$a_mapping
$a_schema_version

Definition at line 161 of file class.ilScorm2004DataSet.php.

    {
        switch ($a_entity) {
            case "sahs":
                $new_obj_id = $a_mapping->getMapping("Services/Container", "objs", $a_rec["Id"]);
                include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
                $lm = new ilObjSCORM2004LearningModule($new_obj_id, false);
 
                $lm->setEditable($a_rec["Editable"]);
                $lm->setImportSequencing(false);
                $lm->setSequencingExpertMode(false);
                $lm->setSubType("scorm2004");
 
                $dir = str_replace("..", "", $a_rec["Dir"]);
                if ($dir != "" && $this->getImportDirectory() != "") {
                    $source_dir = $this->getImportDirectory() . "/" . $dir;
                    $file_path = $lm->getDataDirectory() . "/" . $a_rec["File"];
                    ilFileUtils::rename($source_dir . "/" . $a_rec["File"], $file_path);
 
                    ilUtil::unzip($file_path);
                    ilUtil::renameExecutables($lm->getDataDirectory());
                    $title = $lm->readObject();
                    if ($title != "") {
                        ilObject::_writeTitle($lm->getId(), $title);
                    }
 
                    $lm->setLearningProgressSettingsAtUpload();
                    $lm->update();
                }
                break;
 
        }
    }

References $title, ilObject\_writeTitle(), ilDataSet\getImportDirectory(), ilFileUtils\rename(), ilUtil\renameExecutables(), and ilUtil\unzip().

Here is the call graph for this function:

readData()

ilScorm2004DataSet::readData	(		$a_entity,
			$a_version,
			$a_ids,
			$a_field = ""
	)

Read data.

Parameters

return

Definition at line 61 of file class.ilScorm2004DataSet.php.

    {
        $ilDB = $this->db;
 
        if (!is_array($a_ids)) {
            $a_ids = array($a_ids);
        }
 
        // sahs
        if ($a_entity == "sahs") {
            $this->data = array();
 
            switch ($a_version) {
                case "5.1.0":
                    foreach ($a_ids as $sahs_id) {
                        if (ilObject::_lookupType($sahs_id) == "sahs") {
                            $this->data[] = array("Id" => $sahs_id,
                                "Title" => ilObject::_lookupTitle($sahs_id),
                                "Description" => ilObject::_lookupDescription($sahs_id),
                                "Editable" => 1
                            );
                        }
                    }
                    break;
 
            }
        }
    }

References ilDataSet\$db, $ilDB, ilObject\_lookupDescription(), ilObject\_lookupTitle(), ilObject\_lookupType(), and data.

Here is the call graph for this function:

Field Documentation

$temp_dir

ilScorm2004DataSet::$temp_dir = array()

protected

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

---

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

• Modules/Scorm2004/classes/class.ilScorm2004DataSet.php