Legacy Content Object Parser. More...

Inheritance diagram for ilQuestionPageParser:

Collaboration diagram for ilQuestionPageParser:

Public Member Functions
	__construct (ilObject $a_content_object, string $a_xml_file, string $a_subdir, string $a_import_dir="")

	setHandlers ($a_xml_parser)

	setImportMapping (ilImportMapping $mapping=null)

	startParsing ()
	stores xml data in array More...

	storeTree ()
	insert StructureObjects and PageObjects into tree More...

	processPagesToParse ()
	parse pages that contain files, mobs and/or internal links More...

	copyMobFiles ()
	copy multimedia object files from import zip file to mob directory More...

	copyFileItems ()
	copy files of file items More...

	setQuestionMapping (array $a_map)
	set question import ident to pool/test question id mapping More...

	beginElement (string $a_name)

	endElement (string $a_name)

	getCurrentElement ()

	getOpenCount (string $a_name)

	buildTag (string $type, string $name, array $attr=[])

	processMeta ()

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

	emptyMediaMetaCache ($a_xml_parser)

	getGlossaryTermMap ()

Public Member Functions inherited from ilMDSaxParser
	__construct (?string $a_xml_file='')

	enableMDParsing (bool $a_status)

	getMDParsingStatus ()

	setMDObject (ilMD $md)

	getMDObject ()

	inMetaData ()

	setHandlers ($a_xml_parser)
	Set event handlers. More...

	handlerBeginTag ($a_xml_parser, string $a_name, array $a_attribs)

	handlerEndTag ($a_xml_parser, string $a_name)

	handlerCharacterData ($a_xml_parser, string $a_data)

	__getCharacterData ()

	__pushParent (object $md_obj)

	__popParent ()

	__getParent ()

Public Member Functions inherited from ilSaxParser
	__construct (?string $path_to_file='', ?bool $throw_exception=false)

	setXMLContent (string $a_xml_content)

	getXMLContent ()

	getInputType ()

	startParsing ()
	stores xml data in array More...

	createParser ()

	setHandlers ($a_xml_parser)

	parse ($a_xml_parser, $a_fp=null)

Data Fields
ilTree	$tree

array	$cnt = []

array	$current_element = []

ilObjLearningModule	$learning_module = null

ilPageObject	$page_object = null

ilLMPageObject	$lm_page_object = null

array	$structure_objects = []

ilObjMediaObject	$media_object = null

object	$current_object = null

ilLMTree	$lm_tree = null

array	$pg_into_tree = []

array	$st_into_tree = []

array	$container = []

bool	$in_page_object = false

bool	$in_meta_data = false

bool	$in_media_object = false

bool	$in_file_item = false

bool	$in_glossary = false

bool	$in_map_area = false

ilObject	$content_object = null

ilObjGlossary	$glossary_object = null

ilObjFile	$file_item = null

array	$pages_to_parse = []

array	$mob_mapping = []

array	$file_item_mapping = []

string	$subdir = ""

ilMediaItem	$media_item = null

string	$loc_type = ""

ilMapArea	$map_area = null

array	$link_targets = []

array	$qst_mapping = []

bool	$metadata_parsing_disabled = false

bool	$in_meta_meta_data = false

Data Fields inherited from ilSaxParser
string	$xml_file

bool	$throw_exception = false

Protected Attributes
bool	$in_properties

bool	$in_glossary_definition = false

array	$media_meta_cache = []

bool	$media_meta_start = false

array	$pg_mapping = []

array	$mobs_with_int_links = []

bool	$inside_code = false

string	$coType = ""

string	$import_dir = ""

array	$glossary_term_map = []

ilLogger	$log

ilGlossaryTerm	$glossary_term = null

ilImportMapping	$mapping = null

string	$cur_qid = ""

ilGlossaryDefinition	$glossary_definition = null

string	$chr_data = ""

bool	$in_media_item = false

Protected Attributes inherited from ilMDSaxParser
bool	$md_in_md = false

string	$md_chr_data = ''

ilMDIdentifier	$md_ide = null

ilMDLanguage	$md_lan = null

ilMDDescription	$md_des = null

ilMDLifecycle	$md_lif = null

ilMDContribute	$md_con = null

ilMDEntity	$md_ent = null

ilMDMetaMetadata	$md_met = null

ilMDTechnical	$md_tec = null

ilMDFormat	$md_for = null

ilMDLocation	$md_loc = null

ilMDRequirement	$md_req = null

ilMDOrComposite	$md_orc = null

ilMDEducational	$md_edu = null

ilMDTypicalAgeRange	$md_typ = null

ilMDRights	$md_rig = null

ilMDRelation	$md_rel = null

ilMDIdentifier_	$md_ide_ = null

