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

Collaboration diagram for ilContainerXmlParser:

Public Member Functions
	__construct (ilImportMapping $mapping, string $xml='')

	getMapping ()

	parse (string $a_root_id)

Static Public Attributes
static array	$style_map = []

Protected Member Functions
	initItem (SimpleXMLElement $item, int $a_parent_node)

	parseTiming (int $a_ref_id, int $a_parent_id, SimpleXMLElement $timing)

	createObject (int $ref_id, int $obj_id, string $type, string $title, int $parent_node)

Protected Attributes
ilSetting	$settings

ilObjectDefinition	$obj_definition

ilLogger	$cont_log

Private Attributes
int	$source = 0

ilImportMapping	$mapping = null

string	$xml = ''

int	$root_id = 0

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 XML parser for container structure

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

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerXmlParser::__construct	(	ilImportMapping	$mapping,
		string	$xml = `''`
	)

Definition at line 35 of file class.ilContainerXmlParser.php.

References $DIC, $mapping, $xml, ilLoggerFactory\getLogger(), and ILIAS\Repository\settings().

       {
         global $DIC;
 
         $this->settings = $DIC->settings();
         $this->obj_definition = $DIC["objDefinition"];
         $this->mapping = $mapping;
         $this->xml = $xml;
         $this->cont_log = ilLoggerFactory::getLogger('cont');
     }

Here is the call graph for this function:

Member Function Documentation

◆ createObject()

ilContainerXmlParser::createObject	(	int	$ref_id,
		int	$obj_id,
		string	$type,
		string	$title,
		int	$parent_node
	)

protected

Definition at line 174 of file class.ilContainerXmlParser.php.

References $location, $obj_definition, ilObjectFactory\getInstanceByObjId(), and getMapping().

