Inheritance diagram for ilScormAiccImporter:

Collaboration diagram for ilScormAiccImporter:

Public Member Functions
	__construct ()

	getResult ()

	init ()

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

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

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)

Private Member Functions
	initResult ()

	publishResult (\ILIAS\Data\Result $result)

Private Attributes
ilScormAiccDataSet	$dataset

ILIAS Data Result	$result

DataTypeFactory	$df

array	$module_properties = []

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 23 of file class.ilScormAiccImporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilScormAiccImporter::__construct ( )

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

References ILIAS\GlobalScreen\Provider\__construct(), and initResult().

     {
         $this->dataset = new ilScormAiccDataSet();
         $this->df = new DataTypeFactory();
         $this->initResult();
 
         parent::__construct();
     }

Here is the call graph for this function:

Member Function Documentation

◆ getResult()

ilScormAiccImporter::getResult ( )

Returns: |<array<string, string|SimpleXMLElement>>

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

References $result.

                                : \ILIAS\Data\Result
     {
         return $this->result;
     }

◆ importXmlRepresentation()

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

Exceptions

ilDatabaseException
ilFileUtilsException
ilObjectNotFoundException

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

References $DIC, $message, $module_properties, ILIAS\Data\Result\error(), ilXmlImporter\getImportDirectory(), ilObjectFactory\getInstanceByObjId(), ilImportMapping\getMapping(), initResult(), null, publishResult(), ilFileUtils\rename(), ilFileUtils\renameExecutables(), and ilUtil\stripSlashes().

      : void {
         global $DIC;
 
         $this->initResult();
 
         $xml_directory = $a_xml;
         $new_object = null;
 
         $this->publishResult(
             $this->df
                 ->ok('Parsing started')
                 ->then(
                     function (string $message) use (
                         &$new_object,
                         &$xml_directory,
                         $a_id,
                         $a_mapping
                     ): ?\ILIAS\Data\Result {
                         if ($a_id !== '' &&
                             $a_mapping !== null &&
                             ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id))) {
                             $new_object = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
                             $xml_directory = $this->getImportDirectory();
                         }
 
                         return $this->df->ok($xml_directory);
                     }
                 )
                 ->then(function (string $xml_directory): ?\ILIAS\Data\Result {
                     if (!is_dir($xml_directory)) {
                         return $this->df->error(
                             sprintf('Directory lost while importing: %s', $xml_directory)
                         );
                     }
 
                     return null;
                 })
                 ->then(function (string $xml_directory): ?\ILIAS\Data\Result {
                     $manifest_file = $xml_directory . '/manifest.xml';
                     if (!file_exists($manifest_file)) {
                         return $this->df->error(
                             sprintf(
                                 'No manifest file found in import directory "%s": %s',
                                 $xml_directory,
                                 $manifest_file
                             )
                         );
                     }
 
                     return $this->df->ok($manifest_file);
                 })
                 ->then(function (string $manifest_file): ?\ILIAS\Data\Result {
                     $manifest_file_content = file_get_contents($manifest_file);
                     if (!is_string($manifest_file_content) || $manifest_file_content === '') {
                         return $this->df->error(
                             sprintf(
                                 'Could not read content from manifest file: %s',
                                 $manifest_file
                             )
                         );
                     }
 
                     return $this->df->ok($manifest_file_content);
                 })
                 ->then(function (string $manifest_file_content) use ($xml_directory): ?\ILIAS\Data\Result {
                     $properties_file = $xml_directory . '/properties.xml';
                     $properties_file_content = file_get_contents($properties_file);
                     if (!is_string($properties_file_content) || $properties_file_content === '') {
                         return $this->df->error(
                             sprintf(
                                 'Could not read file: %s',
                                 $properties_file
                             )
                         );
                     }
 
                     return $this->df->ok($properties_file_content);
                 })
                 ->then(function (string $properties_file_content): ?\ILIAS\Data\Result {
                     return (new ilScormImportParser($this->df))->parse($properties_file_content);
                 })
                 ->then(
                     function (SimpleXMLElement $properties_xml_doc): ?\ILIAS\Data\Result {
                         try {
                             foreach ($this->dataset->properties as $key => $value) {
                                 $this->module_properties[$key] = $properties_xml_doc->{$key};
                             }
 
                             $this->module_properties['Title'] = $properties_xml_doc->Title;
                             $this->module_properties['Description'] = $properties_xml_doc->Description;
 
                             foreach ($this->module_properties as $key => $property_node) {
                                 $property_value = $property_node->__toString();
                                 $filteredValue = preg_replace('%\s%', '', $property_value);
                                 $this->module_properties[$key] = ilUtil::stripSlashes($filteredValue);
                             }
 
                             return $this->df->ok($this->module_properties);
                         } catch (Exception $exception) {
                             return $this->df->error($exception);
                         }
                     }
                 )->then(function (array $module_properties) use (
                     $xml_directory,
                     $a_id,
                     $a_mapping,
                     $new_object,
                     $DIC
                 ): ?\ILIAS\Data\Result {
                     if ($a_id !== '' &&
                         $a_mapping !== null &&
                         ($new_id = $a_mapping->getMapping(
                             'Services/Container',
                             'objs',
                             $a_id
                         ))) {
                         $this->dataset->writeData(
                             'sahs',
                             '5.1.0',
                             $new_object->getId(),
                             $this->module_properties
                         );
 
                         $new_object->createReference();
 
                         $scormFile = 'content.zip';
                         $scormFilePath = $xml_directory . '/' . $scormFile;
                         $targetPath = $new_object->getDataDirectory() . '/' . $scormFile;
                         $file_path = $targetPath;
 
                         ilFileUtils::rename($scormFilePath, $targetPath);
                         $DIC->legacyArchives()->unzip($file_path);
                         unlink($file_path);
                         ilFileUtils::renameExecutables($new_object->getDataDirectory());
 
                         $new_ref_id = $new_object->getRefId();
                         $subType = $module_properties['SubType'];
                         if ($subType === 'scorm') {
                             $new_object = new ilObjSCORMLearningModule($new_ref_id);
                         } else {
                             $new_object = new ilObjSCORM2004LearningModule($new_ref_id);
                         }
 
                         $title = $new_object->readObject();
                         $new_object->setLearningProgressSettingsAtUpload();
                     }
 
                     return null;
                 })
         );
     }

Here is the call graph for this function:

◆ init()

ilScormAiccImporter::init ( )

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

                           : void
     {
     }

◆ initResult()

ilScormAiccImporter::initResult ( )

private

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

References publishResult().

Referenced by __construct(), and importXmlRepresentation().

                                  : void
     {
         $this->publishResult($this->df->error('No XML parsed, yet'));
         $this->module_properties = [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ publishResult()

ilScormAiccImporter::publishResult ( \ILIAS\Data\Result $result )

private

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

References $result.

Referenced by importXmlRepresentation(), and initResult().

                                                               : \ILIAS\Data\Result
     {
         $this->result = $result;
         return $this->result;
     }

Here is the caller graph for this function:

◆ writeData()

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

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

                                                                              : void
     {
         $this->dataset->writeData($a_entity, $a_version, $a_id, $this->module_properties);
     }