ilLearningSequenceImporter Class Reference

Inheritance diagram for ilLearningSequenceImporter:

Collaboration diagram for ilLearningSequenceImporter:

Public Member Functions
	init ()
	Init. More...
	importXmlRepresentation ($entity, $id, $xml, $mapping)
	Import xml representation. More...
	finalProcessing ($mapping)
	Final processing. More...
	afterContainerImportProcessing (ilImportMapping $mapping)
	Called after all container objects have been implemented. 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...

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
	$obj
	$data
Protected Attributes inherited from ilXmlImporter
	$skip_entities = array()
	$imp

Detailed Description

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

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

Member Function Documentation

afterContainerImportProcessing()

ilLearningSequenceImporter::afterContainerImportProcessing

(

ilImportMapping

$mapping

)

Called after all container objects have been implemented.

Parameters

ilImportMapping

$mapping

Reimplemented from ilXmlImporter.

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

    {
        $this->updateRefId($mapping);
        $this->buildLSItems($this->data["item_data"], $mapping);
        $this->buildLPSettings($this->data["lp_settings"], $mapping);
 
        $this->obj->addMember((int) $this->user->getId(), $this->obj->getDefaultAdminRole());
    }

References buildLPSettings(), buildLSItems(), data, updateRefId(), and user().

Here is the call graph for this function:

buildLPSettings()

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

protected

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

    {
        $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();
    }

References ilLPCollection\getInstanceByMode(), and ilImportMapping\getMapping().

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

    {
        $ls_items = array();
        foreach ($ls_data as $data) {
            $old_ref_id = $data["id"];
            $new_ref_id = $mapping->getMapping("Services/Container", "refs", $old_ref_id);
 
            $post_condition = new ilLSPostCondition(
                (int) $new_ref_id,
                $data["ls_item_pc_condition_type"],
                $data["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);
    }

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 )

protected

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

    {
        $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);
    }

References $path, decodeImageData(), getNewImagePath(), ilLearningSequenceFilesystem\IMG_ABSTRACT, ilLearningSequenceFilesystem\IMG_EXTRO, and writeToFileSystem().

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

    {
        return base64_decode($data);
    }

References $data.

Referenced by buildSettings().

Here is the caller graph for this function:

finalProcessing()

ilLearningSequenceImporter::finalProcessing

(

$a_mapping

)

Final processing.

Parameters

array

mapping array

Reimplemented from ilXmlImporter.

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

    {
        $this->buildSettings($this->data["settings"]);
 
        $this->obj->update();
    }

References buildSettings(), and data.

Here is the call graph for this function:

getNewImagePath()

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

protected

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

                                                                   : string
    {
        $fs = $this->obj->getLSFileSystem();
        return $fs->getStoragePathFor(
            $type,
            (int) $this->obj->getId(),
            $fs->getSuffix($path)
        );
    }

References $path, and $type.

Referenced by buildSettings().

Here is the caller graph for this function:

importXmlRepresentation()

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

Import xml representation.

Parameters

string	entity
string	target release
string	id

Returns

string xml string

Reimplemented from ilXmlImporter.

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

    {
        if ($new_id = $mapping->getMapping("Services/Container", "objs", $id)) {
            $this->obj = ilObjectFactory::getInstanceByObjId($new_id, false);
        } else {
            $this->obj = new ilObjLearningSequence();
            $this->obj->create();
        }
 
        $parser = new ilLearningSequenceXMLParser($this->obj, $xml);
        $this->data = $parser->start();
 
        $mapping->addMapping("Modules/LearningSequence", "lso", $id, $this->obj->getId());
    }

References $id, $parser, $xml, data, and ilObjectFactory\getInstanceByObjId().

Here is the call graph for this function:

init()

ilLearningSequenceImporter::init

(

)

Init.

Reimplemented from ilXmlImporter.

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

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

References $DIC, and user().

Here is the call graph for this function:

updateRefId()

ilLearningSequenceImporter::updateRefId ( ilImportMapping  $mapping )

protected

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

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

References data, and 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 157 of file class.ilLearningSequenceImporter.php.

    {
        file_put_contents($path, $data);
    }

References $data, and $path.

Referenced by buildSettings().

Here is the caller graph for this function:

Field Documentation

$data

ilLearningSequenceImporter::$data

protected

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

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

$obj

ilLearningSequenceImporter::$obj

protected

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

---

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

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