Inheritance diagram for ilLearningSequenceImporter:

Collaboration diagram for ilLearningSequenceImporter:

Public Member Functions
	__construct ()

	init ()

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

	finalProcessing (ilImportMapping $a_mapping)

	afterContainerImportProcessing (ilImportMapping $mapping)

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)

Protected Member Functions
	updateRefId (ilImportMapping $mapping)

	buildLSItems (array $ls_data, ilImportMapping $mapping)

	buildItemConditions (array $ls_data, ilImportMapping $mapping)
	Creates lso_conditions + condition payload (lso_c_*) based on parsed XML. More...

	buildSettings (array $ls_settings, ilImportMapping $mapping)

	buildLPSettings (array $lp_settings, ilImportMapping $mapping)

	decodeImageData (string $data)

	getNewImagePath (string $type, string $path)

	writeToFileSystem ($data, string $path)

Protected Attributes
PageManagerInterface	$page_manager

ilObjUser	$user

ilRbacAdmin	$rbac_admin

ilLogger	$log

ilObjLearningSequence	$obj

array	$data

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 24 of file class.ilLearningSequenceImporter.php.

Constructor & Destructor Documentation

◆ __construct()

ilLearningSequenceImporter::__construct ( )

Reimplemented from ilXmlImporter.

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

    {
        global $DIC;
        parent::__construct();
        $this->page_manager = $DIC->copage()->internal()->domain()->page();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ afterContainerImportProcessing()

ilLearningSequenceImporter::afterContainerImportProcessing ( ilImportMapping $mapping )

Reimplemented from ilXmlImporter.

Definition at line 123 of file class.ilLearningSequenceImporter.php.

                                                                            : void
    {
        $this->updateRefId($mapping);
        $this->buildLSItems($this->data["item_data"], $mapping);
        $this->buildItemConditions($this->data["item_data"], $mapping);
        $this->buildLPSettings($this->data["lp_settings"], $mapping);
 
        $roles = $this->obj->getLSRoles();
        $roles->addLSMember(
            $this->user->getId(),
            $roles->getDefaultAdminRole()
        );
    }

References buildItemConditions(), buildLPSettings(), buildLSItems(), updateRefId(), and ILIAS\Repository\user().

Here is the call graph for this function:

◆ buildItemConditions()

ilLearningSequenceImporter::buildItemConditions	(	array	$ls_data,
		ilImportMapping	$mapping
	)

protected

Creates lso_conditions + condition payload (lso_c_*) based on parsed XML.

Expected $ls_data format (per item): [ 'ref_id' => <old_ref_id>, 'conditions' => [ [ 'type_id' => <int|string>, // maps to lso_condition_types.type_id 'subtype' => <string|null>, 'data' => <payload array exported by AbstractCondition::export()> ], ... ] ]

Definition at line 194 of file class.ilLearningSequenceImporter.php.

                                                                                    : void
    {
        $factory = $this->obj->getDI()["conditions.factory"];
        $handler = $this->obj->getDI()["conditions.handler"];
 
        $new_lso_ref_id = $this->obj->getRefId();
 
        foreach ($ls_data as $item_data) {
            $old_item_ref_id = (string) ($item_data['ref_id'] ?? '');
            if ($old_item_ref_id === '') {
                continue;
            }
 
            $new_item_ref_id = $mapping->getMapping('components/ILIAS/Container', 'refs', $old_item_ref_id);
            if ($new_item_ref_id === null) {
                continue;
            }
            $new_item_ref_id = (int) $new_item_ref_id;
 
            $conditions = is_array($item_data['conditions'] ?? null) ? $item_data['conditions'] : [];
            if ($conditions === []) {
                continue;
            }
 
            // Avoid duplicates when re-importing/updating: clear existing conditions for this item.
            $handler->deleteConditionsByRefId($new_lso_ref_id, $new_item_ref_id);
 
            foreach ($conditions as $cond) {
                $created = false;
 
                if (!is_array($cond)) {
                    continue;
                }
 
                $type_id_raw = $cond['type'] ?? null;
                $subtype = isset($cond['subtype']) && is_string($cond['subtype']) && $cond['subtype'] !== ''
                    ? $cond['subtype']
                    : null;
 
                $payload = is_array($cond['data'] ?? null) ? $cond['data'] : [];
 
                try {
                    $condition = $factory->getConditionInstanceByName($type_id_raw);
                    $condition->setLsoRefId($new_lso_ref_id);
                    $condition->setObjRefId($new_item_ref_id);
                    if ($subtype !== null && $condition instanceof SubtypeAwareInterface) {
                        $condition->setSubtype($subtype);
                    }
 
                    $condition->create(true);
                    $created = true;
 
                    $new_condition_id = (int) $condition->getConditionId();
                    if ($new_condition_id > 0) {
                        $ref_mappings = array_map(
                            'intval',
                            $mapping->getAllMappings()['components/ILIAS/Container']['refs'] ?? []
                        );
                        $condition->setImportMapping($ref_mappings);
                        $condition->import($payload, $new_condition_id);
                    }
                } catch (\Throwable $e) {
                    if ($created && isset($condition)) {
                        $condition->delete();
                    }
 
                    $this->log->warning(__METHOD__ . ': condition import failed: ' . $e->getMessage());
                    continue;
                }
            }
        }
    }

References Vendor\Package\$e, $handler, ilImportMapping\getAllMappings(), ilImportMapping\getMapping(), and ILIAS\Repository\int().

Referenced by afterContainerImportProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLPSettings()

ilLearningSequenceImporter::buildLPSettings	(	array	$lp_settings,
		ilImportMapping	$mapping
	)

protected

Definition at line 291 of file class.ilLearningSequenceImporter.php.

                                                                                    : void
    {
        $collection = ilLPCollection::getInstanceByMode($this->obj->getId(), (int) $lp_settings["lp_mode"]);
 
        $new_ref_ids = [];
        foreach ($lp_settings["lp_item_ref_ids"] as $old_ref_id) {
            $new_ref_id = $mapping->getMapping("components/ILIAS/Container", "refs", (string) $old_ref_id);
            if ($new_ref_id === null) {
                continue;
            }
            $new_ref_ids[] = (int) $new_ref_id;
        }
 
        if (!is_null($collection)) {
            $collection->activateEntries($new_ref_ids);
        }
 
        $settings = new ilLPObjSettings($this->obj->getId());
        $settings->setMode((int) $lp_settings["lp_mode"]);
        $settings->insert();
    }

References $settings, ilLPCollection\getInstanceByMode(), ilImportMapping\getMapping(), and ILIAS\Repository\int().

Referenced by afterContainerImportProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildLSItems()

ilLearningSequenceImporter::buildLSItems	(	array	$ls_data,
		ilImportMapping	$mapping
	)

protected

Definition at line 145 of file class.ilLearningSequenceImporter.php.

                                                                             : void
    {
        $mapped = [];
        foreach ($ls_data as $data) {
            $old_ref_id = $data["ref_id"];
            $new_ref_id = $mapping->getMapping("components/ILIAS/Container", "refs", $old_ref_id);
            $mapped[$new_ref_id] = $data;
        }
 
        $ls_items = $this->obj->getLSItems();
        $updated = [];
        foreach ($ls_items as $item) {
            $item_ref_id = $item->getRefId();
            if (array_key_exists($item_ref_id, $mapped)) {
                $item_data = $mapped[$item_ref_id];
                $post_condition = new ilLSPostCondition(
                    $item_ref_id,
                    $item_data["condition_type"],
                    $item_data["condition_value"]
                );
                $item = $item->withPostCondition($post_condition);
                if (isset($item_data["position"])) {
                    $item = $item->withOrderNumber((int) $item_data["position"]);
                }
                $updated[] = $item;
            }
        }
 
        if ($updated) {
            $this->obj->storeLSItems($updated);
        }
    }

References $data, and ilImportMapping\getMapping().

Referenced by afterContainerImportProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildSettings()

ilLearningSequenceImporter::buildSettings	(	array	$ls_settings,
		ilImportMapping	$mapping
	)

protected

Definition at line 267 of file class.ilLearningSequenceImporter.php.

                                                                                  : void
    {
        $settings = $this->obj->getLSSettings();
        $settings = $settings
            ->withMembersGallery($ls_settings["members_gallery"] === 'true' ? true : false)
        ;
        $settings = $settings->withMode((int) $ls_settings["mode"]);
        $this->obj->updateSettings($settings);
 
        // boundaries
        $start_ref_id = (string) ($ls_settings["start_ref_id"] ?? '');
        $end_ref_id = (string) ($ls_settings["end_ref_id"] ?? '');
        $new_start_ref_id = $mapping->getMapping("components/ILIAS/Container", "refs", $start_ref_id);
        $new_end_ref_id = $mapping->getMapping("components/ILIAS/Container", "refs", $end_ref_id);
 
        $new_start_ref_id = (!empty($new_start_ref_id)) ? (int) $new_start_ref_id : 0;
        $new_end_ref_id = (!empty($new_end_ref_id)) ? (int) $new_end_ref_id : 0;
        if ($new_start_ref_id > 0 || $new_end_ref_id > 0) {
            $boundaries = $this->obj->getDI()["db.boundaries"];
            $boundaries->setStartRefId($this->obj->getId(), $new_start_ref_id);
            $boundaries->setEndRefId($this->obj->getId(), $new_end_ref_id);
        }
    }

References $settings, and ilImportMapping\getMapping().

Referenced by finalProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ decodeImageData()

ilLearningSequenceImporter::decodeImageData ( string $data )

protected

Definition at line 313 of file class.ilLearningSequenceImporter.php.

                                                    : string
    {
        return base64_decode($data);
    }

References $data.

◆ finalProcessing()

ilLearningSequenceImporter::finalProcessing ( ilImportMapping $a_mapping )

Reimplemented from ilXmlImporter.

Definition at line 105 of file class.ilLearningSequenceImporter.php.

                                                               : void
    {
        $this->buildSettings($this->data["settings"], $a_mapping);
        $this->obj->update();
 
        // pages
        $page_map = $a_mapping->getMappingsOfEntity('Services/COPage', 'pg');
        foreach ($page_map as $old_pg_id => $new_pg_id) {
            $parts = explode(':', $old_pg_id);
            $pg_type = $parts[0];
            $old_obj_id = $parts[1];
            $parts = explode(':', $new_pg_id);
            $new_pg_id = array_pop($parts);
            $new_obj_id = $this->obj->getId();
            $this->page_manager->writeParentId($pg_type, (int) $new_pg_id, (int) $new_obj_id);
        }
    }

References buildSettings(), and ilImportMapping\getMappingsOfEntity().

Here is the call graph for this function:

◆ getNewImagePath()

ilLearningSequenceImporter::getNewImagePath	(	string	$type,
		string	$path
	)

protected

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

                                                                  : string
    {
        $fs = $this->obj->getDI()['db.filesystem'];
        return $fs->getStoragePathFor(
            $type,
            $this->obj->getId(),
            $fs->getSuffix($path)
        );
    }

◆ importXmlRepresentation()

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

Reimplemented from ilXmlImporter.

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

                                                                                                                      : void
    {
        if ($new_id = $a_mapping->getMapping("components/ILIAS/Container", "objs", $a_id)) {
            $obj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
            if (!$obj instanceof ilObjLearningSequence) {
                throw new ilImportException('Learning sequence ' . $new_id . ' to import into not found.');
            }
            $this->obj = $obj;
        } else {
            $this->obj = new ilObjLearningSequence();
            $this->obj->create();
        }
 
        $parser = new ilLearningSequenceXMLParser($this->obj, $a_xml);
        $this->data = $parser->start();
 
        $a_mapping->addMapping("components/ILIAS/LearningSequence", "lso", $a_id, (string) $this->obj->getId());
        $a_mapping->addMapping(
            'Services/COPage',
            'pg',
            LSOPageType::INTRO->value . ':' . $a_id,
            LSOPageType::INTRO->value . ':' . (string) $this->obj->getId()
        );
        $a_mapping->addMapping(
            'Services/COPage',
            'pg',
            LSOPageType::EXTRO->value . ':' . $a_id,
            LSOPageType::EXTRO->value . ':' . (string) $this->obj->getId()
        );
 
        $a_mapping->addMapping(
            'components/ILIAS/MetaData',
            'md',
            $a_id . ':0:lso',
            (string) $this->obj->getId() . ':0:lso'
        );
 
        $a_mapping->addMapping(
            "components/ILIAS/Taxonomy",
            "tax_item",
            "lso:obj:" . $a_id,
            (string) $this->obj->getId()
        );
        $a_mapping->addMapping(
            "components/ILIAS/Taxonomy",
            "tax_item_obj_id",
            "lso:obj:" . $a_id,
            (string) $this->obj->getId()
        );
        $a_mapping->addMapping(
            "components/ILIAS/Tracking",
            "obj",
            (string) $a_id,
            (string) $this->obj->getId()
        );
    }

References $obj, ILIAS\Scripts\PHPStan\$parser, ilImportMapping\addMapping(), EXTRO, ilObjectFactory\getInstanceByObjId(), and ilImportMapping\getMapping().

Here is the call graph for this function:

◆ init()

ilLearningSequenceImporter::init ( )

Reimplemented from ilXmlImporter.

Definition at line 40 of file class.ilLearningSequenceImporter.php.

                          : void
    {
        global $DIC;
        $this->user = $DIC["ilUser"];
        $this->rbac_admin = $DIC["rbacadmin"];
        $this->log = $DIC["ilLoggerFactory"]->getComponentLogger('lso');
    }

References $DIC, and ILIAS\Repository\user().

Here is the call graph for this function:

◆ updateRefId()

ilLearningSequenceImporter::updateRefId ( ilImportMapping $mapping )

protected

Definition at line 137 of file class.ilLearningSequenceImporter.php.

                                                            : void
    {
        $old_ref_id = $this->data["object"]["ref_id"];
        $new_ref_id = $mapping->getMapping("components/ILIAS/Container", "refs", $old_ref_id);
 
        $this->obj->setRefId((int) $new_ref_id);
    }

References ilImportMapping\getMapping().

Referenced by afterContainerImportProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeToFileSystem()

ilLearningSequenceImporter::writeToFileSystem	(		$data,
		string	$path
	)

protected

Definition at line 328 of file class.ilLearningSequenceImporter.php.

                                                             : void
    {
        file_put_contents($path, $data);
    }

References $data.

Field Documentation

◆ $data

array ilLearningSequenceImporter::$data

protected

Definition at line 31 of file class.ilLearningSequenceImporter.php.

Referenced by buildLSItems(), decodeImageData(), and writeToFileSystem().

◆ $log

ilLogger ilLearningSequenceImporter::$log

protected

Definition at line 29 of file class.ilLearningSequenceImporter.php.

◆ $obj

ilObjLearningSequence ilLearningSequenceImporter::$obj

protected

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

Referenced by importXmlRepresentation().

◆ $page_manager

PageManagerInterface ilLearningSequenceImporter::$page_manager

protected

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

◆ $rbac_admin

ilRbacAdmin ilLearningSequenceImporter::$rbac_admin

protected

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

◆ $user

ilObjUser ilLearningSequenceImporter::$user

protected

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

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

components/ILIAS/LearningSequence/classes/class.ilLearningSequenceImporter.php

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ afterContainerImportProcessing()

◆ buildItemConditions()

◆ buildLPSettings()

◆ buildLSItems()

◆ buildSettings()

◆ decodeImageData()

◆ finalProcessing()

◆ getNewImagePath()

◆ importXmlRepresentation()

◆ init()

◆ updateRefId()

◆ writeToFileSystem()

Field Documentation

◆ $data

◆ $log

◆ $obj

◆ $page_manager

◆ $rbac_admin

◆ $user