ilMDAnnotation	$md_ann = null

ilMDClassification	$md_cla = null

ilMDTaxonPath	$md_taxp = null

ilMDTaxon	$md_tax = null

ilMDKeyword	$md_key = null

array	$md_parent = array()

ilMD	$md = null

ilMDGeneral	$md_gen = null

ilLogger	$meta_log

Protected Attributes inherited from ilSaxParser
ilLanguage	$lng = null

Private Member Functions
	parseLinkTarget (string $identifier)
	Parse a string the get the elements of a link target Return null if the string is not a link target. More...

Additional Inherited Members
Protected Member Functions inherited from ilMDSaxParser
	trimAndStripAttribs (array $attribs)

	trimAndStrip (string $input)

Protected Member Functions inherited from ilSaxParser
	openXMLFile ()

	handleError (string $message)

	setThrowException (bool $throw_exception)

Detailed Description

Legacy Content Object Parser.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Deprecated:: use COPage dependency to export/import COPages instead

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

Constructor & Destructor Documentation

◆ __construct()

ilQuestionPageParser::__construct	(	ilObject	$a_content_object,
		string	$a_xml_file,
		string	$a_subdir,
		string	$a_import_dir = `""`
	)

Definition at line 86 of file class.ilQuestionPageParser.php.

      {
        global $DIC;
 
        $this->log = $DIC["ilLog"];
        $lng = $DIC->language();
        $tree = $DIC->repositoryTree();
 
        $this->log = ilLoggerFactory::getLogger('lm');
 
        $this->import_dir = ($a_import_dir != "")
            ? $a_import_dir
            : $a_content_object->getImportDirectory();
 
        parent::__construct($a_xml_file);
        $this->cnt = array();
        $this->current_element = array();
        $this->structure_objects = array();
        $this->content_object = $a_content_object;
        $this->st_into_tree = array();
        $this->pg_into_tree = array();
        $this->pages_to_parse = array();
        $this->mobs_with_int_links = array();
        $this->mob_mapping = array();
        $this->file_item_mapping = array();
        $this->pg_mapping = array();
        $this->link_targets = array();
        $this->subdir = $a_subdir;
        $this->lng = $lng;
        $this->tree = $tree;
        $this->inside_code = false;
        $this->qst_mapping = array();
        $this->coType = $this->content_object->getType();
        $this->metadata_parsing_disabled = false;
 
        if (($this->coType != "tst") && ($this->coType != "qpl")) {
            $this->lm_tree = new ilLMTree($this->content_object->getId());
        }
    }

