ilLearningSequenceImporter Class Reference

Inheritance diagram for ilLearningSequenceImporter:

Collaboration diagram for ilLearningSequenceImporter:

Public Member Functions
	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)
	buildSettings (array $ls_settings)
	buildLPSettings (array $lp_settings, ilImportMapping $mapping)
	decodeImageData (string $data)
	getNewImagePath (string $type, string $path)
	writeToFileSystem ($data, string $path)

Protected Attributes
ilObjUser	$user
ilRbacAdmin	$rbac_admin
ilLogger	$log
ilObject	$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 21 of file class.ilLearningSequenceImporter.php.

Member Function Documentation

afterContainerImportProcessing()

ilLearningSequenceImporter::afterContainerImportProcessing

(

ilImportMapping

$mapping

)

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

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

                                                                            : void
    {
        $this->updateRefId($mapping);
        $this->buildLSItems($this->data["item_data"], $mapping);
        $this->buildLPSettings($this->data["lp_settings"], $mapping);

        $roles = $this->obj->getLSRoles();
        $roles->addLSMember(
            $this->user->getId(),
            $roles->getDefaultAdminRole()
        );
    }

Here is the call graph for this function:

buildLPSettings()

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

protected

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

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

Referenced by afterContainerImportProcessing().

                                                                                    : void
    {
        $collection = ilLPCollection::getInstanceByMode($this->obj->getId(), (int) $lp_settings["lp_mode"]);

        $new_ref_ids = array_map(function ($old_ref_id) use ($mapping) {
            return $mapping->getMapping("Services/Container", "refs", $old_ref_id);
        }, $lp_settings["lp_item_ref_ids"]);

        if (!is_null($collection)) {
            $collection->activateEntries($new_ref_ids);
        }

        $settings = new ilLPObjSettings($this->obj->getId());
        $settings->setMode((int) $lp_settings["lp_mode"]);
        $settings->insert();
    }

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

References ilImportMapping\getMapping().

Referenced by afterContainerImportProcessing().

                                                                             : void
    {
        $ls_items = array();
        foreach ($ls_data as $data) {
            $old_ref_id = $data["id"];
            $new_ref_id = $mapping->getMapping("Services/Container", "refs", $old_ref_id);

            $ls_item_pc_value = null;
            if (key_exists("ls_item_pc_value", $data)) {
                $ls_item_pc_value = $data["ls_item_pc_value"];
            }

            $post_condition = new ilLSPostCondition(
                (int) $new_ref_id,
                $data["ls_item_pc_condition_type"],
                $ls_item_pc_value
            );

            $ls_items[] = new LSItem(
                $data["ls_item_type"] ?? "",
                $data["ls_item_title"] ?? "",
                $data["ls_item_description"] ?? "",
                $data["ls_item_icon_path"] ?? "",
                (bool) $data["ls_item_is_online"],
                (int) $data["ls_item_order_number"],
                $post_condition,
                (int) $new_ref_id
            );
        }

        $this->obj->storeLSItems($ls_items);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildSettings()

ilLearningSequenceImporter::buildSettings ( array  $ls_settings )

protected

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

References $path, ILIAS\LTI\ToolProvider\$settings, decodeImageData(), getNewImagePath(), ilLearningSequenceFilesystem\IMG_ABSTRACT, ilLearningSequenceFilesystem\IMG_EXTRO, and writeToFileSystem().

Referenced by finalProcessing().

                                                        : void
    {
        $settings = $this->obj->getLSSettings();
        $settings = $settings
            ->withAbstract($ls_settings["abstract"])
            ->withExtro($ls_settings["extro"])
            ->withMembersGallery((bool) $ls_settings["members_gallery"])
        ;

        if ($ls_settings["abstract_img"] != "") {
            $path = $this->getNewImagePath(ilLearningSequenceFilesystem::IMG_ABSTRACT, $ls_settings['abstract_img']);
            $abstract_img_data = $this->decodeImageData($ls_settings["abstract_img_data"]);
            $this->writeToFileSystem($abstract_img_data, $path);
            $settings = $settings
                ->withAbstractImage($path)
            ;
        }

        if ($ls_settings["extro_img"] != "") {
            $path = $this->getNewImagePath(ilLearningSequenceFilesystem::IMG_EXTRO, $ls_settings['extro_img']);
            $extro_img_data = $this->decodeImageData($ls_settings["extro_img_data"]);
            $this->writeToFileSystem($extro_img_data, $path);
            $settings = $settings
                ->withExtroImage($path)
            ;
        }

        $this->obj->updateSettings($settings);
    }

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

Referenced by buildSettings().

                                                    : string
    {
        return base64_decode($data);
    }

Here is the caller graph for this function:

finalProcessing()

ilLearningSequenceImporter::finalProcessing

(

ilImportMapping

$a_mapping

)

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

References buildSettings().

                                                               : void
    {
        $this->buildSettings($this->data["settings"]);

        $this->obj->update();
    }

Here is the call graph for this function:

getNewImagePath()

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

protected

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

Referenced by buildSettings().

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

Here is the caller graph for this function:

importXmlRepresentation()

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

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

References ilImportMapping\addMapping(), ilObjectFactory\getInstanceByObjId(), and ilImportMapping\getMapping().

                                                                                                                      : void
    {
        if ($new_id = $a_mapping->getMapping("Services/Container", "objs", $a_id)) {
            $this->obj = ilObjectFactory::getInstanceByObjId((int) $new_id, false);
        } else {
            $this->obj = new ilObjLearningSequence();
            $this->obj->create();
        }

        $parser = new ilLearningSequenceXMLParser($this->obj, $a_xml);
        $this->data = $parser->start();

        $a_mapping->addMapping("Modules/LearningSequence", "lso", $a_id, (string) $this->obj->getId());
    }

Here is the call graph for this function:

init()

ilLearningSequenceImporter::init

(

)

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

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

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

Here is the call graph for this function:

updateRefId()

ilLearningSequenceImporter::updateRefId ( ilImportMapping  $mapping )

protected

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

References ilImportMapping\getMapping().

Referenced by afterContainerImportProcessing().

                                                            : void
    {
        $old_ref_id = $this->data["object"]["ref_id"];
        $new_ref_id = $mapping->getMapping("Services/Container", "refs", $old_ref_id);

        $this->obj->setRefId((int) $new_ref_id);
    }

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

Referenced by buildSettings().

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

Here is the caller graph for this function:

Field Documentation

$data

array ilLearningSequenceImporter::$data

protected

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

$log

ilLogger ilLearningSequenceImporter::$log

protected

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

$obj

ilObject ilLearningSequenceImporter::$obj

protected

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

$rbac_admin

ilRbacAdmin ilLearningSequenceImporter::$rbac_admin

protected

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

$user

ilObjUser ilLearningSequenceImporter::$user

protected

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

---

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

• Modules/LearningSequence/classes/class.ilLearningSequenceImporter.php