Collaboration diagram for ilLOXmlParser:

Public Member Functions
	__construct (ilObjCourse $course, $a_xml)
	Constructor. More...

	setMapping (ilImportMapping $mapping)
	Set import mapping. More...

	getMapping ()
	Get import mapping. More...

	parse ()
	Parse xml. More...

	parseObjectDependencies ()
	Parse object dependencies (assigned strucure objects, page objects, fixed questions) More...

Data Fields
const	TYPE_TST_PO = 1

const	TYPE_TST_ALL = 2

const	TYPE_TST_RND = 3

Protected Member Functions
	getCourse ()
	Get course. More...

	parseSettings (SimpleXMLElement $root)

	parseObjectives (SimpleXMLElement $root)
	Parse objective. More...

	parseMaterials (SimpleXMLElement $obj, $a_objective_id)
	Parse assigned materials. More...

	parseTests (SimpleXMLElement $obj, $a_objective_id)
	Parse tests of objective. More...

	getMappingInfoForItem ($a_ref_id)
	Get mapping info. More...

	getMappingInfoForItemObject ($a_obj_id)
	Get obj_id mapping. More...

	getMappingForQuestion ($qid)

	getMappingForQpls ($a_id)

	parseXmlErrors ()
	Parse xml errors from libxml_get_errors. More...

Private Attributes
	$xml = ''

	$course = null

	$mapping = null

Detailed Description

Class ilLOXmlWriter.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 12 of file class.ilLOXmlParser.php.

Constructor & Destructor Documentation

◆ __construct()

ilLOXmlParser::__construct	(	ilObjCourse	$course,
			$a_xml
	)

Constructor.

Parameters

ilObjCourse	$course
type	$a_xml

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

References $course.

     {
         $this->course = $course;
         $this->xml = $a_xml;
     }

Member Function Documentation

◆ getCourse()

ilLOXmlParser::getCourse ( )

protected

Get course.

Returns: ilObjCourse

Definition at line 56 of file class.ilLOXmlParser.php.

References $course.

Referenced by parseObjectives(), parseSettings(), and parseTests().

     {
         return $this->course;
     }

Here is the caller graph for this function:

◆ getMapping()

ilLOXmlParser::getMapping ( )

Get import mapping.

Returns: ilImportMapping

Definition at line 47 of file class.ilLOXmlParser.php.

References $mapping.

Referenced by getMappingForQpls(), getMappingForQuestion(), getMappingInfoForItem(), getMappingInfoForItemObject(), parseMaterials(), parseObjectDependencies(), and parseObjectives().

     {
         return $this->mapping;
     }

Here is the caller graph for this function:

◆ getMappingForQpls()

ilLOXmlParser::getMappingForQpls ( $a_id )

protected

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

References getMapping().