References $DIC, ilSaxParser\$lng, $tree, ILIAS\GlobalScreen\Provider\__construct(), ilLoggerFactory\getLogger(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

◆ beginElement()

ilQuestionPageParser::beginElement ( string $a_name )

Definition at line 359 of file class.ilQuestionPageParser.php.

                                                : void
    {
        if (!isset($this->status["$a_name"])) {
            $this->cnt[$a_name] = 1;
        } else {
            $this->cnt[$a_name]++;
        }
        $this->current_element[count($this->current_element)] = $a_name;
    }

◆ buildTag()

ilQuestionPageParser::buildTag	(	string	$type,
		string	$name,
		array	$attr = `[]`
	)

Definition at line 388 of file class.ilQuestionPageParser.php.

     : string {
        $tag = "<";
 
        if ($type == "end") {
            $tag .= "/";
        }
 
        $tag .= $name;
 
        if (is_array($attr)) {
            foreach ($attr as $k => $v) {
                $tag .= " " . $k . "=\"$v\"";
            }
        }
 
        $tag .= ">";
 
        return $tag;
    }

◆ copyFileItems()

ilQuestionPageParser::copyFileItems ( )

copy files of file items

Definition at line 327 of file class.ilQuestionPageParser.php.

                                   : void
    {
        $imp_dir = $this->import_dir;
        foreach ($this->file_item_mapping as $origin_id => $file_id) {
            if (empty($origin_id)) {
                continue;
            }
            $obj_dir = $origin_id;
            $source_dir = $imp_dir . "/" . $this->subdir . "/objects/" . $obj_dir;
 
            $file_obj = new ilObjFile($file_id, false);
            if (is_dir($source_dir)) {
                $files = scandir($source_dir, SCANDIR_SORT_DESCENDING);
                if ($files !== false && $files !== [] && is_file($source_dir . '/' . $files[0])) {
                    $file = fopen($source_dir . '/' . $files[0], 'rb');
                    $file_stream = Streams::ofResource($file);
                    $file_obj->appendStream($file_stream, $files[0]);
                }
            }
            $file_obj->update();
        }
    }

References $import_dir.

Referenced by startParsing().

Here is the caller graph for this function:

◆ copyMobFiles()

ilQuestionPageParser::copyMobFiles ( )

copy multimedia object files from import zip file to mob directory

Definition at line 301 of file class.ilQuestionPageParser.php.

                                  : void
    {
        $imp_dir = $this->import_dir;
        foreach ($this->mob_mapping as $origin_id => $mob_id) {
            if (empty($origin_id)) {
                continue;
            }
 
            $obj_dir = $origin_id;
            $source_dir = $imp_dir . "/" . $this->subdir . "/objects/" . $obj_dir;
            $target_dir = ilFileUtils::getWebspaceDir() . "/mobs/mm_" . $mob_id;
 
            if (is_dir($source_dir)) {
                ilFileUtils::makeDir($target_dir);
 
                if (is_dir($target_dir)) {
                    ilLoggerFactory::getLogger("mob")->debug("s:-$source_dir-,t:-$target_dir-");
                    ilFileUtils::rCopy(realpath($source_dir), realpath($target_dir));
                }
            }
        }
    }

References $import_dir, ilLoggerFactory\getLogger(), ilFileUtils\getWebspaceDir(), ilFileUtils\makeDir(), and ilFileUtils\rCopy().

Referenced by startParsing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ emptyMediaMetaCache()

ilQuestionPageParser::emptyMediaMetaCache ( $a_xml_parser )

Parameters

resource $a_xml_parser

Definition at line 1373 of file class.ilQuestionPageParser.php.

                                                      : void
    {
        foreach ($this->media_meta_cache as $cache_entry) {
            switch ($cache_entry["type"]) {
                case "handlerBeginTag":
                    parent::handlerBeginTag(
                        $a_xml_parser,
                        $cache_entry["par1"],
                        $cache_entry["par2"]
                    );
                    break;
 
                case "handlerEndTag":
                    parent::handlerEndTag(
                        $a_xml_parser,
                        $cache_entry["par1"]
                    );
                    break;
 
                case "handlerCharacterData":
                    parent::handlerCharacterData(
                        $a_xml_parser,
                        $cache_entry["par1"]
                    );
                    break;
            }
        }
 
        $this->media_meta_start = false;
        $this->media_meta_cache[] = array();
    }

◆ endElement()

ilQuestionPageParser::endElement ( string $a_name )

Definition at line 369 of file class.ilQuestionPageParser.php.

                                              : void
    {
        $this->cnt[$a_name]--;
        unset($this->current_element[count($this->current_element) - 1]);
    }

◆ getCurrentElement()

ilQuestionPageParser::getCurrentElement ( )

Definition at line 375 of file class.ilQuestionPageParser.php.

                                       : string
    {
        return ($this->current_element[count($this->current_element) - 1] ?? "");
    }

◆ getGlossaryTermMap()

ilQuestionPageParser::getGlossaryTermMap ( )

Returns: mixed[]

Definition at line 1408 of file class.ilQuestionPageParser.php.

                                        : array
    {
        return $this->glossary_term_map;
    }

◆ getOpenCount()

ilQuestionPageParser::getOpenCount ( string $a_name )

Definition at line 380 of file class.ilQuestionPageParser.php.

                                                : int
    {
        if (isset($this->cnt[$a_name])) {
            return $this->cnt[$a_name];
        }
        return 0;
    }

◆ handlerCharacterData()

ilQuestionPageParser::handlerCharacterData	(		$a_xml_parser,
		string	$a_data
	)

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

Definition at line 1318 of file class.ilQuestionPageParser.php.

                                                                       : void
    {
        // call meta data handler
        if ($this->in_meta_data && $this->processMeta()) {
            // cache beginning of meta data within media object tags
            // (we need to know the id, after that we send the cached data
            // to the meta xml handler)
            if ($this->in_media_object && $this->media_meta_start) {
                $this->media_meta_cache[] =
                    array("type" => "handlerCharacterData", "par1" => $a_data);
            } else {
                parent::handlerCharacterData($a_xml_parser, $a_data);
            }
        }
 
        // the parser converts "&gt;" to ">" and "&lt;" to "<"
        // in character data, but we don't want that, because it's the
        // way we mask user html in our content, so we convert back...
 
        $a_data = str_replace("<", "&lt;", $a_data);
        $a_data = str_replace(">", "&gt;", $a_data);
 
 
        // DELETE WHITESPACES AND NEWLINES OF CHARACTER DATA
        $a_data = preg_replace("/\n/", "", $a_data);
        if (!$this->inside_code) {
            $a_data = preg_replace("/\t+/", "", $a_data);
        }
 
        $this->chr_data .= $a_data;
 
        if (!empty($a_data) || $a_data === "0") {
            // append all data to page, if we are within PageObject,
            // but not within MetaData or MediaObject
            if (($this->in_page_object || $this->in_glossary_definition)
                && !$this->in_meta_data && !$this->in_media_object) {
                $this->page_object->appendXMLContent($a_data);
            }
 
            switch ($this->getCurrentElement()) {
 
                case "IntLink":
                case "ExtLink":
                    if ($this->in_map_area) {
                        $this->map_area->appendTitle($a_data);
                    }
                    break;
 
            }
        }
    }

◆ handlerEndTag()

ilQuestionPageParser::handlerEndTag	(		$a_xml_parser,
		string	$a_name
	)

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

Definition at line 904 of file class.ilQuestionPageParser.php.

                                                                : void
    {
        // call meta data handler
        if ($this->in_meta_data && $this->processMeta()) {
            // cache beginning of meta data within media object tags
            // (we need to know the id, after that we send the cached data
            // to the meta xml handler)
            if ($this->in_media_object && $this->media_meta_start) {
                $this->media_meta_cache[] =
                    array("type" => "handlerEndTag", "par1" => $a_name);
            } else {
                parent::handlerEndTag($a_xml_parser, $a_name);
            }
        }
 
        // append content to page xml content
        if (($this->in_page_object || $this->in_glossary_definition)
            && !$this->in_meta_data && !$this->in_media_object) {
            $app_name = ($a_name == "Definition")
                ? "PageObject"
                : $a_name;
            $this->page_object->appendXMLContent($this->buildTag("end", $app_name));
        }
 
        switch ($a_name) {
            case "StructureObject":
                unset($this->structure_objects[count($this->structure_objects) - 1]);
                break;
 
            case "PageObject":
 
                $this->in_page_object = false;
                if (($this->coType != "tst") && ($this->coType != "qpl")) {
                    //if (!$this->lm_page_object->isAlias()) {
                    $this->page_object->updateFromXML();
                    $this->pg_mapping[$this->lm_page_object->getImportId()]
                            = $this->lm_page_object->getId();
 
                    if ($this->mapping instanceof ilImportMapping) {
                        $import_id_parsed = ilUtil::parseImportId($this->lm_page_object->getImportId());
                        if ($import_id_parsed['type'] == 'pg') {
                            $this->mapping->addMapping(
                                'Modules/LearningModule',
                                'pg',
                                $import_id_parsed['id'],
                                $this->lm_page_object->getId()
                            );
                        }
                    }
 
                    // collect pages with internal links
                    if ($this->page_object->containsIntLink()) {
                        $this->pages_to_parse["lm:" . $this->page_object->getId()] = "lm:" . $this->page_object->getId();
                    }
 
                    // collect pages with mobs or files
                    if ($this->page_object->needsImportParsing()) {
                        $this->pages_to_parse["lm:" . $this->page_object->getId()] = "lm:" . $this->page_object->getId();
                    }
 
                    // collect pages with questions
                    if ($this->page_object->getContainsQuestion()) {
                        $this->pages_to_parse["lm:" . $this->page_object->getId()] = "lm:" . $this->page_object->getId();
                    }
                    //}
                } else {
                    $xml = $this->page_object->getXMLContent();
                    if ($this->cur_qid != "") {
                        $ids = $this->qst_mapping[$this->cur_qid] ?? ['pool' => 0, 'test' => 0];
                        if ($ids["pool"] > 0) {
                            // question pool question
                            $page = new ilAssQuestionPage($ids["pool"]);
                            $xmlcontent = str_replace(
                                $this->cur_qid,
                                "il__qst_" . $ids["pool"],
                                $xml
                            );
                            $page->setXMLContent($xmlcontent);
                            $page->updateFromXML();
                            if ($this->page_object->needsImportParsing()) {
                                $this->pages_to_parse["qpl:" . $page->getId()] = "qpl:" . $page->getId();
                            }
                            unset($page);
                        }
                        if ($ids["test"] > 0) {
                            // test question
                            $page = new ilAssQuestionPage($ids["test"]);
                            $xmlcontent = str_replace(
                                $this->cur_qid,
                                "il__qst_" . $ids["test"],
                                $xml
                            );
                            $page->setXMLContent($xmlcontent);
                            $page->updateFromXML();
                            if ($this->page_object->needsImportParsing()) {
                                $this->pages_to_parse["qpl:" . $page->getId()] = "qpl:" . $page->getId();
                            }
                            unset($page);
                        }
                    }
                }
 
                // if we are within a structure object: put page in tree
                $cnt = count($this->structure_objects);
                if ($cnt > 0) {
                    $parent_id = $this->structure_objects[$cnt - 1]->getId();
                    //if ($this->lm_page_object->isAlias()) {
                    //    $this->pg_into_tree[$parent_id][] = array("type" => "pg_alias", "id" => $this->lm_page_object->getOriginId());
                    //} else {
                    $this->pg_into_tree[$parent_id][] = array("type" => "pg", "id" => $this->lm_page_object->getId());
                    //}
                }
 
                unset($this->page_object);
                unset($this->lm_page_object);
                unset($this->container[count($this->container) - 1]);
                break;
 
            case "MediaObject":
            case "InteractiveImage":
                if ($a_name == "MediaObject") {
                    $this->in_media_object = false;
                }
 
                if (empty($this->mob_mapping[$this->media_object->getImportId()])) {
                    // create media object
                    // media items are saves for mobs outside of
                    // pages only
                    $this->media_object->create(true, false);
 
                    // collect mobs with internal links
                    if ($this->media_object->containsIntLink()) {
                        //echo "got int link :".$this->media_object->getId().":<br>";
                        $this->mobs_with_int_links[] = $this->media_object->getId();
                    }
 
                    $this->mob_mapping[$this->media_object->getImportId()]
                            = $this->media_object->getId();
                } else {
                    // get the id from mapping
                    $this->media_object->setId($this->mob_mapping[$this->media_object->getImportId()]);
 
                    // update "real" (no alias) media object
                    // (note: we overwrite any data from the media object
                    // created by an MediaAlias, only the data of the real
                    // object is stored in db separately; data of the
                    // MediaAliases are within the page XML
                    if (!$this->media_object->isAlias()) {
                        // now the media items are saved within the db
                        $this->media_object->update();
 
                        //echo "<br>update media object :".$this->media_object->getId().":";
 
                        // collect mobs with internal links
                        if ($this->media_object->containsIntLink()) {
                            //echo "got int link :".$this->media_object->getId().":<br>";
                            $this->mobs_with_int_links[] = $this->media_object->getId();
                        }
                    }
                }
 
                // append media alias to page, if we are in a page
                if ($this->in_page_object || $this->in_glossary_definition) {
                    if ($a_name != "InteractiveImage") {
                        $this->page_object->appendXMLContent($this->media_object->getXML(IL_MODE_ALIAS));
                        //echo "Appending:".htmlentities($this->media_object->getXML(IL_MODE_ALIAS))."<br>";
                    }
                }
 
                break;
 
            case "MediaItem":
            case "MediaAliasItem":
                $this->in_media_item = false;
                $this->media_object->addMediaItem($this->media_item);
                break;
 
            case "MapArea":
                $this->in_map_area = false;
                $this->media_item->addMapArea($this->map_area);
                break;
 
            case "Properties":
                $this->in_properties = false;
                if ($this->content_object->getType() == "lm") {
                    $this->content_object->update();
                }
                break;
 
            case "MetaData":
                $this->in_meta_data = false;
                if (strtolower(get_class($this->current_object)) == "illmpageobject" && !$this->in_media_object) {
                    // Metadaten eines PageObjects sichern in NestedSet
                    if (is_object($this->lm_page_object)) {
                        // update title/description of page object
                        $this->current_object->MDUpdateListener('General');
                        ilLMObject::_writeImportId(
                            $this->current_object->getId(),
                            $this->current_object->getImportId()
                        );
                    }
                } elseif ((strtolower(get_class($this->current_object)) == "ilobjquestionpool" ||
                    strtolower(get_class($this->current_object)) == "ilobjtest") &&
                    !$this->in_media_object) {
                    //                                  !$this->in_media_object && !$this->in_page_object)
                    // changed for imports of ILIAS 2 Tests where PageObjects could have
                    // Metadata sections (Helmut Schottmüller, 2005-12-02)
                    if ($this->metadata_parsing_disabled) {
                        $this->enableMDParsing(true);
                    } else {
                        if ($this->in_page_object && !is_null($this->page_object)) {
                            /*
                            $this->page_object->MDUpdateListener('General');
                            ilLMObject::_writeImportId(
                                $this->page_object->getId(),
                                $this->page_object->getImportId()
                            );*/
                        } else {
                            $this->current_object->MDUpdateListener('General');
                            ilLMObject::_writeImportId(
                                $this->current_object->getId(),
                                $this->current_object->getImportId()
                            );
                        }
                    }
                } elseif (strtolower(get_class($this->current_object)) == "ilstructureobject") {    // save structure object at the end of its meta block
                    // determine parent
                    $cnt = count($this->structure_objects);
                    if ($cnt > 1) {
                        $parent_id = $this->structure_objects[$cnt - 2]->getId();
                    } else {
                        $parent_id = $this->lm_tree->getRootId();
                    }
 
                    $this->st_into_tree[] = array("id" => $this->current_object->getId(),
                        "parent" => $parent_id);
 
                    // update title/description of structure object
                    $this->current_object->MDUpdateListener('General');
                    ilLMObject::_writeImportId(
                        $this->current_object->getId(),
                        $this->current_object->getImportId()
                    );
                } elseif (strtolower(get_class($this->current_object)) == "ilobjlearningmodule" ||
                    strtolower(get_class($this->current_object)) == "ilobjcontentobject" ||
                    (strtolower(get_class($this->current_object)) == "ilobjglossary" && $this->in_glossary)) {
                    // todo: saving of md? getting title/descr and
                    // set it for current object
                } elseif (strtolower(get_class($this->current_object)) == "ilglossarydefinition" && !$this->in_media_object) {
                    // now on top
                    //$this->glossary_definition->create();
 
                    $this->page_object->setId($this->glossary_definition->getId());
                    $this->page_object->updateFromXML();
 
                    // todo: saving of md? getting title/descr and
                    // set it for current object
                }
 
 
                if (strtolower(get_class($this->current_object)) == "ilobjlearningmodule" ||
                    strtolower(get_class($this->current_object)) == "ilobjglossary") {
                    if (strtolower(get_class($this->current_object)) == "ilobjglossary" &&
                        $this->content_object->getType() != "glo") {
                        //echo "<br><b>getting2: ".$this->content_object->getTitle()."</b>";
                        $this->current_object->setTitle($this->content_object->getTitle() . " - " .
                            $this->lng->txt("glossary"));
                    }
 
                    $this->current_object->MDUpdateListener('General');
                    /*
                    if (!$this->in_media_object && $this->processMeta())
                    {
                        $this->current_object->update();
                    }
                    */
                }
 
                if ($this->in_media_object) {
                    //echo "<br>call media object update listener";
                    $this->media_object->MDUpdateListener('General');
                }
 
                if ($this->in_glossary_definition) {
                    $this->glossary_definition->MDUpdateListener('General');
                }
 
                break;
 
            case "Meta-Metadata":
                $this->in_meta_meta_data = false;
                break;
 
            case "FileItem":
                $this->in_file_item = false;
                // only update new file items
                if ($this->file_item->getImportId()) {
                    $this->file_item->update();
                }
                break;
 
 
            case "Table":
                unset($this->container[count($this->container) - 1]);
                break;
 
            case "Glossary":
                $this->in_glossary = false;
                break;
 
            case "GlossaryTerm":
                $term = trim($this->chr_data);
                $term = str_replace("&lt;", "<", $term);
                $term = str_replace("&gt;", ">", $term);
                $this->glossary_term->setTerm($term);
                $this->glossary_term->create();
                $iia = explode("_", $this->glossary_term->getImportId());
                $this->glossary_term_map[(int) $iia[count($iia) - 1]] = $this->glossary_term->getId();
                break;
 
            case "Paragraph":
                $this->inside_code = false;
                break;
 
            case "Definition":
                $this->in_glossary_definition = false;
                $this->page_object->updateFromXML();
                $this->page_object->buildDom();
                $this->glossary_definition->setShortText($this->page_object->getFirstParagraphText());
                $this->glossary_definition->update();
                if ($this->page_object->containsIntLink()) {
                    $this->pages_to_parse["gdf:" . $this->page_object->getId()] = "gdf:" . $this->page_object->getId();
                }
                if ($this->page_object->needsImportParsing()) {
                    $this->pages_to_parse["gdf:" . $this->page_object->getId()] = "gdf:" . $this->page_object->getId();
                }
                break;
 
            case "Format":
                if ($this->in_media_item) {
                    $this->media_item->setFormat(trim($this->chr_data));
                }
                break;
 
            case "Title":
                if ($this->in_meta_data && !$this->in_media_object) {
                    $this->current_object->setTitle(trim($this->chr_data));
                }
                if ($this->in_media_object) {
                    $this->media_object->setTitle(trim($this->chr_data));
                }
                break;
 
            case "Description":
            case "Language":
                break;
 
            case "Caption":
                if ($this->in_media_object) {
                    $this->media_item->setCaption(trim($this->chr_data));
                }
                break;
 
            case "TextRepresentation":
                if ($this->in_media_object) {
                    $this->media_item->setTextRepresentation(trim($this->chr_data));
                }
                break;
 
                // Location
            case "Location":
                // TODO: adapt for files in "real" subdirectories
                if ($this->in_media_item) {
                    $this->media_item->setLocationType($this->loc_type);
                    if ($this->loc_type == "Reference") {
                        $this->media_item->setLocation(str_replace("&", "&amp;", trim($this->chr_data)));
                    } else {
                        $this->media_item->setLocation(trim($this->chr_data));
                    }
                }
                if ($this->in_file_item) {
                    // set file name from xml file
                    $this->file_item->setFileName(trim($this->chr_data));
 
                    // special handling for file names with special characters
                    // (e.g. "&gt;")
                    if ($this->file_item->getType() == "file" &&
                        is_int(strpos($this->chr_data, "&")) &&
                        is_int(strpos($this->chr_data, ";"))) {
                        $imp_dir = $this->import_dir;
                        $source_dir = $imp_dir . "/" . $this->subdir . "/objects/" .
                            $this->file_item->getImportId();
 
                        // read "physical" file name from directory
                        if ($dir = opendir($source_dir)) {
                            while (false !== ($file = readdir($dir))) {
                                if ($file != "." && $file != "..") {
                                    $this->file_item->setFileName($file);
                                }
                            }
                            closedir($dir);
                        }
                    }
 
                    // set file item title
                    $this->file_item->setTitle(trim($this->chr_data));
                }
                break;
 
        }
        $this->endElement($a_name);
        $this->chr_data = "";
    }

References $xml, ilLMObject\_writeImportId(), IL_MODE_ALIAS, ILIAS\Repository\int(), and ilUtil\parseImportId().

Here is the call graph for this function:

◆ parseLinkTarget()

ilQuestionPageParser::parseLinkTarget ( string $identifier )

private

Parse a string the get the elements of a link target Return null if the string is not a link target.

Returns: array{target_inst: int, target_type: string, target_id: int}|null

Definition at line 1418 of file class.ilQuestionPageParser.php.

                                                        : ?array
    {
        $link_arr = explode('_', $identifier);
 
        if (count($link_arr) !== 4
            || $link_arr[0] !== 'il'
            || !is_numeric($link_arr[1])
            || !is_numeric($link_arr[3])
        ) {
            return null;
        }
 
        return [
          'target_inst' => (int) $link_arr[1],
          'target_type' => (string) $link_arr[2],
          'target_id' => (int) $link_arr[3]
        ];
    }

References ILIAS\Repository\int().

Referenced by processPagesToParse().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ processMeta()

ilQuestionPageParser::processMeta ( )

Definition at line 890 of file class.ilQuestionPageParser.php.

                                 : bool
    {
        // do not process second meta block in (ilias3) glossaries
        // which comes right after the "Glossary" tag
        if ($this->content_object->getType() == "glo" &&
            $this->in_glossary && !$this->in_media_object
            && !$this->in_glossary_definition) {
            return false;
        }
 
        return true;
    }

◆ processPagesToParse()

ilQuestionPageParser::processPagesToParse ( )

parse pages that contain files, mobs and/or internal links

Definition at line 201 of file class.ilQuestionPageParser.php.

                                         : void
    {
        // outgoin internal links
        foreach ($this->pages_to_parse as $page_id) {
            $page_arr = explode(":", $page_id);
            $page_obj = null;
            //echo "<br>resolve:".$this->content_object->getType().":".$page_id; flush();
            switch ($page_arr[0]) {
                case "lm":
                    switch ($this->content_object->getType()) {
                        case "lm":
                            $page_obj = new ilLMPage($page_arr[1]);
                            break;
 
                        default:
                            die("Unknown content type " . $this->content_object->getType());
                    }
 
                    break;
 
                case "gdf":
                    $page_obj = new ilGlossaryDefPage($page_arr[1]);
                    break;
 
                case "qpl":
                    $page_obj = new ilAssQuestionPage($page_arr[1]);
                    break;
            }
            $page_obj->buildDom();
            $page_obj->resolveIntLinks();
            $page_obj->resolveIIMMediaAliases($this->mob_mapping);
            if ($this->coType == "lm") {
                $page_obj->resolveQuestionReferences($this->qst_mapping);
            }
            $page_obj->update(false);
 
            if ($page_arr[0] == "gdf") {
                $def = new ilGlossaryDefinition($page_arr[1]);
                $def->updateShortText();
            }
 
            unset($page_obj);
        }
 
        //echo "<br><b>map area internal links</b>"; flush();
        // outgoins map area (mob) internal links
        foreach ($this->mobs_with_int_links as $mob_id) {
            ilMediaItem::_resolveMapAreaLinks($mob_id);
        }
 
        //echo "<br><b>incoming interna links</b>"; flush();
        // incoming internal links
        $done = array();
        foreach ($this->link_targets as $link_target) {
            $parsed = $this->parseLinkTarget((string) $link_target);
            if (!isset($parsed)) {
                continue;
            }
            //echo "doin link target:".$link_target.":<br>";
            $sources = ilInternalLink::_getSourcesOfTarget(
                $parsed['target_type'],
                $parsed['target_id'],
                $parsed['target_inst']
            );
 
            foreach ($sources as $key => $source) {
                //echo "got source:".$key.":<br>";
                if (in_array($key, $done)) {
                    continue;
                }
                $type_arr = explode(":", $source["type"]);
 
                // content object pages
                if ($type_arr[1] == "pg") {
                    if (ilPageObject::_exists($type_arr[0], $source["id"])) {
                        $page_object = ilPageObjectFactory::getInstance($type_arr[0], $source["id"]);
                        $page_object->buildDom();
                        $page_object->resolveIntLinks();
                        $page_object->update();
                        unset($page_object);
                    }
                }
 
                // eventually correct links in questions to learning modules
                if ($type_arr[0] == "qst") {
                    assQuestion::_resolveIntLinks($source["id"]);
                }
                // eventually correct links in survey questions to learning modules
                if ($type_arr[0] == "sqst") {
                    SurveyQuestion::_resolveIntLinks($source["id"]);
                }
                $done[$key] = $key;
            }
        }
    }

References ILIAS\LTI\ToolProvider\$key, $page_object, $source, ilPageObject\_exists(), ilInternalLink\_getSourcesOfTarget(), SurveyQuestion\_resolveIntLinks(), assQuestion\_resolveIntLinks(), ilMediaItem\_resolveMapAreaLinks(), ilPageObject\buildDom(), ilPageObjectFactory\getInstance(), parseLinkTarget(), ilPageObject\resolveIntLinks(), and ilPageObject\update().

Referenced by startParsing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlers()

ilQuestionPageParser::setHandlers ( $a_xml_parser )

Parameters

resource $a_xml_parser

Reimplemented from ilMDSaxParser.

Definition at line 133 of file class.ilQuestionPageParser.php.

                                              : void
    {
        xml_set_object($a_xml_parser, $this);
        xml_set_element_handler($a_xml_parser, 'handlerBeginTag', 'handlerEndTag');
        xml_set_character_data_handler($a_xml_parser, 'handlerCharacterData');
    }

◆ setImportMapping()

ilQuestionPageParser::setImportMapping ( ilImportMapping $mapping = null )

Definition at line 140 of file class.ilQuestionPageParser.php.

                                                                     : void
    {
        $this->mapping = $mapping;
    }

References $mapping.

◆ setQuestionMapping()

ilQuestionPageParser::setQuestionMapping ( array $a_map )

set question import ident to pool/test question id mapping

Parameters

mixed[] $a_map

Definition at line 354 of file class.ilQuestionPageParser.php.

                                                    : void
    {
        $this->qst_mapping = $a_map;
    }

◆ startParsing()

ilQuestionPageParser::startParsing ( )

stores xml data in array

Exceptions

ilSaxParserException

Reimplemented from ilSaxParser.

Definition at line 145 of file class.ilQuestionPageParser.php.

                                  : void
    {
        $this->log->debug("start");
 
        //echo "<b>start parsing</b><br>";
        parent::startParsing();
        //echo "<b>storeTree</b><br>";
        $this->storeTree();
        //echo "<b>processPagesToParse</b><br>";
        $this->processPagesToParse();
        //echo "<b>copyMobFiles</b><br>";
        $this->copyMobFiles();
        //echo "<b>copyFileItems</b><br>";
        $this->copyFileItems();
        //echo "<br>END Parsing"; exit;
    }

References copyFileItems(), copyMobFiles(), processPagesToParse(), and storeTree().

Here is the call graph for this function:

◆ storeTree()

ilQuestionPageParser::storeTree ( )

insert StructureObjects and PageObjects into tree

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

                               : void
    {
        $ilLog = $this->log;
 
        foreach ($this->st_into_tree as $st) {
            $this->lm_tree->insertNode($st["id"], $st["parent"]);
            if (is_array($this->pg_into_tree[$st["id"]])) {
                foreach ($this->pg_into_tree[$st["id"]] as $pg) {
                    $pg_id = 0;
                    switch ($pg["type"]) {
                        case "pg_alias":
                            if ($this->pg_mapping[$pg["id"]] == "") {
                                $ilLog->write("LM Import: No PageObject for PageAlias " .
                                              $pg["id"] . " found! (Please update export installation to ILIAS 3.3.0)");
 
                                // Jump two levels up. First level is switch
                                continue 2;
                            }
                            $pg_id = $this->pg_mapping[$pg["id"]];
                            break;
 
                        case "pg":
                            $pg_id = $pg["id"];
                            break;
                    }
                    if (!$this->lm_tree->isInTree($pg_id)) {
                        $this->lm_tree->insertNode($pg_id, $st["id"]);
                    }
                }
            }
        }
    }