XML writer class. More...

Inheritance diagram for ilSoapStructureObjectXMLWriter:

Collaboration diagram for ilSoapStructureObjectXMLWriter:

Public Member Functions
	ilSoapStructureObjectXMLWriter ()
	constructor
	setStructureObject (&$structureObject)
	start ()
	getXML ()
	__buildHeader ()
	__buildFooter ()
Public Member Functions inherited from ilXmlWriter
	ilXmlWriter ($version="1.0", $outEnc="utf-8", $inEnc="utf-8")
	constructor
	_ilXmlWriter ()
	destructor public
	xmlSetDtdDef ($dtdDef)
	Sets dtd definition.
	xmlSetStSheet ($stSheet)
	Sets stylesheet.
	xmlSetGenCmt ($genCmt)
	Sets generated comment.
	_xmlEscapeData ($data)
	Escapes reserved characters.
	xmlEncodeData ($data)
	Encodes text from input encoding into output encoding.
	xmlFormatData ($data)
	Indents text for better reading.
	xmlFormatElement ($array)
	Callback function for xmlFormatData; do not invoke directly.
	xmlHeader ()
	Writes xml header public.
	xmlStartTag ($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE)
	Writes a starttag.
	xmlEndTag ($tag)
	Writes an endtag.
	xmlComment ($comment)
	Writes a comment.
	xmlData ($data, $encode=TRUE, $escape=TRUE)
	Writes data.
	xmlElement ($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE)
	Writes a basic element (no children, just textual content)
	xmlDumpFile ($file, $format=TRUE)
	Dumps xml document from memory into a file.
	xmlDumpMem ($format=TRUE)
	Returns xml document from memory.
	appendXML ($a_str)
	append xml string to document
	xmlClear ()
	clears xmlStr public

Data Fields
	$ilias
	$xml
	$structureObject
	$user_id = 0
Data Fields inherited from ilXmlWriter
	$xmlStr
	$version
	$outEnc
	$inEnc
	$dtdDef = ""
	$stSheet = ""
	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

XML writer class.

Class to simplify manual writing of xml documents. It only supports writing xml sequentially, because the xml document is saved in a string with no additional structure information. The author is responsible for well-formedness and validity of the xml document.

Author: Stefan Meyer smeye.nosp@m.r@da.nosp@m.tabay.nosp@m..de

Version

Id:: class.ilObjectXMLWriter.php,v 1.3 2005/11/04 12:50:24 smeyer Exp

Definition at line 40 of file class.ilSoapStructureObjectXMLWriter.php.

Member Function Documentation

ilSoapStructureObjectXMLWriter::__buildFooter ( )

Definition at line 101 of file class.ilSoapStructureObjectXMLWriter.php.

Referenced by start().

        {
        }

Here is the caller graph for this function:

ilSoapStructureObjectXMLWriter::__buildHeader ( )

Definition at line 91 of file class.ilSoapStructureObjectXMLWriter.php.

References ilXmlWriter\xmlHeader(), ilXmlWriter\xmlSetDtdDef(), and ilXmlWriter\xmlSetGenCmt().

Referenced by start().

        {
                $this->xmlSetDtdDef("<!DOCTYPE RepositoryObject PUBLIC \"-//ILIAS//DTD UserImport//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_soap_structure_object_3_7.dtd\">");
                $this->xmlSetGenCmt("Internal Structure Information of Repository Object");
                $this->xmlHeader();
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilSoapStructureObjectXMLWriter::getXML ( )

Definition at line 85 of file class.ilSoapStructureObjectXMLWriter.php.

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

ilSoapStructureObjectXMLWriter::ilSoapStructureObjectXMLWriter ( )

constructor

Parameters

string	xml version
string	output encoding
string	input encoding public

Definition at line 54 of file class.ilSoapStructureObjectXMLWriter.php.

References $ilias, and ilXmlWriter\ilXmlWriter().

        {
                global $ilias,$ilUser;
                parent::ilXmlWriter();
                $this->ilias =& $ilias;
                $this->user_id = $ilUser->getId();
        }

Here is the call graph for this function:

ilSoapStructureObjectXMLWriter::setStructureObject ( & $structureObject )

Definition at line 65 of file class.ilSoapStructureObjectXMLWriter.php.

References $structureObject.

        {
                $this->structureObject = & $structureObject;
        }

ilSoapStructureObjectXMLWriter::start ( )

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

References __buildFooter(), and __buildHeader().

        {
                if (!is_object($this->structureObject))
                        return false;
                $this->__buildHeader();
                $this->structureObject->exportXML ($this);
                $this->__buildFooter();
                return true;
        }