Class for container reference export. More...

Inheritance diagram for ilContainerReferenceXmlWriter:

Collaboration diagram for ilContainerReferenceXmlWriter:

Public Member Functions
	__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 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 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 public More...

Data Fields
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 Member Functions
	buildHeader ()
	Build xml header <type> $ilSetting. More...

	buildTarget ()
	Build target element. More...

	buildTitle ()
	Build title element. More...

	buildReference ()
	Build category xml. More...

	buildFooter ()
	Add footer elements. More...

Protected Attributes
	$settings

Private Attributes
	$mode = self::MODE_SOAP

	$xml

	$ref

Additional Inherited Members
Static Public Member Functions inherited from ilXmlWriter
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerReferenceXmlWriter::__construct ( ilContainerReference $ref = null )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

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

References $DIC, $ref, and 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

Add footer elements.

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

References ilXmlWriter\xmlEndTag().

Referenced by export().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildHeader()

ilContainerReferenceXmlWriter::buildHeader ( )

protected

Build xml header <type> $ilSetting.

Returns: <type>

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

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

Referenced by export().

     {
         $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();
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildReference()

ilContainerReferenceXmlWriter::buildReference ( )

protected

Build category xml.

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

References ilXmlWriter\xmlStartTag().

Referenced by export().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTarget()

ilContainerReferenceXmlWriter::buildTarget ( )

protected

Build target element.

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

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

Referenced by export().

     {
         $this->xmlElement('Target', array('id' => $this->getReference()->getTargetId()));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ buildTitle()

ilContainerReferenceXmlWriter::buildTitle ( )

protected

Build title element.

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

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

Referenced by export().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ export()

ilContainerReferenceXmlWriter::export ( $a_with_header = true )

Start wrting xml.

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

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

     {
         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 ( )

get export mode

Returns: int

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

References $mode.

Referenced by export().

     {
         return $this->mode;
     }

Here is the caller graph for this function:

◆ getReference()

ilContainerReferenceXmlWriter::getReference ( )

Get category object.

Returns: ilContainerReference

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

References $ref.

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

     {
         return $this->ref;
     }

Here is the caller graph for this function:

◆ getXml()

ilContainerReferenceXmlWriter::getXml ( )

get XML

Returns: string

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

◆ setMode()

ilContainerReferenceXmlWriter::setMode ( $a_mode )

Set export mode.

Parameters

int $a_mode

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

     {
         $this->mode = $a_mode;
     }

Field Documentation

◆ $mode

ilContainerReferenceXmlWriter::$mode = self::MODE_SOAP

private

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

Referenced by getMode().

◆ $ref

ilContainerReferenceXmlWriter::$ref

private

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

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

◆ $settings

ilContainerReferenceXmlWriter::$settings

protected

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

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

◆ $xml

ilContainerReferenceXmlWriter::$xml

private

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

◆ MODE_EXPORT

const ilContainerReferenceXmlWriter::MODE_EXPORT = 2

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

Referenced by ilContainerReferenceExporter\getXmlRepresentation().

◆ MODE_SOAP

const ilContainerReferenceXmlWriter::MODE_SOAP = 1

Definition at line 19 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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ buildFooter()

◆ buildHeader()

◆ buildReference()

◆ buildTarget()

◆ buildTitle()

◆ export()

◆ getMode()

◆ getReference()

◆ getXml()

◆ setMode()

Field Documentation

◆ $mode

◆ $ref

◆ $settings

◆ $xml

◆ MODE_EXPORT

◆ MODE_SOAP