ilCourseImporter Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilCourseImporter:

Collaboration diagram for ilCourseImporter:

Public Member Functions
	__construct ()
	init ()
	importXmlRepresentation (string $a_entity, string $a_id, string $a_xml, ilImportMapping $a_mapping)
	@noinspection PhpFieldAssignmentTypeMismatchInspection More...
	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)

Data Fields
const	ENTITY_MAIN = 'crs'
const	ENTITY_OBJECTIVE = 'objectives'

Protected Member Functions
	addFinalProcessingInfo ($a_course, $a_entity, $a_xml)

Protected Attributes
ilLogger	$logger
Protected Attributes inherited from ilXmlImporter
array	$skip_entities = array()
ilImport	$imp
string	$install_id
string	$install_url
string	$schema_version
string	$import_directory

Private Attributes
ilObjCourse	$course = null
array	$final_processing_info = []

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilCourseImporter::__construct

(

)

Reimplemented from ilXmlImporter.

Definition at line 34 of file class.ilCourseImporter.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->crs();
    }

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

Here is the call graph for this function:

Member Function Documentation

addFinalProcessingInfo()

ilCourseImporter::addFinalProcessingInfo (   $a_course,   $a_entity,   $a_xml  )

protected

Definition at line 100 of file class.ilCourseImporter.php.

                                                                           : void
    {
        $this->final_processing_info[] = array(
            'course' => $a_course,
            'entity' => $a_entity,
            'xml' => $a_xml
        );
    }

afterContainerImportProcessing()

ilCourseImporter::afterContainerImportProcessing

(

\ilImportMapping

$mapping

)

Definition at line 89 of file class.ilCourseImporter.php.

                                                                             : void
    {
        foreach ($this->final_processing_info as $info) {
            // import learning objectives
            $parser = new ilLOXmlParser($info['course'], $info['xml']);
            $parser->setMapping($mapping);
            $parser->parseObjectDependencies();
            return;
        }
    }

importXmlRepresentation()

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

@noinspection PhpFieldAssignmentTypeMismatchInspection

Reimplemented from ilXmlImporter.

Definition at line 46 of file class.ilCourseImporter.php.

     : void {
        if ($new_id = $a_mapping->getMapping('Services/Container', 'objs', $a_id)) {
            $refs = ilObject::_getAllReferences((int) $new_id);
            $this->course = ilObjectFactory::getInstanceByRefId((int) end($refs), false);
        } // Mapping for containers without subitems
        elseif ($new_id = $a_mapping->getMapping('Services/Container', 'refs', '0')) {
            $this->course = ilObjectFactory::getInstanceByRefId((int) $new_id, false);
        } elseif (!$this->course instanceof ilObjCourse) {
            $this->course = new ilObjCourse();
            $this->course->create(true);
        }
 
        if ($a_entity == self::ENTITY_OBJECTIVE) {
            $this->addFinalProcessingInfo($this->course, $a_entity, $a_xml);
 
            // import learning objectives => without materials and fixed questions.
            // These are handled in afterContainerImportProcessing
            $parser = new ilLOXmlParser($this->course, $a_xml);
            $parser->setMapping($a_mapping);
            $parser->parse();
            return;
        }
 
        try {
            $parser = new ilCourseXMLParser($this->course);
            $parser->setXMLContent($a_xml);
            $parser->startParsing();
 
            // set course offline
            $this->course->setOfflineStatus(true);
            $this->course->update();
 
            $a_mapping->addMapping('Modules/Course', 'crs', $a_id, (string) $this->course->getId());
        } catch (ilSaxParserException|Exception $e) {
            $this->logger->error('Parsing failed with message, "' . $e->getMessage() . '".');
        }
    }

References ilObject\_getAllReferences(), and ilObjectFactory\getInstanceByRefId().

Here is the call graph for this function:

init()

ilCourseImporter::init

(

)

Reimplemented from ilXmlImporter.

Definition at line 41 of file class.ilCourseImporter.php.

                          : void
    {
    }

Field Documentation

$course

ilObjCourse ilCourseImporter::$course = null

private

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

$final_processing_info

array ilCourseImporter::$final_processing_info = []

private

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

$logger

ilLogger ilCourseImporter::$logger

protected

Definition at line 32 of file class.ilCourseImporter.php.

ENTITY_MAIN

const ilCourseImporter::ENTITY_MAIN = 'crs'

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

ENTITY_OBJECTIVE

const ilCourseImporter::ENTITY_OBJECTIVE = 'objectives'

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

---

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

• Modules/Course/classes/class.ilCourseImporter.php