ilCourseReferenceXmlWriter Class Reference

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

Inheritance diagram for ilCourseReferenceXmlWriter:

Collaboration diagram for ilCourseReferenceXmlWriter:

Public Member Functions
	__construct (?ilObjCourseReference $ref=null)
	constructor More...
	export (bool $a_with_header=true)
	Start writing xml. More...
Public Member Functions inherited from ilContainerReferenceXmlWriter
	__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...

Protected Member Functions
	buildCourseSettings ()
	Add member update setting. More...
	buildHeader ()
	Build xml header. More...
Protected Member Functions inherited from ilContainerReferenceXmlWriter
	buildHeader ()
	buildTarget ()
	buildTitle ()
	buildReference ()
	buildFooter ()

Additional Inherited Members
Data Fields inherited from ilContainerReferenceXmlWriter
const	MODE_SOAP = 1
const	MODE_EXPORT = 2
Protected Attributes inherited from ilContainerReferenceXmlWriter
ilSetting	$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 Class for container reference export

Author

Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e $Id$

Definition at line 25 of file class.ilCourseReferenceXmlWriter.php.

Constructor & Destructor Documentation

__construct()

ilCourseReferenceXmlWriter::__construct

(

?ilObjCourseReference

$ref = null

)

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References ilContainerReferenceXmlWriter\$ref, and ILIAS\GlobalScreen\Provider\__construct().

    {
        parent::__construct($ref);
    }

Here is the call graph for this function:

Member Function Documentation

buildCourseSettings()

ilCourseReferenceXmlWriter::buildCourseSettings ( )

protected

Add member update setting.

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

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

Referenced by export().

    {
        $this->xmlElement('MemberUpdate', [], $this->getReference()->isMemberUpdateEnabled() ? 1 : 0);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

ilCourseReferenceXmlWriter::buildHeader ( )

protected

Build xml header.

Returns

void <type> $ilSetting

Definition at line 71 of file class.ilCourseReferenceXmlWriter.php.

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

Referenced by export().

                                    : void
    {
        global $ilSetting;

        $this->xmlSetGenCmt("Export of ILIAS course 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:

export()

ilCourseReferenceXmlWriter::export

(

bool

$a_with_header = true

)

Start writing xml.

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

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

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

Here is the call graph for this function:

---

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

• components/ILIAS/CourseReference/classes/class.ilCourseReferenceXmlWriter.php