Referenced by initItem().

      : ?int {
         $objDefinition = $this->obj_definition;
 
         // A mapping for this object already exists => create reference
         $new_obj_id = $this->getMapping()->getMapping('Services/Container', 'objs', (string) $obj_id);
         if ($new_obj_id) {
             $obj = ilObjectFactory::getInstanceByObjId((int) $new_obj_id, false);
             if ($obj instanceof  ilObject) {
                 $obj->createReference();
                 $obj->putInTree($parent_node);
                 $obj->setPermissions($parent_node);
                 $this->mapping->addMapping('Services/Container', 'refs', (string) $ref_id, (string) $obj->getRefId());
                 return $obj->getRefId();
             }
         }
 
         if (!$objDefinition->isAllowedInRepository($type) || $objDefinition->isInactivePlugin($type)) {
             $this->cont_log->notice('Cannot import object of type: ' . $type);
             return null;
         }
 
         $class_name = "ilObj" . $objDefinition->getClassName($type);
         $location = $objDefinition->getLocation($type);
 
         include_once($location . "/class." . $class_name . ".php");
         $new = new $class_name();
         $new->setTitle($title);
         $new->create(true);
         $new->createReference();
         $new->putInTree($parent_node);
         $new->setPermissions($parent_node);
 
         $this->mapping->addMapping('Services/Container', 'objs', (string) $obj_id, (string) $new->getId());
         $this->mapping->addMapping('Services/Object', 'obj', (string) $obj_id, (string) $new->getId());
         $this->mapping->addMapping('Services/Container', 'refs', (string) $ref_id, (string) $new->getRefId());
 
         return $new->getRefId();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMapping()

ilContainerXmlParser::getMapping ( )

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

References $mapping.

Referenced by createObject(), and initItem().

                                 : ?ilImportMapping
     {
         return $this->mapping;
     }

Here is the caller graph for this function:

◆ initItem()

ilContainerXmlParser::initItem	(	SimpleXMLElement	$item,
		int	$a_parent_node
	)

protected

Definition at line 62 of file class.ilContainerXmlParser.php.

References $ilSetting, $ref_id, $settings, $type, ilObject\_lookupObjId(), createObject(), getMapping(), ILIAS\Repository\int(), and parseTiming().

Referenced by parse().

      : void {
         $ilSetting = $this->settings;
 
         $title = (string) $item['Title'];
         $ref_id = (string) $item['RefId'];
         $obj_id = (string) $item['Id'];
         $type = (string) $item['Type'];
 
 
         $new_ref = $this->getMapping()->getMapping('Services/Container', 'refs', $ref_id);
 
         if (
             !$new_ref &&
             ($obj_id == $this->root_id)
         ) {
             // if container without subitems a dummy container has already been created
             // see ilImportContainer::createDummy()
             $new_ref = $this->mapping->getMapping('Services/Container', 'refs', '0');
 
             // see below and ilContainerImporter::finalProcessing()
             $this->mapping->addMapping('Services/Container', 'objs', $obj_id, (string) ilObject::_lookupObjId((int) $new_ref));
             $this->mapping->addMapping('Services/Object', 'obj', $obj_id, (string) ilObject::_lookupObjId((int) $new_ref));
         }
 
         if (!$new_ref) {
             $new_ref = $this->createObject((int) $ref_id, (int) $obj_id, $type, $title, $a_parent_node);
         }
         if (!$new_ref) {
             // e.g inactive plugin
             return;
         }
 
         // Course item information
         foreach ($item->Timing as $timing) {
             $this->parseTiming($new_ref, $a_parent_node, $timing);
         }
 
         foreach ($item->Item as $subitem) {
             $this->initItem($subitem, $new_ref);
         }
 
         $new_obj_id = $this->mapping->getMapping('Services/Container', 'objs', $obj_id);
 
         // style
         if ((int) $item['Style']) {
             self::$style_map[(int) $item['Style']][] = $new_obj_id;
         }
 
         // pages
         if ($ilSetting->get('enable_cat_page_edit', '0')) {
             if ($item['Page'] == "1") {
                 $this->mapping->addMapping('Services/COPage', 'pg', 'cont:' . $obj_id, 'cont:' . $new_obj_id);
                 $this->cont_log->debug("add pg cont mapping, old: " . $obj_id . ", new: " . $new_obj_id . ", Page: -" . $item['Page'] . "-");
             }
 
             if ($item['StartPage'] == "1") {
                 $this->mapping->addMapping('Services/COPage', 'pg', 'cstr:' . $obj_id, 'cstr:' . $new_obj_id);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parse()

ilContainerXmlParser::parse ( string $a_root_id )

Definition at line 53 of file class.ilContainerXmlParser.php.

References initItem(), and ILIAS\Repository\int().

                                             : void
     {
         $sxml = simplexml_load_string($this->xml);
         $this->root_id = (int) $a_root_id;
         foreach ($sxml->Item as $item) {
             $this->initItem($item, $this->mapping->getTargetId());
         }
     }

Here is the call graph for this function:

◆ parseTiming()

ilContainerXmlParser::parseTiming	(	int	$a_ref_id,
		int	$a_parent_id,
		SimpleXMLElement	$timing
	)

protected

Definition at line 127 of file class.ilContainerXmlParser.php.

References $type, IL_CAL_DATETIME, IL_CAL_UNIX, and ilTimeZone\UTC.

Referenced by initItem().

      : void {
         $type = (string) $timing['Type'];
         $visible = (string) $timing['Visible'];
         $changeable = (string) $timing['Changeable'];
 
         $crs_item = new ilObjectActivation();
         $crs_item->setTimingType((int) $type);
         $crs_item->toggleVisible((bool) $visible);
         $crs_item->toggleChangeable((bool) $changeable);
 
         foreach ($timing->children() as $sub) {
             switch ($sub->getName()) {
                 case 'Start':
                     $dt = new ilDateTime((string) $sub, IL_CAL_DATETIME, ilTimeZone::UTC);
                     $crs_item->setTimingStart($dt->get(IL_CAL_UNIX));
                     break;
 
                 case 'End':
                     $dt = new ilDateTime((string) $sub, IL_CAL_DATETIME, ilTimeZone::UTC);
                     $crs_item->setTimingEnd($dt->get(IL_CAL_UNIX));
                     break;
 
                 case 'SuggestionStart':
                     $dt = new ilDateTime((string) $sub, IL_CAL_DATETIME, ilTimeZone::UTC);
                     $crs_item->setSuggestionStart($dt->get(IL_CAL_UNIX));
                     break;
 
                 case 'SuggestionEnd':
                     $dt = new ilDateTime((string) $sub, IL_CAL_DATETIME, ilTimeZone::UTC);
                     $crs_item->setSuggestionEnd($dt->get(IL_CAL_UNIX));
                     break;
 
                 case 'LatestEnd':
                     break;
             }
         }
 
 
         if ($crs_item->getTimingStart()) {
             $crs_item->update($a_ref_id, $a_parent_id);
         }
     }