ilLearningSequenceXMLWriter Class Reference

Inheritance diagram for ilLearningSequenceXMLWriter:

Collaboration diagram for ilLearningSequenceXMLWriter:

Public Member Functions
	__construct (ilObjLearningSequence $ls_object, ilSetting $il_settings, ilLPObjSettings $lp_settings, ilRbacReview $rbac_review)
	getXml ()
	start ()
Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...
	_ilXmlWriter ()
	destructor @access public More...
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...
	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...
	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...
	xmlFormatData ($data)
	Indents text for better reading. More...
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...
	xmlHeader ()
	Writes xml header @access public. More...
	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...
	xmlEndTag ($tag)
	Writes an endtag. More...
	xmlComment ($comment)
	Writes a comment. More...
	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...
	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem ($format=true)
	Returns xml document from memory. More...
	appendXML ($a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr @access public More...

Protected Member Functions
	writeHeader ()
	writeLearningSequence ()
	writeTitle ()
	writeDescription ()
	writeOwner ()
	writeLSItems ()
	writeSettings ()
	writeLPSettings ()
	encodeImage (string $path=null)
	writeFooter ()

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...
Data Fields inherited from ilXmlWriter
	$xmlStr
	$version
	$outEnc
	$inEnc
	$dtdDef = ""
	$stSheet = ""
	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

Author

Daniel Weise danie.nosp@m.l.we.nosp@m.ise@c.nosp@m.once.nosp@m.pts-a.nosp@m.nd-t.nosp@m.raini.nosp@m.ng.d.nosp@m.e

Definition at line 8 of file class.ilLearningSequenceXMLWriter.php.

Constructor & Destructor Documentation

__construct()

ilLearningSequenceXMLWriter::__construct	(	ilObjLearningSequence	$ls_object,
		ilSetting	$il_settings,
		ilLPObjSettings	$lp_settings,
		ilRbacReview	$rbac_review
	)

Definition at line 10 of file class.ilLearningSequenceXMLWriter.php.

      {
        $this->ls_object = $ls_object;
        $this->il_settings = $il_settings;
        $this->settings = $ls_object->getLSSettings();
        $this->lp_settings = $lp_settings;
        $this->rbac_review = $rbac_review;
    }

References ilObjLearningSequence\getLSSettings(), and settings().

Here is the call graph for this function:

Member Function Documentation

encodeImage()

ilLearningSequenceXMLWriter::encodeImage ( string  $path = null )

protected

Definition at line 144 of file class.ilLearningSequenceXMLWriter.php.

                                                        : string
    {
        if (is_null($path) || $path == "") {
            return "";
        }
 
        return base64_encode(file_get_contents($path));
    }

Referenced by writeSettings().

Here is the caller graph for this function:

getXml()

ilLearningSequenceXMLWriter::getXml

(

)

Definition at line 23 of file class.ilLearningSequenceXMLWriter.php.

    {
        return $this->xmlDumpMem(false);
    }

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

start()

ilLearningSequenceXMLWriter::start

(

)

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

    {
        $this->writeHeader();
        $this->writeLearningSequence();
        $this->writeTitle();
        $this->writeDescription();
        $this->writeOwner();
        $this->writeLSItems();
        $this->writeSettings();
        $this->writeLPSettings();
        $this->writeFooter();
    }

References writeDescription(), writeFooter(), writeHeader(), writeLearningSequence(), writeLPSettings(), writeLSItems(), writeOwner(), writeSettings(), and writeTitle().

Here is the call graph for this function:

writeDescription()

ilLearningSequenceXMLWriter::writeDescription ( )

protected

Definition at line 69 of file class.ilLearningSequenceXMLWriter.php.

    {
        $this->xmlElement("description", null, $this->ls_object->getDescription());
    }

References ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeFooter()

ilLearningSequenceXMLWriter::writeFooter ( )

protected

Definition at line 153 of file class.ilLearningSequenceXMLWriter.php.

    {
        $this->xmlEndTag('lso');
    }

References ilXmlWriter\xmlEndTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeHeader()

ilLearningSequenceXMLWriter::writeHeader ( )

protected

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

    {
        $this->xmlSetDtdDef(
            "<!DOCTYPE learning sequence PUBLIC \"-//ILIAS//DTD LearningSequence//EN\" \"" .
            ILIAS_HTTP_PATH . "/xml/ilias_lso_5_4.dtd\">"
        );
 
        $this->xmlSetGenCmt(
            "Export of ILIAS LearningSequence " .
            $this->ls_object->getId() .
            " of installation " .
            $this->il_settings->get("inst_id") .
            "."
        );
    }

References ILIAS_HTTP_PATH, ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeLearningSequence()

ilLearningSequenceXMLWriter::writeLearningSequence ( )

protected

Definition at line 57 of file class.ilLearningSequenceXMLWriter.php.

    {
        $att["ref_id"] = $this->ls_object->getRefId();
 
        $this->xmlStartTag("lso", $att);
    }

References ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeLPSettings()

ilLearningSequenceXMLWriter::writeLPSettings ( )

protected

Definition at line 121 of file class.ilLearningSequenceXMLWriter.php.

    {
        if (!$this->il_settings->get("enable_tracking")) {
            return;
        }
 
        $collection = ilLPCollection::getInstanceByMode(
            $this->ls_object->getId(),
            (int) $this->lp_settings->getMode()
        );
 
        if (!is_null($collection)) {
            $items = $collection->getItems();
 
            foreach ($items as $item) {
                $this->xmlElement("lp_item_ref_id", null, $item);
            }
        }
 
        $this->xmlElement("lp_type", null, $this->lp_settings->getObjType());
        $this->xmlElement("lp_mode", null, $this->lp_settings->getMode());
    }

References ilLPCollection\getInstanceByMode(), and ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeLSItems()

ilLearningSequenceXMLWriter::writeLSItems ( )

protected

Definition at line 80 of file class.ilLearningSequenceXMLWriter.php.

    {
        $ls_items = $this->ls_object->getLSItems();
 
        $this->xmlStartTag("ls_items");
 
        foreach ($ls_items as $ls_item) {
            $post_condition = $ls_item->getPostCondition();
            $att["id"] = $ls_item->getRefId();
            $this->xmlStartTag("ls_item", $att);
 
            $this->xmlElement("ls_item_pc_ref_id", null, $post_condition->getRefId());
            $this->xmlElement("ls_item_pc_condition_type", null, $post_condition->getConditionOperator());
            $this->xmlElement("ls_item_pc_value", null, $post_condition->getValue());
            $this->xmlElement("ls_item_type", null, $ls_item->getType());
            $this->xmlElement("ls_item_title", null, $ls_item->getTitle());
            $this->xmlElement("ls_item_description", null, $ls_item->getDescription());
            $this->xmlElement("ls_item_icon_path", null, $ls_item->getIconPath());
            $this->xmlElement("ls_item_is_online", null, (string) $ls_item->isOnline());
            $this->xmlElement("ls_item_order_number", null, (string) $ls_item->getOrderNumber());
 
            $this->xmlEndTag("ls_item");
        }
 
        $this->xmlEndTag("ls_items");
    }

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeOwner()

ilLearningSequenceXMLWriter::writeOwner ( )

protected

Definition at line 74 of file class.ilLearningSequenceXMLWriter.php.

    {
        $att['id'] = 'il_' . $this->il_settings->get("inst_id") . '_usr_' . $this->ls_object->getOwner();
        $this->xmlElement('owner', $att);
    }

References ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeSettings()

ilLearningSequenceXMLWriter::writeSettings ( )

protected

Definition at line 107 of file class.ilLearningSequenceXMLWriter.php.

    {
        $abstract_img = $this->settings->getAbstractImage();
        $extro_img = $this->settings->getExtroImage();
 
        $this->xmlElement("abstract", null, base64_encode($this->settings->getAbstract()));
        $this->xmlElement("extro", null, base64_encode($this->settings->getExtro()));
        $this->xmlElement("members_gallery", null, $this->settings->getMembersGallery());
        $this->xmlElement("abstract_img", null, $abstract_img);
        $this->xmlElement("extro_img", null, $extro_img);
        $this->xmlElement("abstract_img_data", null, $this->encodeImage($abstract_img));
        $this->xmlElement("extro_img_data", null, $this->encodeImage($extro_img));
    }

References encodeImage(), settings(), and ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

writeTitle()

ilLearningSequenceXMLWriter::writeTitle ( )

protected

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

    {
        $this->xmlElement("title", null, $this->ls_object->getTitle());
    }

References ilXmlWriter\xmlElement().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• Modules/LearningSequence/classes/Xml/class.ilLearningSequenceXMLWriter.php