ilCourseReferenceXmlWriter Class Reference

Class for container reference export. More...

Inheritance diagram for ilCourseReferenceXmlWriter:

Collaboration diagram for ilCourseReferenceXmlWriter:

Public Member Functions
	__construct (ilObjCourseReference $ref=null)
	constructor More...
	export ($a_with_header=true)
	Start writing xml. More...
Public Member Functions inherited from ilContainerReferenceXmlWriter
	__construct (ilContainerReference $ref=null)
	constructor More...
	setMode ($a_mode)
	Set export mode. More...
	getMode ()
	get export mode More...
	getReference ()
	Get category object. More...
	export ($a_with_header=true)
	Start wrting xml. More...
	getXml ()
	get XML More...
Public Member Functions inherited from ilXmlWriter
	__construct ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor More...
	_ilXmlWriter ()
	destructor @access public More...
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition. More...
	xmlSetStSheet ($stSheet)
	Sets stylesheet. More...
	xmlSetGenCmt ($genCmt)
	Sets generated comment. More...
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding. More...
	xmlFormatData ($data)
	Indents text for better reading. More...
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly. More...
	xmlHeader ()
	Writes xml header @access public. More...
	xmlStartTag ($tag, $attrs=null, $empty=false, $encode=true, $escape=true)
	Writes a starttag. More...
	xmlEndTag ($tag)
	Writes an endtag. More...
	xmlComment ($comment)
	Writes a comment. More...
	xmlData ($data, $encode=true, $escape=true)
	Writes data. More...
	xmlElement ($tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile ($file, $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem ($format=true)
	Returns xml document from memory. More...
	appendXML ($a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr @access public More...

Protected Member Functions
	buildCourseSettings ()
	Add member update setting. More...
	buildHeader ()
	Build xml header @global <type> $ilSetting. More...
Protected Member Functions inherited from ilContainerReferenceXmlWriter
	buildHeader ()
	Build xml header. More...
	buildTarget ()
	Build target element. More...
	buildTitle ()
	Build title element. More...
	buildReference ()
	Build category xml. More...
	buildFooter ()
	Add footer elements. More...

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...
Data Fields inherited from ilContainerReferenceXmlWriter
const	MODE_SOAP = 1
const	MODE_EXPORT = 2
Data Fields inherited from ilXmlWriter
	$xmlStr
	$version
	$outEnc
	$inEnc
	$dtdDef = ""
	$stSheet = ""
	$genCmt = "Generated by ILIAS XmlWriter"
Protected Attributes inherited from ilContainerReferenceXmlWriter
	$settings

Detailed Description

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 12 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 @access public

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

    {
        parent::__construct($ref);
    }

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

Here is the call graph for this function:

Member Function Documentation

buildCourseSettings()

ilCourseReferenceXmlWriter::buildCourseSettings ( )

protected

Add member update setting.

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

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

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

Referenced by export().

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

ilCourseReferenceXmlWriter::buildHeader ( )

protected

Build xml header @global <type> $ilSetting.

Returns

<type>

Reimplemented from ilContainerReferenceXmlWriter.

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

    {
        global $ilSetting;
 
        $this->xmlSetDtdDef("<!DOCTYPE course reference PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_course_reference_4_3.dtd\">");
        $this->xmlSetGenCmt("Export of ILIAS course reference " . $this->getReference()->getId() . " of installation " . $ilSetting->get('inst_id') . ".");
        $this->xmlHeader();
 
        return true;
    }

References $ilSetting, ilContainerReferenceXmlWriter\getReference(), ILIAS_HTTP_PATH, ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by export().

Here is the call graph for this function:

Here is the caller graph for this function:

export()

ilCourseReferenceXmlWriter::export

(

$a_with_header = true

)

Start writing xml.

Reimplemented from ilContainerReferenceXmlWriter.

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

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

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

Here is the call graph for this function:

---

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

• Modules/CourseReference/classes/class.ilCourseReferenceXmlWriter.php