ilScormAiccImporter Class Reference

Inheritance diagram for ilScormAiccImporter:

Collaboration diagram for ilScormAiccImporter:

Public Member Functions
	__construct ()
	init ()
	importXmlRepresentation ($a_entity, $a_id, $a_import_dirname, $a_mapping)
	Import XML. More...
	writeData ($a_entity, $a_version, $a_id)
	handleEditableLmXml ($a_entity, $a_id, $a_xml, $a_mapping)
	Handle editable (authoring) scorm lms. More...
Public Member Functions inherited from ilXmlImporter
	__construct ()
	Constructor. More...
	setImport ($a_val)
	Set import. More...
	getImport ()
	Get import. More...
	init ()
	Init. More...
	setInstallId ($a_val)
	Set installation id. More...
	getInstallId ()
	Get installation id. More...
	setInstallUrl ($a_val)
	Set installation url. More...
	getInstallUrl ()
	Get installation url. More...
	setSchemaVersion ($a_val)
	Set schema version. More...
	getSchemaVersion ()
	Get schema version. More...
	setImportDirectory ($a_val)
	Set import directory. More...
	getImportDirectory ()
	Get import directory. More...
	setSkipEntities ($a_val)
	Set skip entities. More...
	getSkipEntities ()
	Get skip entities. More...
	exportedFromSameInstallation ()
	Is exporting and importing installation identical? More...
	importXmlRepresentation ($a_entity, $a_id, $a_xml, $a_mapping)
	Import xml representation. More...
	finalProcessing ($a_mapping)
	Final processing. More...
	afterContainerImportProcessing (ilImportMapping $mapping)
	Called after all container objects have been implemented. More...

Additional Inherited Members
Protected Attributes inherited from ilXmlImporter
	$skip_entities = array()
	$imp

Detailed Description

Definition at line 4 of file class.ilScormAiccImporter.php.

Constructor & Destructor Documentation

__construct()

ilScormAiccImporter::__construct

(

)

Definition at line 6 of file class.ilScormAiccImporter.php.

    {
        require_once "./Modules/ScormAicc/classes/class.ilScormAiccDataSet.php";
        $this->dataset = new ilScormAiccDataSet();
        //todo: at the moment restricted to one module in xml file, extend?
        $this->moduleProperties = [];
        $this->manifest = [];
    }

Member Function Documentation

handleEditableLmXml()

ilScormAiccImporter::handleEditableLmXml	(		$a_entity,
			$a_id,
			$a_xml,
			$a_mapping
	)

Handle editable (authoring) scorm lms.

Parameters

string	$a_entity	entity
string	$a_id	id
string	$a_xml	xml
ilImportMapping	$a_mapping	import mapping object

Returns

bool success

Definition at line 136 of file class.ilScormAiccImporter.php.

References $parser, ilXmlImporter\getImportDirectory(), and ilXmlImporter\getSchemaVersion().

