ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilContainerReferenceXmlWriter Class Reference

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
 ilXmlWriter ($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...
 
 _xmlEscapeData ($data)
 Escapes reserved characters. 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...
 

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 @global <type> $ilSetting. More...
 
 buildTarget ()
 Build target element. More...
 
 buildTitle ()
 Build title element. More...
 
 buildReference ()
 Build category xml. More...
 
 buildFooter ()
 Add footer elements. More...
 

Private Attributes

 $mode = self::MODE_SOAP
 
 $xml
 
 $ref
 

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
stringxml version
stringoutput encoding
stringinput encoding @access public

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

29 {
30 parent::__construct();
31 $this->ref = $ref;
32 }

References $ref.

Member Function Documentation

◆ buildFooter()

ilContainerReferenceXmlWriter::buildFooter ( )
protected

Add footer elements.

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

145 {
146 $this->xmlEndTag('ContainerReference');
147 }
xmlEndTag($tag)
Writes an endtag.

References ilXmlWriter\xmlEndTag().

Referenced by export().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ buildHeader()

ilContainerReferenceXmlWriter::buildHeader ( )
protected

Build xml header @global <type> $ilSetting.

Returns
<type>

Reimplemented in ilCategoryReferenceXmlWriter, and ilCourseReferenceXmlWriter.

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

95 {
96 global $ilSetting;
97
98 $this->xmlSetDtdDef("<!DOCTYPE container reference PUBLIC \"-//ILIAS//DTD Group//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_container_reference_4_3.dtd\">");
99 $this->xmlSetGenCmt("Export of ILIAS container reference ". $this->getReference()->getId()." of installation ".$ilSetting->get('inst_id').".");
100 $this->xmlHeader();
101
102 return true;
103 }
xmlSetGenCmt($genCmt)
Sets generated comment.
xmlHeader()
Writes xml header @access public.
xmlSetDtdDef($dtdDef)
Sets dtd definition.
global $ilSetting
Definition: privfeed.php:40

References $ilSetting, getReference(), 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:

◆ buildReference()

ilContainerReferenceXmlWriter::buildReference ( )
protected

Build category xml.

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

137 {
138 $this->xmlStartTag('ContainerReference');
139 }
xmlStartTag($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
Writes a starttag.

References ilXmlWriter\xmlStartTag().

Referenced by export().

+ 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 108 of file class.ilContainerReferenceXmlWriter.php.

109 {
110 $this->xmlElement('Target', array('id' => $this->getReference()->getTargetId()));
111 }
xmlElement($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
Writes a basic element (no children, just textual content)

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

Referenced by export().

+ 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 116 of file class.ilContainerReferenceXmlWriter.php.

117 {
118 $title = '';
119 if($this->getReference()->getTitleType() == ilContainerReference::TITLE_TYPE_CUSTOM)
120 {
121 $title = $this->getReference()->getTitle();
122 }
123
124 $this->xmlElement(
125 'Title',
126 array(
127 'type' => $this->getReference()->getTitleType()
128 ),
129 $title
130 );
131 }

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

Referenced by export().

+ 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 65 of file class.ilContainerReferenceXmlWriter.php.

66 {
67 if($this->getMode() == self::MODE_EXPORT)
68 {
69 if($a_with_header)
70 {
71 $this->buildHeader();
72 }
73 $this->buildReference();
74 $this->buildTarget();
75 $this->buildTitle();
76 $this->buildFooter();
77 }
78 }
buildHeader()
Build xml header @global <type> $ilSetting.

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

+ Here is the call graph for this function:

◆ getMode()

ilContainerReferenceXmlWriter::getMode ( )

get export mode

Returns
int

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

References $mode.

Referenced by export().

+ Here is the caller graph for this function:

◆ getReference()

ilContainerReferenceXmlWriter::getReference ( )

Get category object.

Returns
ilContainerReference

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

57 {
58 return $this->ref;
59 }

References $ref.

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

+ Here is the caller graph for this function:

◆ getXml()

ilContainerReferenceXmlWriter::getXml ( )

get XML

Returns
string

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

85 {
86 return $this->xmlDumpMem(false);
87 }
xmlDumpMem($format=TRUE)
Returns xml document from memory.

References ilXmlWriter\xmlDumpMem().

+ Here is the call graph for this function:

◆ setMode()

ilContainerReferenceXmlWriter::setMode (   $a_mode)

Set export mode.

Parameters
int$a_mode

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

39 {
40 $this->mode = $a_mode;
41 }

Field Documentation

◆ $mode

ilContainerReferenceXmlWriter::$mode = self::MODE_SOAP
private

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

Referenced by getMode().

◆ $ref

ilContainerReferenceXmlWriter::$ref
private

◆ $xml

ilContainerReferenceXmlWriter::$xml
private

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

◆ MODE_EXPORT

const ilContainerReferenceXmlWriter::MODE_EXPORT = 2

◆ MODE_SOAP

const ilContainerReferenceXmlWriter::MODE_SOAP = 1

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


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