XML writer class Class to simplify manual writing of xml documents. More...

Inheritance diagram for ilSoapStructureObjectXMLWriter:

Collaboration diagram for ilSoapStructureObjectXMLWriter:

Public Member Functions
	__construct ()

	setStructureObject (ilSoapStructureObject $structureObject)

	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...

Data Fields
string	$xml

ilSoapStructureObject	$structureObject = null

Private Member Functions
	buildHeader ()

	buildFooter ()

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 meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

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

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

Constructor & Destructor Documentation

◆ __construct()

ilSoapStructureObjectXMLWriter::__construct ( )

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

    {
        global $DIC;
 
        $ilUser = $DIC->user();
        parent::__construct();
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ buildFooter()

ilSoapStructureObjectXMLWriter::buildFooter ( )

private

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

                                   : void
    {
    }

Referenced by start().

Here is the caller graph for this function:

◆ buildHeader()

ilSoapStructureObjectXMLWriter::buildHeader ( )

private

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

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

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

Referenced by start().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getXML()

ilSoapStructureObjectXMLWriter::getXML ( )

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

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

References ilXmlWriter\xmlDumpMem().

Here is the call graph for this function:

◆ setStructureObject()

ilSoapStructureObjectXMLWriter::setStructureObject ( ilSoapStructureObject $structureObject )

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

                                                                               : void
    {
        $this->structureObject = $structureObject;
    }

References $structureObject.

◆ start()

ilSoapStructureObjectXMLWriter::start ( )

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

                            : bool
    {
        if (!is_object($this->structureObject)) {
            return false;
        }
 
        $this->buildHeader();
        $this->structureObject->exportXML($this);
        $this->buildFooter();
        return true;
    }