Inheritance diagram for ilCmiXapiImporter:

Collaboration diagram for ilCmiXapiImporter:

Public Member Functions
	__construct ()
	ilCmiXapiImporter constructor. More...

	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	Init the object creation from import. More...

	init ()

	__destruct ()
	if single import then deleteImportDirectiry More...

Public Member Functions inherited from ilXmlImporter
	__construct ()

	setImport (ilImport $a_val)

	getImport ()

	init ()

	setInstallId (string $a_val)

	getInstallId ()

	setInstallUrl (string $a_val)

	getInstallUrl ()

	setSchemaVersion (string $a_val)

	getSchemaVersion ()

	setImportDirectory (string $a_val)

	getImportDirectory ()

	setSkipEntities (array $a_val)

	getSkipEntities ()

	exportedFromSameInstallation ()

	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)

	finalProcessing (ilImportMapping $a_mapping)

	afterContainerImportProcessing (ilImportMapping $mapping)

Data Fields
array	$manifest = []

Private Member Functions
	prepareSingleObject ()
	Builds the CmiXapi Object. More...

	prepareContainerObject ()
	Builds the CmiXapi Object. More...

	prepareLocalSourceStorage ()
	Creates a folder in the data directory of the document root. More...

	parseXmlFileProperties ()
	Parse xml file and set properties. More...

	updateNewObj ()
	Finalize the new CmiXapi Object. More...

	deleteImportDirectiry ()
	Delete the import directory. More...

	getImportDirectorySingle ()
	Gets the relative path to the Filesystem::temp Folder. More...

	getImportDirectoryContainer ()
	Gets the relative path to the Filesystem::temp Folder. More...

Private Attributes
array	$_moduleProperties = []

ilCmiXapiDataSet	$_dataset

ilObject	$_cmixObj

string	$_newId = null

string	$_import_objId

ilImportMapping	$_mapping

string	$_relWebDir = 'lm_data/lm_'

string	$_relImportDir = ''

bool	$_isSingleImport = false

ILIAS DI Container	$dic

ILIAS Filesystem Filesystem	$filesystemWeb

ILIAS Filesystem Filesystem	$filesystemTemp

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

ilImport	$imp

string	$install_id

string	$install_url

string	$schema_version

string	$import_directory

Detailed Description

Definition at line 30 of file class.ilCmiXapiImporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilCmiXapiImporter::__construct ( )

ilCmiXapiImporter constructor.

Definition at line 60 of file class.ilCmiXapiImporter.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         parent::__construct();
         global $DIC;
         $this->dic = $DIC;
         $this->filesystemWeb = $DIC->filesystem()->web();
         $this->filesystemTemp = $DIC->filesystem()->temp();
         $this->_dataset = new ilCmiXapiDataSet();
         $this->_dataset->_cmixSettingsProperties['Title'] = '';
         $this->_dataset->_cmixSettingsProperties['Description'] = '';
         //todo: at the moment restricted to one module in xml file, extend?
     }

Here is the call graph for this function:

◆ __destruct()

ilCmiXapiImporter::__destruct ( )

if single import then deleteImportDirectiry

Definition at line 289 of file class.ilCmiXapiImporter.php.