Referenced by importXmlRepresentation().

    {
        // if editable...
        if (is_int(strpos($a_xml, "<Editable>1</Editable>"))) {
            // ...use ilScorm2004DataSet for import
            include_once("./Modules/Scorm2004/classes/class.ilScorm2004DataSet.php");
            $dataset = new ilScorm2004DataSet();
            $dataset->setDSPrefix("ds");
            $dataset->setImportDirectory($this->getImportDirectory());

            include_once("./Services/DataSet/classes/class.ilDataSetImportParser.php");
            $parser = new ilDataSetImportParser(
                $a_entity,
                $this->getSchemaVersion(),
                $a_xml,
                $dataset,
                $a_mapping
            );
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

importXmlRepresentation()

ilScormAiccImporter::importXmlRepresentation	(		$a_entity,
			$a_id,
			$a_import_dirname,
			$a_mapping
	)

Import XML.

Parameters

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

References $DIC, $ilLog, $key, $result, $title, $xml, ilExport\_getExportDirectory(), ilUtil\delDir(), ilXmlImporter\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilUtil\getWebspaceDir(), handleEditableLmXml(), ilFileUtils\rename(), ilUtil\renameExecutables(), and ilUtil\unzip().

    {
        global $DIC;
        $ilLog = $DIC['ilLog'];
        
        if ($this->handleEditableLmXml($a_entity, $a_id, $a_import_dirname, $a_mapping)) {
            return true;
        }
        // case i container
        if ($a_id != null && $new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
            $newObj = ilObjectFactory::getInstanceByObjId($new_id, false);

            require_once("./Services/Export/classes/class.ilExport.php");
            $exportDir = ilExport::_getExportDirectory($a_id);
            $tempFile = dirname($exportDir) . '/export/' . basename($this->getImportDirectory()) . '.zip';
            $timeStamp = time();
            $lmDir = ilUtil::getWebspaceDir("filesystem") . "/lm_data/";
            $lmTempDir = $lmDir . $timeStamp;
            if (!file_exists($lmTempDir)) {
                mkdir($lmTempDir, 0755, true);
            }
            $zar = new ZipArchive();
            $zar->open($tempFile);
            $zar->extractTo($lmTempDir);
            $zar->close();
            $a_import_dirname = $lmTempDir . '/' . basename($this->getImportDirectory());
        }



        $result = false;
        if (file_exists($a_import_dirname)) {
            $manifestFile = $a_import_dirname . "/manifest.xml";
            if (file_exists($manifestFile)) {
                $manifest = file_get_contents($manifestFile);
                if (isset($manifest)) {
                    $propertiesFile = $a_import_dirname . "/properties.xml";
                    $xml = file_get_contents($propertiesFile);
                    if (isset($xml)) {
                        $xmlRoot = simplexml_load_string($xml);
                        foreach ($this->dataset->properties as $key => $value) {
                            $this->moduleProperties[$key] = $xmlRoot->$key;
                        }
                        $this->moduleProperties["Title"] = $xmlRoot->Title;
                        $this->moduleProperties["Description"] = $xmlRoot->Description;
                        
                        if ($a_id != null && $new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
                            $this->dataset->writeData("sahs", "5.1.0", $newObj->getId(), $this->moduleProperties);

                            $newObj->createReference();

                            $scormFile = "content.zip";
                            $scormFilePath = $a_import_dirname . "/" . $scormFile;
                            $targetPath = $newObj->getDataDirectory() . "/" . $scormFile;
                            $file_path = $targetPath;

                            ilFileUtils::rename($scormFilePath, $targetPath);
                            ilUtil::unzip($file_path);
                            unlink($file_path);
                            ilUtil::delDir($lmTempDir, false);
                            ilUtil::renameExecutables($newObj->getDataDirectory());

                            $newId = $newObj->getRefId();
                            // $newObj->putInTree($newId);
                            // $newObj->setPermissions($newId);
                            $subType = $this->moduleProperties["SubType"][0];
                            if ($subType == "scorm") {
                                include_once("./Modules/ScormAicc/classes/class.ilObjSCORMLearningModule.php");
                                $newObj = new ilObjSCORMLearningModule($newId);
                            } else {
                                include_once("./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php");
                                $newObj = new ilObjSCORM2004LearningModule($newId);
                            }
                            $title = $newObj->readObject();
                            //auto set learning progress settings
                            $newObj->setLearningProgressSettingsAtUpload();
                        }
                        
                        
                        $result = true;
                    } else {
                        $ilLog->write("error parsing xml file for scorm import");
                        //error xml parsing
                    }
                } else {
                    $ilLog->write("error reading manifest file");
                }
            } else {
                $ilLog->write("error no manifest file found");
            }
        } else {
            $ilLog->write("error file lost while importing");
            //error non existing file
        }
        return $result;
    }

Here is the call graph for this function:

init()

ilScormAiccImporter::init

(

)

Definition at line 15 of file class.ilScormAiccImporter.php.

    {
    }

writeData()

ilScormAiccImporter::writeData	(		$a_entity,
			$a_version,
			$a_id
	)

Definition at line 122 of file class.ilScormAiccImporter.php.

    {
        $this->dataset->writeData($a_entity, $a_version, $a_id, $this->moduleProperties);
    }

---

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

• Modules/ScormAicc/classes/class.ilScormAiccImporter.php