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

Inheritance diagram for ilContainerReferenceXmlWriter:

Collaboration diagram for ilContainerReferenceXmlWriter:

Public Member Functions
	__construct (ilContainerReference $ref=null)

	setMode (int $a_mode)

	getMode ()

	getReference ()

	export (bool $a_with_header=true)

	getXml ()

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	MODE_SOAP = 1

const	MODE_EXPORT = 2

Protected Member Functions
	buildHeader ()

	buildTarget ()

	buildTitle ()

	buildReference ()

	buildFooter ()

Protected Attributes
ilSetting	$settings

Private Attributes
int	$mode = self::MODE_SOAP

ilContainerReference	$ref

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 Class for container reference export

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

Definition at line 26 of file class.ilContainerReferenceXmlWriter.php.

Constructor & Destructor Documentation

◆ __construct()

ilContainerReferenceXmlWriter::__construct ( ilContainerReference $ref = null )

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

References $DIC, $ref, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->settings = $DIC->settings();
         parent::__construct();
         $this->ref = $ref;
     }

Here is the call graph for this function:

Member Function Documentation

◆ buildFooter()

ilContainerReferenceXmlWriter::buildFooter ( )

protected

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

References ilXmlWriter\xmlEndTag().

Referenced by ilCourseReferenceXmlWriter\export(), and export().

                                     : void
     {
         $this->xmlEndTag('ContainerReference');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

ilContainerReferenceXmlWriter::buildHeader ( )

protected

Definition at line 78 of file class.ilContainerReferenceXmlWriter.php.

References $ilSetting, $settings, ILIAS\Survey\Mode\getId(), getReference(), ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by export().

                                     : void
     {
         $ilSetting = $this->settings;
 
         $this->xmlSetDtdDef("<!DOCTYPE container reference PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_container_reference_4_3.dtd\">");
         $this->xmlSetGenCmt("Export of ILIAS container reference " . $this->getReference()->getId() . " of installation " . $ilSetting->get('inst_id') . ".");
         $this->xmlHeader();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildReference()

ilContainerReferenceXmlWriter::buildReference ( )

protected

Definition at line 108 of file class.ilContainerReferenceXmlWriter.php.

References ilXmlWriter\xmlStartTag().

Referenced by ilCourseReferenceXmlWriter\export(), and export().

                                        : void
     {
         $this->xmlStartTag('ContainerReference');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTarget()

ilContainerReferenceXmlWriter::buildTarget ( )

protected

Definition at line 87 of file class.ilContainerReferenceXmlWriter.php.

References getReference(), and ilXmlWriter\xmlElement().

Referenced by ilCourseReferenceXmlWriter\export(), and export().

                                     : void
     {
         $this->xmlElement('Target', ['id' => $this->getReference()->getTargetId()]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

ilContainerReferenceXmlWriter::buildTitle ( )

protected

Definition at line 92 of file class.ilContainerReferenceXmlWriter.php.

References getReference(), ilContainerReference\TITLE_TYPE_CUSTOM, and ilXmlWriter\xmlElement().

Referenced by ilCourseReferenceXmlWriter\export(), and export().

                                    : void
     {
         $title = '';
         if ($this->getReference()->getTitleType() === ilContainerReference::TITLE_TYPE_CUSTOM) {
             $title = $this->getReference()->getTitle();
         }
 
         $this->xmlElement(
             'Title',
             [
                     'type' => $this->getReference()->getTitleType()
             ],
             $title
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ export()

ilContainerReferenceXmlWriter::export ( bool $a_with_header = true )

Definition at line 60 of file class.ilContainerReferenceXmlWriter.php.

References buildFooter(), buildHeader(), buildReference(), buildTarget(), buildTitle(), and getMode().

                                                       : void
     {
         if ($this->getMode() === self::MODE_EXPORT) {
             if ($a_with_header) {
                 $this->buildHeader();
             }
             $this->buildReference();
             $this->buildTarget();
             $this->buildTitle();
             $this->buildFooter();
         }
     }

Here is the call graph for this function:

◆ getMode()

ilContainerReferenceXmlWriter::getMode ( )

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

References $mode.

Referenced by ilCourseReferenceXmlWriter\export(), and export().

                              : int
     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getReference()

ilContainerReferenceXmlWriter::getReference ( )

Definition at line 55 of file class.ilContainerReferenceXmlWriter.php.

References $ref.

Referenced by ilCourseReferenceXmlWriter\buildCourseSettings(), ilGroupReferenceXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), buildHeader(), buildTarget(), and buildTitle().

                                   : ?ilContainerReference
     {
         return $this->ref;
     }

Here is the caller graph for this function:

◆ getXml()

ilContainerReferenceXmlWriter::getXml ( )

Definition at line 73 of file class.ilContainerReferenceXmlWriter.php.

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ setMode()

ilContainerReferenceXmlWriter::setMode ( int $a_mode )

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

                                         : void
     {
         $this->mode = $a_mode;
     }

Field Documentation

◆ $mode

int ilContainerReferenceXmlWriter::$mode = self::MODE_SOAP

private

Definition at line 33 of file class.ilContainerReferenceXmlWriter.php.

Referenced by getMode().

◆ $ref

ilContainerReference ilContainerReferenceXmlWriter::$ref

private

Definition at line 34 of file class.ilContainerReferenceXmlWriter.php.

Referenced by ilGroupReferenceXmlWriter\__construct(), ilCourseReferenceXmlWriter\__construct(), ilCategoryReferenceXmlWriter\__construct(), __construct(), and getReference().

◆ $settings

ilSetting ilContainerReferenceXmlWriter::$settings

protected

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

Referenced by ilCategoryReferenceXmlWriter\buildHeader(), and buildHeader().

◆ MODE_EXPORT

const ilContainerReferenceXmlWriter::MODE_EXPORT = 2

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

Referenced by ilContainerReferenceExporter\getXmlRepresentation().

◆ MODE_SOAP

const ilContainerReferenceXmlWriter::MODE_SOAP = 1

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

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

Services/ContainerReference/classes/class.ilContainerReferenceXmlWriter.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFooter()

◆ buildHeader()

◆ buildReference()

◆ buildTarget()

◆ buildTitle()

◆ export()

◆ getMode()

◆ getReference()

◆ getXml()

◆ setMode()

Field Documentation

◆ $mode

◆ $ref

◆ $settings

◆ MODE_EXPORT

◆ MODE_SOAP