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

Inheritance diagram for ilContainerXmlWriter:

Collaboration diagram for ilContainerXmlWriter:

Public Member Functions
	__construct (int $a_ref_id)

	write ()
	Write XML. More...

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
	writeSubitems (int $a_ref_id)
	Write tree childs Recursive method. More...

	writeCourseItemInformation (int $a_ref_id)
	Write course item information Starting time, ending time... More...

	buildHeader ()

Protected Attributes
ilTree	$tree

ilExportOptions	$exp_options = null

ilObjectDefinition	$objDefinition

Private Attributes
int	$source = 0

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 XML writer for container structure

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 24 of file class.ilContainerXmlWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerXmlWriter::__construct ( int $a_ref_id )

Definition at line 31 of file class.ilContainerXmlWriter.php.

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ilExportOptions\getInstance().

     {
         global $DIC;
 
         $this->tree = $DIC->repositoryTree();
         parent::__construct();
         $this->source = $a_ref_id;
         $this->exp_options = ilExportOptions::getInstance();
         $this->objDefinition = $DIC['objDefinition'];
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildHeader()

ilContainerXmlWriter::buildHeader ( )

protected

Definition at line 136 of file class.ilContainerXmlWriter.php.

References ilXmlWriter\xmlHeader(), and ilXmlWriter\xmlSetGenCmt().

                                     : void
     {
         $this->xmlSetGenCmt("Container object");
         $this->xmlHeader();
     }

Here is the call graph for this function:

◆ write()

ilContainerXmlWriter::write ( )

Write XML.

Exceptions

UnexpectedValueException Thrown if obj_id is not of type webr or no obj_id is given

Definition at line 46 of file class.ilContainerXmlWriter.php.

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

                            : void
     {
         $this->xmlStartTag('Items');
         $this->writeSubitems($this->source);
         $this->xmlEndTag('Items');
     }

Here is the call graph for this function:

◆ writeCourseItemInformation()

ilContainerXmlWriter::writeCourseItemInformation ( int $a_ref_id )

protected

Write course item information Starting time, ending time...

Definition at line 100 of file class.ilContainerXmlWriter.php.

References ilObjectActivation\getItem(), IL_CAL_DATETIME, IL_CAL_UNIX, ilTimeZone\UTC, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by writeSubitems().

                                                                 : void
     {
         $item = ilObjectActivation::getItem($a_ref_id);
 
         $this->xmlStartTag(
             'Timing',
             [
                 'Type' => $item['timing_type'],
                 'Visible' => $item['visible'],
                 'Changeable' => $item['changeable'],
             ]
         );
         if ($item['timing_start']) {
             $tmp_date = new ilDateTime($item['timing_start'], IL_CAL_UNIX);
             $this->xmlElement('Start', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
         }
         if ($item['timing_end']) {
             $tmp_date = new ilDateTime($item['timing_end'], IL_CAL_UNIX);
             $this->xmlElement('End', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
         }
         if ($item['suggestion_start']) {
             $tmp_date = new ilDateTime($item['suggestion_start'], IL_CAL_UNIX);
             $this->xmlElement('SuggestionStart', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
         }
         if ($item['suggestion_end']) {
             $tmp_date = new ilDateTime($item['suggestion_end'], IL_CAL_UNIX);
             $this->xmlElement('SuggestionEnd', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
         }
         if ($item['earliest_start'] ?? false) {
             $tmp_date = new ilDateTime($item['earliest_start'], IL_CAL_UNIX);
             $this->xmlElement('EarliestStart', [], $tmp_date->get(IL_CAL_DATETIME, '', ilTimeZone::UTC));
         }
 
         $this->xmlEndTag('Timing');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeSubitems()

ilContainerXmlWriter::writeSubitems ( int $a_ref_id )

protected

Write tree childs Recursive method.

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

References $tree, ilPageObject\_exists(), ilObject\_lookupObjId(), ilObject\_lookupTitle(), ilObject\_lookupType(), ilExportOptions\EXPORT_OMIT, ilTree\getChilds(), ilExportOptions\KEY_ITEM_MODE, ilObjStyleSheet\lookupObjectStyle(), ilObject\lookupOfflineStatus(), null, writeCourseItemInformation(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by write().

                                                    : void
     {
         $tree = $this->tree;
 
         // because of the co-page-stuff (incl. styles) we also need to process the container itself
         if ($a_ref_id != $this->source) {
             $mode = $this->exp_options->getOptionByRefId($a_ref_id, ilExportOptions::KEY_ITEM_MODE);
             if ($mode == null || $mode == ilExportOptions::EXPORT_OMIT) {
                 return;
             }
         }
 
         $obj_id = ilObject::_lookupObjId($a_ref_id);
 
         $atts = [];
         $atts['RefId'] = $a_ref_id;
         $atts['Id'] = $obj_id;
         $atts['Title'] = ilObject::_lookupTitle($obj_id);
         $atts['Type'] = ilObject::_lookupType($obj_id);
         $atts['Page'] = ilContainerPage::_exists('cont', $obj_id);
         $atts['StartPage'] = ilContainerStartObjectsPage::_exists('cstr', $obj_id);
         $atts['Style'] = ilObjStyleSheet::lookupObjectStyle($obj_id);
         if ($this->objDefinition->supportsOfflineHandling($atts['Type'])) {
             $atts['Offline'] = ilObject::lookupOfflineStatus($obj_id) ? '1' : '0';
         }
         $this->xmlStartTag(
             'Item',
             $atts
         );
         $this->writeCourseItemInformation($a_ref_id);
 
         foreach ($tree->getChilds($a_ref_id) as $node) {
             $this->writeSubitems($node['child']);
         }
 
         $this->xmlEndTag('Item');
     }