ilXMLResultSetWriter Class Reference

XML Writer for XMLResultSet. More...

Inheritance diagram for ilXMLResultSetWriter:

Collaboration diagram for ilXMLResultSetWriter:

Public Member Functions
	__construct (ilXMLResultSet $xmlResultSet)
	start ()
	getXML ()
Public Member Functions inherited from ilXmlWriter
	__construct (string $version="1.0", string $outEnc="utf-8", string $inEnc="utf-8")
	xmlSetDtdDef (string $dtdDef)
	Sets dtd definition. More...
	xmlSetGenCmt (string $genCmt)
	Sets generated comment. More...
	xmlFormatData (string $data)
	Indents text for better reading. More...
	xmlHeader ()
	Writes xml header. More...
	xmlStartTag (string $tag, ?array $attrs=null, bool $empty=false, bool $encode=true, bool $escape=true)
	Writes a starttag. More...
	xmlEndTag (string $tag)
	Writes an endtag. More...
	xmlData (string $data, bool $encode=true, bool $escape=true)
	Writes data. More...
	xmlElement (string $tag, $attrs=null, $data=null, $encode=true, $escape=true)
	Writes a basic element (no children, just textual content) More...
	xmlDumpFile (string $file, bool $format=true)
	Dumps xml document from memory into a file. More...
	xmlDumpMem (bool $format=true)
	Returns xml document from memory. More...
	appendXML (string $a_str)
	append xml string to document More...
	xmlClear ()
	clears xmlStr More...

Protected Attributes
ilXMLResultSet	$xmlResultSet

Private Member Functions
	buildHeader ()
	buildColSpecs ()
	buildRows ()
	appendRow (ilXMLResultSetRow $xmlResultSetRow)
	buildFooter ()

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)

Todo:

remove dependency to ilXmlWriter and use SimpleXML

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

Constructor & Destructor Documentation

__construct()

ilXMLResultSetWriter::__construct

(

ilXMLResultSet

$xmlResultSet

)

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

References $xmlResultSet, and ILIAS\GlobalScreen\Provider\__construct().

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

Here is the call graph for this function:

Member Function Documentation

appendRow()

ilXMLResultSetWriter::appendRow ( ilXMLResultSetRow  $xmlResultSetRow )

private

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

References ilXMLResultSetRow\getColumns(), null, ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by buildRows().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildColSpecs()

ilXMLResultSetWriter::buildColSpecs ( )

private

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

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

Referenced by start().

                                    : void
    {
        $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");
    }

Here is the call graph for this function:

Here is the caller graph for this function:

buildFooter()

ilXMLResultSetWriter::buildFooter ( )

private

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

References ilXmlWriter\xmlEndTag().

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildHeader()

ilXMLResultSetWriter::buildHeader ( )

private

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

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

buildRows()

ilXMLResultSetWriter::buildRows ( )

private

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

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

Referenced by start().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getXML()

ilXMLResultSetWriter::getXML

(

)

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

References ilXmlWriter\xmlDumpMem().

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

Here is the call graph for this function:

start()

ilXMLResultSetWriter::start

(

)

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

References buildColSpecs(), buildFooter(), buildHeader(), and buildRows().

                           : bool
    {
        $this->buildHeader();
        $this->buildColSpecs();
        $this->buildRows();
        $this->buildFooter();
        return true;
    }

Here is the call graph for this function:

Field Documentation

$xmlResultSet

ilXMLResultSet ilXMLResultSetWriter::$xmlResultSet

protected

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

Referenced by __construct().

---

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

• components/ILIAS/soap/classes/class.ilXMLResultSetWriter.php