Content Object (ILIAS native learning module / digilib book) Manifest export class. More...

Collaboration diagram for ilLMContObjectManifestBuilder:

Public Member Functions
	__construct ($a_cont_obj)
	Constructor @access public. More...

	buildManifest ()
	build manifest structure More...

	dump ($a_target_dir)
	dump manifest file into directory More...

	writeItemHierarchy ()
	write item hierarchy More...

	writeResources ()
	write resources More...

Data Fields
	$db

	$cont_obj

	$inst_id

Detailed Description

Content Object (ILIAS native learning module / digilib book) Manifest export class.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLMContObjectManifestBuilder::__construct ( $a_cont_obj )

Constructor @access public.

Definition at line 25 of file class.ilLMContObjectManifestBuilder.php.

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $this->cont_obj = $a_cont_obj;
 
        $this->db = $ilDB;
 
        $this->inst_id = IL_INST_ID;
    }

References $DIC, $ilDB, and IL_INST_ID.

Member Function Documentation

◆ buildManifest()

ilLMContObjectManifestBuilder::buildManifest ( )

build manifest structure

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

    {
        $this->writer = new ilXmlWriter;
 
        // set xml header
        $this->writer->xmlHeader();
 
        // manifest start tag
        $attrs = array();
        $attrs["identifier"] = "il_" . IL_INST_ID . "_" . "man" .
            "_" . $this->cont_obj->getId();
        $attrs["version"] = "";
        $attrs["xmlns:xsi"] = "http://www.w3.org/2001/XMLSchema-instance";
        $attrs["xsi:schemaLocation"] = "http://www.imsproject.org/xsd/imscp_rootv1p1p2" .
            " imscp_rootv1p1p2.xsd" .
            " http://www.imsglobal.org/xsd/imsmd_rootv1p2p1" .
            " imsmd_rootv1p2p1.xsd" .
            " http://www.adlnet.org/xsd/adlcp_rootv1p2" .
            " adlcp_rootv1p2.xsd";
        $attrs["xmlns:imsmd"] = "http://www.imsproject.org/xsd/imsmd_rootv1p2p1";
        $attrs["xmlns:adlcp"] = "http://www.adlnet.org/xsd/adlcp_rootv1p2";
        $attrs["xmlns"] = "http://www.imsproject.org/xsd/imscp_rootv1p1p2";
        $this->writer->xmlStartTag("manifest", $attrs);
 
        // organizations start tag
        $attrs = array();
        $this->writer->xmlStartTag("organizations", $attrs);
 
        // organization start tag
        $attrs = array();
        $attrs["identifier"] = "il_" . IL_INST_ID . "_" . $this->cont_obj->getType() .
            "_" . $this->cont_obj->getId();
        $attrs["structure"] = "hierarchical";
        $this->writer->xmlStartTag("organization", $attrs);
        
        // title element
        $attrs = array();
        $this->writer->xmlElement("title", $attrs, $this->cont_obj->getTitle());
        
        // write item hierarchy
        $this->writeItemHierarchy();
 
        // organization end tag
        $this->writer->xmlEndTag("organization");
        
        // organizations end tag
        $this->writer->xmlEndTag("organizations");
        
        // resources start tag
        $attrs = array();
        $this->writer->xmlStartTag("resources", $attrs);
        
        // write resources
        $this->writeResources();
 
        // resources end tag
        $this->writer->xmlEndTag("resources");
        
        // manifest end tag
        $this->writer->xmlEndTag("manifest");
        
        // write manifest file
        //$this->xml->xmlDumpFile($this->export_dir."/".$this->subdir."/".$this->filename
        //      , false);
            
        // destroy writer object
        $this->writer->_XmlWriter;
    }

References IL_INST_ID, writeItemHierarchy(), writeResources(), and ilXmlWriter\xmlHeader().

Here is the call graph for this function:

◆ dump()

ilLMContObjectManifestBuilder::dump ( $a_target_dir )

dump manifest file into directory

Definition at line 113 of file class.ilLMContObjectManifestBuilder.php.

    {
        $this->writer->xmlDumpFile($a_target_dir . "/imsmanifest.xml", false);
    }

◆ writeItemHierarchy()

ilLMContObjectManifestBuilder::writeItemHierarchy ( )

write item hierarchy

this first version only writes one item for the whole learning module

Definition at line 123 of file class.ilLMContObjectManifestBuilder.php.

    {
        // start item
        $attrs = array();
        $attrs["identifier"] = "INDEX";
        $attrs["identifierref"] = "RINDEX";
        $this->writer->xmlStartTag("item", $attrs);
        
        // title element
        $attrs = array();
        $this->writer->xmlElement("title", $attrs, $this->cont_obj->getTitle());
        
        // end item
        $this->writer->xmlEndTag("item");
    }

Referenced by buildManifest().

Here is the caller graph for this function:

◆ writeResources()

ilLMContObjectManifestBuilder::writeResources ( )

write resources

this first version only writes one resource for the whole learning module

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

    {
        $attrs = array();
        $attrs["identifier"] = "RINDEX";
        $attrs["type"] = "webcontent";
        $attrs["adlcp:scormtype"] = "asset";
        $attrs["href"] = "res/index.html";
        $this->writer->xmlElement("resource", $attrs, "");
    }