XML Writer for XMLResultSet. More...

Inheritance diagram for ilXMLResultSetWriter:

Collaboration diagram for ilXMLResultSetWriter:

Public Member Functions
	ilXMLResultSetWriter (& $xmlResultSet)

	start ()

	getXML ()

	__appendRow (& $xmlResultSetRow)

	__buildHeader ()

	__buildColSpecs ()

	__buildRows ()

	__buildFooter ()

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
	$xmlResultSet

Data Fields inherited from ilXmlWriter
	$xmlStr

	$version

	$outEnc

	$inEnc

	$dtdDef = ""

	$stSheet = ""

	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

XML Writer for XMLResultSet.

Author: Roland Kuestermann (rku@a.nosp@m.ifb..nosp@m.uni-k.nosp@m.arls.nosp@m.ruhe..nosp@m.de)

Version

Id: class.ilXMLResultSet.php,v 1.5 2006/05/23 23:09:06 hschottm Exp

Definition at line 13 of file class.ilXMLResultSetWriter.php.

Member Function Documentation

◆ __appendRow()

ilXMLResultSetWriter::__appendRow ( & $xmlResultSetRow )

Definition at line 49 of file class.ilXMLResultSetWriter.php.

        {
                $this->xmlStartTag('row',null);
 
                foreach ($xmlResultSetRow->getColumns() as $value)
                {
                        $this->xmlElement('column',null,$value);
 
                }
 
                $this->xmlEndTag('row');
 
        }

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by __buildRows().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildColSpecs()

ilXMLResultSetWriter::__buildColSpecs ( )

Definition at line 74 of file class.ilXMLResultSetWriter.php.

                                   {
                $this->xmlStartTag("colspecs");
 
                foreach ($this->xmlResultSet->getColSpecs() as $colSpec) {
                        $attr  = array ("idx" => $colSpec->getIndex(), "name" => $colSpec->getName());
 
                        $this->xmlElement("colspec", $attr, null);
                }
 
                $this->xmlEndTag("colspecs");
        }

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildFooter()

ilXMLResultSetWriter::__buildFooter ( )

Definition at line 97 of file class.ilXMLResultSetWriter.php.

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildHeader()

ilXMLResultSetWriter::__buildHeader ( )

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

        {
                $this->xmlSetDtdDef("<!DOCTYPE result PUBLIC \"-//ILIAS//DTD XMLResultSet//EN\" \"".ILIAS_HTTP_PATH."/xml/ilias_xml_resultset_3_7.dtd\">");
                $this->xmlHeader();
 
                $this->xmlStartTag("result");
 
                return true;
        }

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

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ __buildRows()

ilXMLResultSetWriter::__buildRows ( )

Definition at line 86 of file class.ilXMLResultSetWriter.php.

                                {
                $this->xmlStartTag("rows");
 
                foreach($this->xmlResultSet->getRows() as $row)
                {
                        $this->__appendRow($row);
                }
 
                $this->xmlEndTag("rows");
        }

References $row, __appendRow(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilXMLResultSetWriter::getXML ( )

Definition at line 42 of file class.ilXMLResultSetWriter.php.

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

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ ilXMLResultSetWriter()

ilXMLResultSetWriter::ilXMLResultSetWriter ( & $xmlResultSet )

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

        {
                parent::ilXmlWriter();
                $this->xmlResultSet = $xmlResultSet;
        }

References $xmlResultSet.

◆ start()

ilXMLResultSetWriter::start ( )

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

        {
                if(!is_object($this->xmlResultSet))
                {
                        return false;
                }
 
                $this->__buildHeader();
 
                $this->__buildColSpecs();
 
                $this->__buildRows();
 
                $this->__buildFooter();
 
                return true;
        }