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

Inheritance diagram for ilLearningSequenceXMLWriter:

Collaboration diagram for ilLearningSequenceXMLWriter:

Public Member Functions
	__construct (ilObjLearningSequence $ls_object, ilSetting $settings, ilLPObjSettings $lp_settings, ilRbacReview $rbac_review)

	getXml ()

	start ()

Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")

	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...

	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...

	xmlFormatData (string $data)
	Indents text for better reading. More...

	xmlHeader ()
	Writes xml header. More...

	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...

	xmlEndTag (string $tag)
	Writes an endtag. More...

	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...

	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...

	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...

	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...

	appendXML (string $a_str)
	append xml string to document More...

	xmlClear ()
	clears xmlStr More...

Protected Member Functions
	writeHeader ()

	writeLearningSequence ()

	writeTitle ()

	writeDescription ()

	writeOwner ()

	writeLSItems ()

	writeSettings ()

	writeLPSettings ()

	encodeImage (string $path=null)

	writeFooter ()

Protected Attributes
ilObjLearningSequence	$ls_object

ilSetting	$settings

ilLPObjSettings	$lp_settings

ilRbacReview	$rbac_review

ilLearningSequenceSettings	$ls_settings

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

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

Constructor & Destructor Documentation

◆ __construct()

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

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

      {
        parent::__construct();
        $this->ls_object = $ls_object;
        $this->settings = $settings;
        $this->lp_settings = $lp_settings;
        $this->rbac_review = $rbac_review;
        $this->ls_settings = $ls_object->getLSSettings();
    }

References $lp_settings, $ls_object, $rbac_review, $settings, ILIAS\GlobalScreen\Provider\__construct(), ilObjLearningSequence\getLSSettings(), and ILIAS\Repository\settings().

Here is the call graph for this function:

Member Function Documentation

◆ encodeImage()

ilLearningSequenceXMLWriter::encodeImage ( string $path = null )

protected

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

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

References $path.

Referenced by writeSettings().

Here is the caller graph for this function:

◆ getXml()

ilLearningSequenceXMLWriter::getXml ( )

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

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

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ start()

ilLearningSequenceXMLWriter::start ( )

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

                           : void
    {
        $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 89 of file class.ilLearningSequenceXMLWriter.php.

                                         : void
    {
        $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 173 of file class.ilLearningSequenceXMLWriter.php.

                                    : void
    {
        $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 61 of file class.ilLearningSequenceXMLWriter.php.

                                    : void
    {
        $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->settings->get("inst_id") .
            "."
        );
    }

References 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 77 of file class.ilLearningSequenceXMLWriter.php.

                                              : void
    {
        $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 141 of file class.ilLearningSequenceXMLWriter.php.

                                        : void
    {
        if (!$this->settings->get("enable_tracking")) {
            return;
        }
 
        $collection = ilLPCollection::getInstanceByMode(
            $this->ls_object->getId(),
            $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(), ILIAS\Repository\settings(), 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 100 of file class.ilLearningSequenceXMLWriter.php.

                                     : void
    {
        $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 94 of file class.ilLearningSequenceXMLWriter.php.

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

References ILIAS\Repository\settings(), and 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 127 of file class.ilLearningSequenceXMLWriter.php.

                                      : void
    {
        $abstract_img = $this->ls_settings->getAbstractImage();
        $extro_img = $this->ls_settings->getExtroImage();
 
        $this->xmlElement("abstract", null, base64_encode($this->ls_settings->getAbstract()));
        $this->xmlElement("extro", null, base64_encode($this->ls_settings->getExtro()));
        $this->xmlElement("members_gallery", null, $this->ls_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(), 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 84 of file class.ilLearningSequenceXMLWriter.php.

                                   : void
    {
        $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

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ encodeImage()

◆ getXml()

◆ start()

◆ writeDescription()

◆ writeFooter()

◆ writeHeader()

◆ writeLearningSequence()

◆ writeLPSettings()

◆ writeLSItems()

◆ writeOwner()

◆ writeSettings()

◆ writeTitle()

Field Documentation

◆ $lp_settings

◆ $ls_object

◆ $ls_settings

◆ $rbac_review

◆ $settings