ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilGroupReferenceXmlWriter Class Reference

Class for container reference export. More...

+ Inheritance diagram for ilGroupReferenceXmlWriter:
+ Collaboration diagram for ilGroupReferenceXmlWriter:

Public Member Functions

 __construct (ilObjGroupReference $ref=null)
 ilGroupReferenceXmlWriter constructor. 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 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...
 

Protected Member Functions

 buildHeader ()
 Build xml header ilSetting $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
Fabian Wolf wolf@.nosp@m.leif.nosp@m.os.co.nosp@m.m

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

Constructor & Destructor Documentation

◆ __construct()

ilGroupReferenceXmlWriter::__construct ( ilObjGroupReference  $ref = null)

ilGroupReferenceXmlWriter constructor.

Parameters
ilObjGroupReference | null$ref

Definition at line 21 of file class.ilGroupReferenceXmlWriter.php.

References ilContainerReferenceXmlWriter\$ref.

22  {
23  parent::__construct($ref);
24  }

Member Function Documentation

◆ buildHeader()

ilGroupReferenceXmlWriter::buildHeader ( )
protected

Build xml header ilSetting $ilSetting.

Returns
bool

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

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

32  {
33  global $DIC;
34 
35  $ilSetting = $DIC['ilSetting'];
36 
37  $this->xmlSetDtdDef("<!DOCTYPE course reference PUBLIC \"-//ILIAS//DTD Group//EN\" \"" . ILIAS_HTTP_PATH . "/xml/ilias_course_reference_4_3.dtd\">");
38  $this->xmlSetGenCmt("Export of ILIAS course reference " . $this->getReference()->getId() . " of installation " . $ilSetting->get('inst_id') . ".");
39  $this->xmlHeader();
40 
41  return true;
42  }
xmlSetGenCmt($genCmt)
Sets generated comment.
xmlSetDtdDef($dtdDef)
Sets dtd definition.
global $DIC
Definition: saml.php:7
xmlHeader()
Writes xml header public.
global $ilSetting
Definition: privfeed.php:17
+ Here is the call graph for this function:

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