class.ilSCORM2004Page.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

include_once("./Services/COPage/classes/class.ilPageObject.php");

class ilSCORM2004Page extends ilPageObject
{
    protected $glossary_id = 0;
    protected $mobs_contained = array();
    protected $files_contained = array();
    
    public function getParentType()
    {
        return "sahs";
    }

    public function afterConstructor()
    {
        $this->getPageConfig()->configureByObjectId($this->getParentId());
    }
    
    
    public function setScormLmId($a_scormlmid)
    {
        $this->scormlmid = $a_scormlmid;
    }

    public function getScormLmId()
    {
        return $this->scormlmid;
    }

    public function setGlossaryId($a_val)
    {
        $this->glossary_id = $a_val;
    }
    
    public function getGlossaryId()
    {
        return $this->glossary_id;
    }
    
    public function create()
    {
        $ilDB = $this->db;
        
        // maybe we need an additional table here?
        
        // create page object
        parent::create();
    }
    
    
    public function createWithLayoutId($a_layout_id)
    {
        include_once("./Services/COPage/Layout/classes/class.ilPageLayout.php");

        //get XML Data for Layout
        $layout_obj = new ilPageLayout($a_layout_id);
        
        parent::setXMLContent($layout_obj->getXMLContent());
        // create page object
        parent::create();
    }

    public function update($a_validate = true, $a_no_history = false)
    {
        $ilDB = $this->db;

        // maybe we need an additional table here?
        
        parent::update($a_validate, $a_no_history);

        return true;
    }
    
    public function read()
    {
        $ilDB = $this->db;
        
        // maybe we need an additional table here?
        
        // get co page
        parent::read();
    }


    public function delete()
    {
        $ilDB = $this->db;
        
        // maybe we need an additional table here?
        
        // delete co page
        parent::delete();
        
        return true;
    }

    
    
    public function exportXML(&$a_xml_writer, $a_mode = "normal", $a_inst = 0)
    {
        $attrs = array();
        $a_xml_writer->xmlStartTag("PageObject", $attrs);

        switch ($a_mode) {
            case "normal":
                // MetaData
                $this->exportXMLMetaData($a_xml_writer);

                // PageContent
                $this->exportXMLPageContent($a_xml_writer, $a_inst);
                break;

            case "alias":
                $attrs = array();
                $attrs["OriginId"] = "il_" . $a_inst .
                    "_pg_" . $this->getId();
                $a_xml_writer->xmlElement("PageAlias", $attrs);
                break;
        }

        $a_xml_writer->xmlEndTag("PageObject");
    }


    /* todo: this needs to be adopted
     function _exportXMLAlias(&$a_xml_writer, $a_id, $a_inst = 0)
     {
        $attrs = array();
        $a_xml_writer->xmlStartTag("PageObject", $attrs);

        $attrs = array();
        $attrs["OriginId"] = "il_".$a_inst.
        "_pg_".$a_id;
        $a_xml_writer->xmlElement("PageAlias", $attrs);

        $a_xml_writer->xmlEndTag("PageObject");
        }
        */

    public function exportXMLMetaData(&$a_xml_writer)
    {
        include_once("Services/MetaData/classes/class.ilMD2XML.php");
        $md2xml = new ilMD2XML($this->getParentId(), $this->getId(), gettype($this));
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }


    /* todo: this needs to be adopted
     function modifyExportIdentifier($a_tag, $a_param, $a_value)
     {
        if ($a_tag == "Identifier" && $a_param == "Entry")
        {
        $a_value = "il_".IL_INST_ID."_pg_".$this->getId();
        //$a_value = ilUtil::insertInstIntoID($a_value);
        }

        return $a_value;
        }
        */

    public function exportXMLPageContent(&$a_xml_writer, $a_inst = 0)
    {
        $this->buildDom();
        $this->insertInstIntoIDs($a_inst);
        $cont_obj = $this->getContentObject("pg");
        $this->mobs_contained = $this->collectMediaObjects(false);
        include_once("./Services/COPage/classes/class.ilPCFileList.php");
        $this->files_contained = ilPCFileList::collectFileItems($this, $this->getDomDoc());
        $xml = $this->getXMLFromDom(false, false, false, "", true);
        $xml = str_replace("&", "&amp;", $xml);
        $a_xml_writer->appendXML($xml);

        $this->freeDom();
    }
    
    
    public function getMediaObjectIds()
    {
        return $this->mobs_contained;
    }

    public function getFileItemIds()
    {
        return $this->files_contained;
    }
    
    public function performAutomaticModifications()
    {
        // disabled this due to #0011195
        // this does not really work well. Besides creating duplicates, it does not ensure that all
        // glossary terms are in the assigned glossary. Copying whole pages does not trigger
        // this procedure. Moreover if no glossary is attached copying pages will still create links
        // in the target SCORM LM. The SCORM Export seesm to work well, even if terms are in other glossaries

        return;

        if ($this->getGlossaryId() > 0) {
            // we fix glossary links here
            $this->buildDom();
            $xpc = xpath_new_context($this->dom);
            $path = "//IntLink[@Type='GlossaryItem']";
            $res = xpath_eval($xpc, $path);
            for ($i=0; $i < count($res->nodeset); $i++) {
                $target = $res->nodeset[$i]->get_attribute("Target");
                //echo "<br>".$target;
                $tarr = explode("_", $target);
                $term_id = $tarr[count($tarr) - 1];
                if (is_int(strpos($target, "__")) && $term_id > 0) {
                    include_once("./Modules/Glossary/classes/class.ilGlossaryTerm.php");
                    //echo "<br>-".ilGlossaryTerm::_lookGlossaryID($term_id)."-".$this->getGlossaryId()."-";
                    if (ilGlossaryTerm::_lookGlossaryID($term_id) != $this->getGlossaryId()) {
                        // copy the glossary term from glossary a to b
                        $new_id = ilGlossaryTerm::_copyTerm($term_id, $this->getGlossaryId());
                        $res->nodeset[$i]->set_attribute("Target", "il__git_" . $new_id);
                    }
                }
            }
        }
        //exit;
    }

    public function removeInvalidLinks()
    {
        $this->buildDom();

        // find all Keyw tags
        $xpath = new DOMXPath($this->getDomDoc());
        $nodes = $xpath->query('//Paragraph//IntLink');
        $to_del = array();
        foreach ($nodes as $node) {
            if (in_array($node->getAttribute("Type"), array("File", "GlossaryItem"))) {
                continue;
            }
            $to_del[] = $node;
            $parent = $node->parentNode;
            $childs = array();
            foreach ($node->childNodes as $c) {
                $childs[] = $c;
            }
            foreach ($childs as $c) {
                $node->removeChild($c);
                $parent->insertBefore($c, $node);
            }
        }
        foreach ($to_del as $n) {
            $p = $n->parentNode;
            $p->removeChild($n);
        }
        $this->update();
    }
}