References deleteImportDirectiry().

     {
         if ($this->_isSingleImport) {
             $this->deleteImportDirectiry();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteImportDirectiry()

ilCmiXapiImporter::deleteImportDirectiry ( )

private

Delete the import directory.

Exceptions

Definition at line 250 of file class.ilCmiXapiImporter.php.

Referenced by __destruct().

                                             : self
     {
         $this->filesystemTemp->delete($this->_relImportDir);
         return $this;
     }

Here is the caller graph for this function:

◆ getImportDirectoryContainer()

ilCmiXapiImporter::getImportDirectoryContainer ( )

private

Gets the relative path to the Filesystem::temp Folder.

Returns: $this

Definition at line 272 of file class.ilCmiXapiImporter.php.

References ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

                                                   : self
     {
         $importTempDir = $this->getImportDirectory();
         $dirArr = array_reverse(explode('/', $importTempDir));
         $this->_relImportDir = $dirArr[3] . '/' . $dirArr[2] . '/' . $dirArr[1] . '/' . $dirArr[0];
 
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getImportDirectorySingle()

ilCmiXapiImporter::getImportDirectorySingle ( )

private

Gets the relative path to the Filesystem::temp Folder.

Returns: $this

Definition at line 260 of file class.ilCmiXapiImporter.php.

References ilXmlImporter\getImportDirectory().

Referenced by importXmlRepresentation().

                                                : self
     {
         $importTempDir = $this->getImportDirectory();
         $dirArr = array_reverse(explode('/', $importTempDir));
         $this->_relImportDir = $dirArr[1] . '/' . $dirArr[0];
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ importXmlRepresentation()

ilCmiXapiImporter::importXmlRepresentation	(	string	$a_entity,
		string	$a_id,
		string	$a_xml,
		ilImportMapping	$a_mapping
	)

Init the object creation from import.

Exceptions

Definition at line 78 of file class.ilCmiXapiImporter.php.

References getImportDirectoryContainer(), getImportDirectorySingle(), ilImportMapping\getMapping(), parseXmlFileProperties(), prepareContainerObject(), prepareLocalSourceStorage(), prepareSingleObject(), and updateNewObj().

                                                                                                                       : void
     {
         $this->_import_objId = $a_id;
         $this->_mapping = $a_mapping;
 
         if ($this->_newId = $a_mapping->getMapping('Services/Container', 'objs', (string) $this->_import_objId)) {
             // container content
             $this->prepareContainerObject();
             $this->getImportDirectoryContainer();
         } else {
             // single object
             $this->prepareSingleObject();
             $this->getImportDirectorySingle();
             $this->_isSingleImport = true;
         }
         $this->prepareLocalSourceStorage();
         $this->parseXmlFileProperties();
         $this->updateNewObj();
     }

Here is the call graph for this function:

◆ init()

ilCmiXapiImporter::init ( )

Definition at line 282 of file class.ilCmiXapiImporter.php.

                           : void
     {
     }

◆ parseXmlFileProperties()

ilCmiXapiImporter::parseXmlFileProperties ( )

private

Parse xml file and set properties.

Returns: $this

Exceptions

Definition at line 166 of file class.ilCmiXapiImporter.php.

References ILIAS\LTI\ToolProvider\$key, and $xml.

Referenced by importXmlRepresentation().

                                              : self
     {
         $xmlRoot = null;
         $xml = $this->filesystemTemp->readStream($this->_relImportDir . '/properties.xml');
         if ($xml != false) {
             $use_internal_errors = libxml_use_internal_errors(true);
             $xmlRoot = simplexml_load_string((string) $xml);
             libxml_use_internal_errors($use_internal_errors);
         }
         foreach ($this->_dataset->_cmixSettingsProperties as $key => $property) {
             $this->_moduleProperties[$key] = trim($xmlRoot->$key->__toString());
         }
         return $this;
     }

Here is the caller graph for this function:

◆ prepareContainerObject()

ilCmiXapiImporter::prepareContainerObject ( )

private

Builds the CmiXapi Object.

Definition at line 124 of file class.ilCmiXapiImporter.php.

References ilObjectFactory\getInstanceByObjId().

Referenced by importXmlRepresentation().

                                              : void
     {
         $this->_newId = $this->_mapping->getMapping('Services/Container', 'objs', (string) $this->_import_objId);
         if (!is_null($this->_newId) && $this->_newId != "") {
             // container content
             $this->_cmixObj = ilObjectFactory::getInstanceByObjId((int) $this->_newId, false);
             //$_SESSION['tst_import_subdir'] = $this->getImportPackageName();
             $this->_cmixObj->save(); // this generates test id first time
             //var_dump([$this->getImportDirectory(), $this->_import_dirname]); exit;
             $this->_mapping->addMapping("Modules/CmiXapi", "cmix", (string) $this->_import_objId, $this->_newId);
         }
         $this->_cmixObj->save();
         $this->_cmixObj->update();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareLocalSourceStorage()

ilCmiXapiImporter::prepareLocalSourceStorage ( )

private

Creates a folder in the data directory of the document root.

Exceptions

Definition at line 144 of file class.ilCmiXapiImporter.php.

References ilFileUtils\getWebspaceDir(), and ilFileUtils\unzip().

Referenced by importXmlRepresentation().

                                                 : self
     {
         if (true === $this->filesystemTemp->has($this->_relImportDir . '/content.zip')) {
             //            $this->_hasContent = true;
             $this->_relWebDir = $this->_relWebDir . $this->_cmixObj->getId();
             if (false === $this->filesystemWeb->has($this->_relWebDir)) {
                 $this->filesystemWeb->createDir($this->_relWebDir);
                 $this->filesystemWeb->put($this->_relWebDir . '/content.zip', $this->filesystemTemp->read($this->_relImportDir . '/content.zip'));
                 $webDataDir = ilFileUtils::getWebspaceDir();
                 ilFileUtils::unzip($webDataDir . "/" . $this->_relWebDir . "/content.zip");
                 $this->filesystemWeb->delete($this->_relWebDir . '/content.zip');
             }
         }
         return $this;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareSingleObject()

ilCmiXapiImporter::prepareSingleObject ( )

private

Builds the CmiXapi Object.

Definition at line 101 of file class.ilCmiXapiImporter.php.

Referenced by importXmlRepresentation().

                                           : self
     {
         // create new cmix object
         $this->_cmixObj = new ilObjCmiXapi();
         // set type of questionpool object
         $this->_cmixObj->setType('cmix');
         // set title of questionpool object to "dummy"
         $this->_cmixObj->setTitle("dummy");
         // set description of questionpool object
         $this->_cmixObj->setDescription("test import");
         // create the questionpool class in the ILIAS database (object_data table)
         $this->_cmixObj->create(true);
         $this->_newId = (string) $this->_cmixObj->getId();
         $this->_mapping->addMapping('Modules/CmiXapi', 'cmix', (string) $this->_import_objId, (string) $this->_newId);
         //$this->getImport();
         $this->_cmixObj->update();
 
         return $this;
     }

Here is the caller graph for this function:

◆ updateNewObj()

ilCmiXapiImporter::updateNewObj ( )

private

Finalize the new CmiXapi Object.

Returns: void

Definition at line 185 of file class.ilCmiXapiImporter.php.

Referenced by importXmlRepresentation().

                                    : void
     {
         $this->_cmixObj->setTitle($this->_moduleProperties['Title'] . " " . $this->dic->language()->txt("copy_of_suffix"));
         $this->_cmixObj->setDescription($this->_moduleProperties['Description']);
         $this->_cmixObj->update();
 
         if ($this->_moduleProperties['LrsTypeId']) {
             $this->_cmixObj->setLrsTypeId((int) $this->_moduleProperties['LrsTypeId']);
             $this->_cmixObj->setLrsType(new ilCmiXapiLrsType((int) $this->_moduleProperties['LrsTypeId']));
         }
         $this->_cmixObj->setContentType((string) $this->_moduleProperties['ContentType']);
         $this->_cmixObj->setSourceType((string) $this->_moduleProperties['SourceType']);
         $this->_cmixObj->setActivityId((string) $this->_moduleProperties['ActivityId']);
         $this->_cmixObj->setInstructions((string) $this->_moduleProperties['Instructions']);
         // $this->_cmixObj->setOfflineStatus($this->_moduleProperties['OfflineStatus']);
         $this->_cmixObj->setLaunchUrl((string) $this->_moduleProperties['LaunchUrl']);
         $this->_cmixObj->setAuthFetchUrlEnabled((bool) $this->_moduleProperties['AuthFetchUrl']);
         $this->_cmixObj->setLaunchMethod((string) $this->_moduleProperties['LaunchMethod']);
         $this->_cmixObj->setLaunchMode((string) $this->_moduleProperties['LaunchMode']);
         $this->_cmixObj->setMasteryScore((float) $this->_moduleProperties['MasteryScore']);
         $this->_cmixObj->setKeepLpStatusEnabled((bool) $this->_moduleProperties['KeepLp']);
         $this->_cmixObj->setPrivacyIdent((int) $this->_moduleProperties['PrivacyIdent']);
         $this->_cmixObj->setPrivacyName((int) $this->_moduleProperties['PrivacyName']);
         $this->_cmixObj->setUserPrivacyComment((string) $this->_moduleProperties['UsrPrivacyComment']);
         $this->_cmixObj->setStatementsReportEnabled((bool) $this->_moduleProperties['ShowStatements']);
         $this->_cmixObj->setXmlManifest((string) $this->_moduleProperties['XmlManifest']);
         $this->_cmixObj->setVersion((int) $this->_moduleProperties['Version']);
         $this->_cmixObj->setHighscoreEnabled((bool) $this->_moduleProperties['HighscoreEnabled']);
         $this->_cmixObj->setHighscoreAchievedTS((bool) $this->_moduleProperties['HighscoreAchievedTs']);
         $this->_cmixObj->setHighscorePercentage((bool) $this->_moduleProperties['HighscorePercentage']);
         $this->_cmixObj->setHighscoreWtime((bool) $this->_moduleProperties['HighscoreWtime']);
         $this->_cmixObj->setHighscoreOwnTable((bool) $this->_moduleProperties['HighscoreOwnTable']);
         $this->_cmixObj->setHighscoreTopTable((bool) $this->_moduleProperties['HighscoreTopTable']);
         $this->_cmixObj->setHighscoreTopNum((int) $this->_moduleProperties['HighscoreTopNum']);
         $this->_cmixObj->setBypassProxyEnabled((bool) $this->_moduleProperties['BypassProxy']);
         $this->_cmixObj->setOnlyMoveon((bool) $this->_moduleProperties['OnlyMoveon']);
         $this->_cmixObj->setAchieved((bool) $this->_moduleProperties['Achieved']);
         $this->_cmixObj->setAnswered((bool) $this->_moduleProperties['Answered']);
         $this->_cmixObj->setCompleted((bool) $this->_moduleProperties['Completed']);
         $this->_cmixObj->setFailed((bool) $this->_moduleProperties['Failed']);
         $this->_cmixObj->setInitialized((bool) $this->_moduleProperties['Initialized']);
         $this->_cmixObj->setPassed((bool) $this->_moduleProperties['Passed']);
         $this->_cmixObj->setProgressed((bool) $this->_moduleProperties['Progressed']);
         $this->_cmixObj->setSatisfied((bool) $this->_moduleProperties['Satisfied']);
         $this->_cmixObj->setTerminated((bool) $this->_moduleProperties['Terminated']);
         $this->_cmixObj->setHideData((bool) $this->_moduleProperties['HideData']);
         $this->_cmixObj->setTimestamp((bool) $this->_moduleProperties['Timestamp']);
         $this->_cmixObj->setDuration((bool) $this->_moduleProperties['Duration']);
         $this->_cmixObj->setNoSubstatements((bool) $this->_moduleProperties['NoSubstatements']);
         $this->_cmixObj->setPublisherId((string) $this->_moduleProperties['PublisherId']);
         //        $this->_cmixObj->setAnonymousHomepage($this->_moduleProperties['AnonymousHomepage']);
         $this->_cmixObj->setMoveOn((string) $this->_moduleProperties['MoveOn']);
         $this->_cmixObj->setLaunchParameters((string) $this->_moduleProperties['LaunchParameters']);
         $this->_cmixObj->setEntitlementKey((string) $this->_moduleProperties['EntitlementKey']);
         $this->_cmixObj->setSwitchToReviewEnabled((bool) $this->_moduleProperties['SwitchToReview']);
         $this->_cmixObj->save();
         $this->_cmixObj->updateMetaData();
 
     }