Inheritance diagram for ilLearningSequenceXMLWriter:

Collaboration diagram for ilLearningSequenceXMLWriter:

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

	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...

Data Fields
const	TAG_LSO = 'LearningSequence'

const	TAG_LSITEMS = 'LSItems'

const	TAG_LSITEM = 'LSItem'

const	TAG_MEMBERSGALLERY = 'MembersGallery'

const	TAG_CONDITION = 'Condition'

const	TAG_LPSETTING = 'LPSetting'

const	TAG_LPREFID = 'LPRefId'

const	TAG_TITLE = 'title'

const	TAG_DESCRIPTION = 'description'

const	TAG_CONTAINERSETTING = 'ContainerSetting'

Protected Member Functions
	writeHeader ()

	writeLearningSequence ()

	writeLPSettings ()

	writeLSItems ()

	writeFooter ()

Protected Attributes
ilLearningSequenceSettings	$ls_settings

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

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

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

References ILIAS\GlobalScreen\Provider\__construct(), and ilObjLearningSequence\getLSSettings().

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

Here is the call graph for this function:

Member Function Documentation

◆ getXml()

ilLearningSequenceXMLWriter::getXml ( )

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ start()

ilLearningSequenceXMLWriter::start ( )

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

References writeFooter(), writeHeader(), writeLearningSequence(), and writeLSItems().

                            : void
     {
         $this->writeHeader();
         $this->writeLearningSequence();
         $this->writeLSItems();
         $this->writeFooter();
     }

Here is the call graph for this function:

◆ writeFooter()

ilLearningSequenceXMLWriter::writeFooter ( )

protected

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

                                     : void
     {
         $this->xmlEndTag(self::TAG_LSO);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeHeader()

ilLearningSequenceXMLWriter::writeHeader ( )

protected

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

References ILIAS\Repository\settings(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLearningSequence()

ilLearningSequenceXMLWriter::writeLearningSequence ( )

protected

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

References ilContainer\_exportContainerSettings(), null, writeLPSettings(), ilXmlWriter\xmlElement(), and ilXmlWriter\xmlStartTag().

Referenced by start().

                                               : void
     {
         $attributes = [
             'ref_id' => $this->ls_object->getRefId(),
             'members_gallery' => $this->ls_settings->getMembersGallery() ? 'true' : 'false'
         ];
         $this->xmlStartTag(self::TAG_LSO, $attributes);
 
         $this->xmlElement(self::TAG_TITLE, null, $this->ls_object->getTitle());
         if ($desc = $this->ls_object->getDescription()) {
             $this->xmlElement(self::TAG_DESCRIPTION, null, $desc);
         }
 
         $this->writeLPSettings();
         \ilContainer::_exportContainerSettings($this, $this->ls_object->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLPSettings()

ilLearningSequenceXMLWriter::writeLPSettings ( )

protected

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

References ilLPCollection\getInstanceByMode(), null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by writeLearningSequence().

                                         : void
     {
         $type = $this->lp_settings->getObjType();
         $mode = $this->lp_settings->getMode();
         $this->xmlStartTag(
             self::TAG_LPSETTING,
             [
                 'type' => $type,
                 'mode' => $mode
             ]
         );
         $collection = ilLPCollection::getInstanceByMode(
             $this->ls_object->getId(),
             $mode
         );
         if (!is_null($collection)) {
             $items = $collection->getItems();
             foreach ($items as $item) {
                 $this->xmlElement(self::TAG_LPREFID, null, $item);
             }
         }
         $this->xmlEndTag(self::TAG_LPSETTING);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLSItems()

ilLearningSequenceXMLWriter::writeLSItems ( )

protected

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

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

Referenced by start().

                                      : void
     {
         $this->xmlStartTag(self::TAG_LSITEMS);
 
         $ls_items = $this->ls_object->getLSItems();
         foreach ($ls_items as $ls_item) {
             $post_condition = $ls_item->getPostCondition();
 
             $this->xmlStartTag(
                 self::TAG_LSITEM,
                 [
                     'obj_id' => \ilObject::_lookupObjectId($ls_item->getRefId()),
                     'ref_id' => $ls_item->getRefId()
                 ]
             );
 
             $this->xmlElement(
                 self::TAG_CONDITION,
                 ['type' => $post_condition->getConditionOperator()],
                 $post_condition->getValue()
             );
 
             $this->xmlEndTag(self::TAG_LSITEM);
         }
 
         $this->xmlEndTag(self::TAG_LSITEMS);
     }