Referenced by parseTests().

     {
         $new_id = $this->getMapping()->getMapping('Modules/Test', 'rnd_src_pool_def', $a_id);
         if ($new_id) {
             return $new_id;
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMappingForQuestion()

ilLOXmlParser::getMappingForQuestion ( $qid )

protected

Definition at line 306 of file class.ilLOXmlParser.php.

References $GLOBALS, and getMapping().

Referenced by parseTests().

     {
         $new_qid = $this->getMapping()->getMapping('Modules/Test', 'quest', $qid);
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Found new question_id: ' . $new_qid . ' for ' . $qid);
         return $new_qid;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMappingInfoForItem()

ilLOXmlParser::getMappingInfoForItem ( $a_ref_id )

protected

Get mapping info.

Parameters

type	$a_ref_id
type	$a_obj_id

Returns: int ref id of mapped item

Definition at line 287 of file class.ilLOXmlParser.php.

References $GLOBALS, and getMapping().

Referenced by parseMaterials(), parseSettings(), and parseTests().

     {
         $new_ref_id = $this->getMapping()->getMapping('Services/Container', 'refs', $a_ref_id);
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Found new ref_id: ' . $new_ref_id . ' for ' . $a_ref_id);
         return (int) $new_ref_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMappingInfoForItemObject()

ilLOXmlParser::getMappingInfoForItemObject ( $a_obj_id )

protected

Get obj_id mapping.

Parameters

int $a_obj_id

Returns: int

Definition at line 299 of file class.ilLOXmlParser.php.

References $GLOBALS, and getMapping().

Referenced by parseTests().

     {
         $new_obj_id = $this->getMapping()->getMapping('Services/Container', 'objs', $a_obj_id);
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Found new ref_id: ' . $new_obj_id . ' for ' . $a_obj_id);
         return (int) $new_obj_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilLOXmlParser::parse ( )

Parse xml.

Definition at line 64 of file class.ilLOXmlParser.php.

References $GLOBALS, $root, parseObjectives(), parseSettings(), and parseXmlErrors().

     {
         libxml_use_internal_errors(true);
         $root = simplexml_load_string(trim($this->xml));
         if (!$root instanceof SimpleXMLElement) {
             $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': XML is: ' . $this->xml . (string) $root);
             $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Error parsing objective xml: ' . $this->parseXmlErrors());
             return false;
         }
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Handling element: ' . (string) $root->getName());
         $this->parseSettings($root);
         $this->parseObjectives($root);
     }

Here is the call graph for this function:

◆ parseMaterials()

ilLOXmlParser::parseMaterials	(	SimpleXMLElement	$obj,
			$a_objective_id
	)

protected

Parse assigned materials.

Parameters

SimpleXMLElement $obj

Definition at line 158 of file class.ilLOXmlParser.php.

References ilObject\_lookupObjId(), getMapping(), and getMappingInfoForItem().

Referenced by parseObjectDependencies().

     {
         foreach ($obj->Material as $mat) {
             $mat_ref_id = (string) $mat->attributes()->refId;
             
             $mapping_ref_id = $this->getMappingInfoForItem($mat_ref_id);
             if ($mapping_ref_id) {
                 include_once './Modules/Course/classes/class.ilCourseObjectiveMaterials.php';
                 $new_mat = new ilCourseObjectiveMaterials($a_objective_id);
                 $new_mat->setLMRefId($mapping_ref_id);
                 
                 $mat_type = (string) $mat->attributes()->type;
                 $obj_id = 0;
                 switch ($mat_type) {
                     case 'st':
                         $mapped_chapter = $this->getMapping()->getMapping(
                             'Modules/LearningModule',
                             'lm_tree',
                             (int) (string) $mat->attributes()->objId
                         );
                         if ($mapped_chapter) {
                             $obj_id = $mapped_chapter;
                         }
                         break;
                     
                     case 'pg':
                         $mapped_page = $this->getMapping()->getMapping(
                             'Modules/LearningModule',
                             'pg',
                             (int) (string) $mat->attributes()->objId
                         );
                         if ($mapped_page) {
                             $obj_id = $mapped_page;
                         }
                         break;
                         
                     default:
                         $obj_id = ilObject::_lookupObjId($mapping_ref_id);
                         break;
                 }
                 if ($obj_id) {
                     $new_mat->setLMObjId($obj_id);
                     $new_mat->setType((string) $mat->attributes()->type);
                     $new_id = $new_mat->add();
                     $new_mat->writePosition($new_id, (int) (string) $mat->attributes()->position);
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseObjectDependencies()

ilLOXmlParser::parseObjectDependencies ( )

Parse object dependencies (assigned strucure objects, page objects, fixed questions)

Definition at line 81 of file class.ilLOXmlParser.php.

References $GLOBALS, $root, getMapping(), parseMaterials(), parseTests(), and parseXmlErrors().

     {
         libxml_use_internal_errors(true);
         $root = simplexml_load_string(trim($this->xml));
         if (!$root instanceof SimpleXMLElement) {
             $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': XML is: ' . $this->xml . (string) $root);
             $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Error parsing objective xml: ' . $this->parseXmlErrors());
             return false;
         }
         
         foreach ($root->Objective as $obj) {
             $mapped_objective_id = $this->getMapping()->getMapping('Modules/Course', 'objectives', (string) $obj->attributes()->id);
             if ($mapped_objective_id) {
                 $this->parseMaterials($obj, $mapped_objective_id);
                 $this->parseTests($obj, $mapped_objective_id);
             }
         }
     }

Here is the call graph for this function:

◆ parseObjectives()

ilLOXmlParser::parseObjectives ( SimpleXMLElement $root )

protected

Parse objective.

Parameters

SimpleXMLElement $root

Definition at line 134 of file class.ilLOXmlParser.php.

References getCourse(), and getMapping().

Referenced by parse().

     {
         foreach ($root->Objective as $obj) {
             include_once './Modules/Course/classes/class.ilCourseObjective.php';
             $new_obj = new ilCourseObjective($this->getCourse());
             $new_obj->setActive((bool) (string) $obj->attributes()->online);
             $new_obj->setTitle((string) $obj->Title);
             $new_obj->setDescription((string) $obj->Description);
             $new_obj->setPosition((int) (string) $obj->attributes()->position);
             $new_objective_id = $new_obj->add();
             
             $this->getMapping()->addMapping('Modules/Course', 'objectives', (string) $obj->attributes()->id, $new_objective_id);
             $this->getMapping()->addMapping('Services/COPage', 'pg', 'lobj:' . (string) $obj->attributes()->id, 'lobj:' . $new_objective_id);
             
             // done after container import complete
             //$this->parseMaterials($obj,$new_objective_id);
             //$this->parseTests($obj, $new_objective_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseSettings()

ilLOXmlParser::parseSettings ( SimpleXMLElement $root )

protected

Parameters

SimpleXMLElement $root

Definition at line 104 of file class.ilLOXmlParser.php.

References $GLOBALS, getCourse(), ilLOSettings\getInstanceByObjId(), and getMappingInfoForItem().

Referenced by parse().

     {
         include_once './Modules/Course/classes/Objectives/class.ilLOSettings.php';
         $settings = ilLOSettings::getInstanceByObjId($this->getCourse()->getId());
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Handling element: ' . (string) $root->Settings->getName());
         foreach ($root->Settings as $set) {
             $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Handling element: ' . (string) $set->getName());
             $settings->setInitialTestType((int) (string) $set->attributes()->initialTestType);
             $settings->setInitialTestAsStart((bool) (string) $set->attributes()->initialTestStart);
             $settings->setQualifyingTestType((int) (string) $set->attributes()->qualifyingTestType);
             $settings->setQualifyingTestAsStart((bool) (string) $set->attributes()->qualifyingTestStart);
             $settings->resetResults((bool) (string) $set->attributes()->resetResults);
             $settings->setPassedObjectiveMode((int) (string) $set->attributes()->passedObjectivesMode);
             
             // itest
             $itest = (int) $this->getMappingInfoForItem((int) (string) $set->attributes()->iTest);
             $settings->setInitialTest($itest);
             
             // qtest
             $qtest = (int) $this->getMappingInfoForItem((int) (string) $set->attributes()->qTest);
             $settings->setQualifiedTest($qtest);
             
             $settings->update();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseTests()

ilLOXmlParser::parseTests	(	SimpleXMLElement	$obj,
			$a_objective_id
	)

protected

Parse tests of objective.

Parameters

SimpleXMLElement	$obj
type	$a_objective_id

Definition at line 213 of file class.ilLOXmlParser.php.

References $GLOBALS, $type, ilObject\_lookupObjId(), getCourse(), getMappingForQpls(), getMappingForQuestion(), getMappingInfoForItem(), and getMappingInfoForItemObject().

Referenced by parseObjectDependencies().

     {
         $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Parsing ' . (string) $obj->getName());
         
         foreach ($obj->Test as $tst) {
             $type = (int) (string) $tst->attributes()->type;
 
 
             if ($type == self::TYPE_TST_PO) {
                 $tst_ref_id = (string) $tst->attributes()->refId;
                 $mapping_ref_id = $this->getMappingInfoForItem($tst_ref_id);
                 $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': Found test ref id ' . (string) $tst_ref_id);
                 if (!$mapping_ref_id) {
                     continue;
                 }
                 include_once './Modules/Course/classes/Objectives/class.ilLOTestAssignment.php';
                 $assignment = new ilLOTestAssignment();
                 $assignment->setContainerId($this->getCourse()->getId());
                 $assignment->setTestRefId($mapping_ref_id);
                 $assignment->setObjectiveId($a_objective_id);
                 $assignment->setAssignmentType((int) (string) $tst->attributes()->testType);
                 $assignment->save();
             } elseif ($type == self::TYPE_TST_RND) {
                 $tst_obj_id = (int) (string) $tst->attributes()->objId;
                 $mapping_id = $this->getMappingInfoForItemObject($tst_obj_id);
                 if (!$mapping_id) {
                     continue;
                 }
                 
                 $new_qpl_id = $this->getMappingForQpls((int) (string) $tst->attributes()->poolId);
                 if (!$new_qpl_id) {
                     continue;
                 }
                 
                 $rnd = new ilLORandomTestQuestionPools(
                     $this->getCourse()->getId(),
                     $a_objective_id,
                     (int) (string) $tst->attributes()->testType,
                     (string) $new_qpl_id
                 );
                 $rnd->setTestId($mapping_id);
                 $rnd->setLimit((string) $tst->attributes()->limit);
                 $rnd->create();
             } else {
                 $tst_ref_id = (string) $tst->attributes()->refId;
                 $mapping_ref_id = $this->getMappingInfoForItem($tst_ref_id);
                 if (!$mapping_ref_id) {
                     continue;
                 }
                 include_once './Modules/Course/classes/class.ilCourseObjectiveQuestion.php';
                 $quest = new ilCourseObjectiveQuestion($a_objective_id);
                 $quest->setTestRefId($mapping_ref_id);
                 $quest->setTestObjId(ilObject::_lookupObjId($mapping_ref_id));
                 $quest->setTestStatus((string) $tst->attributes()->testType);
                 $quest->setTestSuggestedLimit((string) $tst->attributes()->limit);
                 
                 foreach ($tst->Question as $qst) {
                     $qid = (string) $qst->attributes()->id;
                     $mapping_qid = $this->getMappingForQuestion($qid);
                     if ($mapping_qid) {
                         $quest->setQuestionId($mapping_qid);
                         $quest->add();
                     }
                 }
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseXmlErrors()

ilLOXmlParser::parseXmlErrors ( )

protected

Parse xml errors from libxml_get_errors.

Returns: string

Definition at line 334 of file class.ilLOXmlParser.php.

References $errors.

Referenced by parse(), and parseObjectDependencies().

     {
         $errors = '';
         foreach (libxml_get_errors() as $err) {
             $errors .= $err->code . '<br/>';
         }
         return $errors;
     }

Here is the caller graph for this function:

◆ setMapping()

ilLOXmlParser::setMapping ( ilImportMapping $mapping )

Set import mapping.

Parameters

ilImportMapping $mapping

Definition at line 38 of file class.ilLOXmlParser.php.

References $mapping.

     {
         $this->mapping = $mapping;
     }

Field Documentation

◆ $course

ilLOXmlParser::$course = null

private

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

Referenced by __construct(), and getCourse().

◆ $mapping

ilLOXmlParser::$mapping = null

private

Definition at line 21 of file class.ilLOXmlParser.php.

Referenced by getMapping(), and setMapping().

◆ $xml

ilLOXmlParser::$xml = ''

private

Definition at line 19 of file class.ilLOXmlParser.php.

◆ TYPE_TST_ALL

const ilLOXmlParser::TYPE_TST_ALL = 2

Definition at line 15 of file class.ilLOXmlParser.php.

◆ TYPE_TST_PO

const ilLOXmlParser::TYPE_TST_PO = 1

Definition at line 14 of file class.ilLOXmlParser.php.

◆ TYPE_TST_RND

const ilLOXmlParser::TYPE_TST_RND = 3

Definition at line 16 of file class.ilLOXmlParser.php.

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

Modules/Course/classes/Objectives/class.ilLOXmlParser.php

Public Member Functions

Data Fields

Protected Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getCourse()

◆ getMapping()

◆ getMappingForQpls()

◆ getMappingForQuestion()

◆ getMappingInfoForItem()

◆ getMappingInfoForItemObject()

◆ parse()

◆ parseMaterials()

◆ parseObjectDependencies()

◆ parseObjectives()

◆ parseSettings()

◆ parseTests()

◆ parseXmlErrors()

◆ setMapping()

Field Documentation

◆ $course

◆ $mapping

◆ $xml

◆ TYPE_TST_ALL

◆ TYPE_TST_PO

◆ TYPE_TST_RND