ilXmlWriter Class Reference

XML writer class. More...

Inheritance diagram for ilXmlWriter:

Collaboration diagram for ilXmlWriter:

Public Member Functions
	__construct ($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...
	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...

Static Public Member Functions
static	_xmlEscapeData ($data)
	Escapes reserved characters. More...

Data Fields
	$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

Matthias Rulinski matth.nosp@m.ias..nosp@m.rulin.nosp@m.ski@.nosp@m.mi.un.nosp@m.i-ko.nosp@m.eln.d.nosp@m.e

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilXmlWriter::__construct	(		$version = "1.0",
			$outEnc = "utf-8",
			$inEnc = "utf-8"
	)

constructor

Parameters

string	xml version
string	output encoding
string	input encoding @access public

Reimplemented in ilMD2XML.

Definition at line 75 of file class.ilXmlWriter.php.

    {
        // initialize xml string
        $this->xmlStr = "";
        
        // set properties
        $this->version = $version;
        $this->outEnc = $outEnc;
        $this->inEnc = $inEnc;
    }

References $inEnc, $outEnc, and $version.

Member Function Documentation

_ilXmlWriter()

ilXmlWriter::_ilXmlWriter

(

)

destructor @access public

Definition at line 90 of file class.ilXmlWriter.php.

    {
        // terminate xml string
        unset($this->xmlStr);
    }

_xmlEscapeData()

static ilXmlWriter::_xmlEscapeData (   $data )

static

Escapes reserved characters.

Parameters

string

input text

Returns

string escaped text @access static

Definition at line 132 of file class.ilXmlWriter.php.

    {
        $position = 0;
        $length = strlen($data);
        $escapedData = "";
        
        for (; $position < $length;) {
            $character = substr($data, $position, 1);
            $code = Ord($character);
            
            switch ($code) {
                case 34:
                    $character = "&quot;";
                    break;
                
                case 38:
                    $character = "&amp;";
                    break;
                
                case 39:
                    $character = "&apos;";
                    break;
                
                case 60:
                    $character = "&lt;";
                    break;
                
                case 62:
                    $character = "&gt;";
                    break;
                
                default:
                    if ($code < 32) {
                        $character = ("&#" . strval($code) . ";");
                    }
                    break;
            }
            
            $escapedData .= $character;
            $position++;
        }
        return $escapedData;
    }

References $code, and $data.

Referenced by xmlData(), and xmlStartTag().

Here is the caller graph for this function:

appendXML()

ilXmlWriter::appendXML

(

$a_str

)

append xml string to document

Definition at line 461 of file class.ilXmlWriter.php.

    {
        $this->xmlStr .= $a_str;
    }

Referenced by ilCourseXMLWriter\__buildMetaData(), ilGroupXMLWriter\__buildMetaData(), ilObjLinkResource\toXML(), ilDidacticTemplateLocalPolicyAction\toXml(), and ilDidacticTemplateLocalRoleAction\toXml().

Here is the caller graph for this function:

xmlClear()

ilXmlWriter::xmlClear

(

)

clears xmlStr @access public

Definition at line 470 of file class.ilXmlWriter.php.

    {
        // reset xml string
        $this->xmlStr = "";
    }

Referenced by ilFolderXmlWriter\init(), ilWebLinkXmlWriter\init(), and ilLPXmlWriter\init().

Here is the caller graph for this function:

xmlComment()

ilXmlWriter::xmlComment

(

$comment

)

Writes a comment.

Parameters

string

comment @access public

Definition at line 353 of file class.ilXmlWriter.php.

    {
        $this->xmlStr .= "<!--" . $comment . "-->";
    }

References $comment.

Referenced by xmlHeader().

Here is the caller graph for this function:

xmlData()

ilXmlWriter::xmlData	(		$data,
			$encode = true,
			$escape = true
	)

Writes data.

Parameters

string	data
string	ecode data (TRUE) or not (FALSE)
string	escape data (TRUE) or not (FALSE) @access public

Definition at line 365 of file class.ilXmlWriter.php.

    {
        // encode
        if ($encode) {
            $data = $this->xmlEncodeData($data);
        }
        
        // escape
        if ($escape) {
            $data = ilXmlWriter::_xmlEscapeData($data);
        }
        
        $this->xmlStr .= $data;
    }

References $data, _xmlEscapeData(), and xmlEncodeData().

Referenced by ilContainer\_exportContainerSettings(), ilTestExportRandomQuestionSet\populateQuestionStages(), and xmlElement().

Here is the call graph for this function:

Here is the caller graph for this function:

xmlDumpFile()

ilXmlWriter::xmlDumpFile	(		$file,
			$format = true
	)

Dumps xml document from memory into a file.

Parameters

string	file name (full path)
boolean	indent text (TRUE) or not (FALSE) @access public

Reimplemented in ilTestResultsToXML.

Definition at line 415 of file class.ilXmlWriter.php.

    {
        // open file
        if (!($fp = @fopen($file, "w+"))) {
            die("<b>Error</b>: Could not open \"" . $file . "\" for writing" .
                    " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
        }
        
        // set file permissions
        chmod($file, 0770);
        
        // format xml data
        if ($format) {
            $xmlStr = $this->xmlFormatData($this->xmlStr);
        } else {
            $xmlStr = $this->xmlStr;
        }
        
        // write xml data into the file
        fwrite($fp, $xmlStr);
        
        // close file
        fclose($fp);
    }

References $format, $xmlStr, and xmlFormatData().

Here is the call graph for this function:

xmlDumpMem()

ilXmlWriter::xmlDumpMem

(

$format = true

)

Returns xml document from memory.

Parameters

boolean

indent text (TRUE) or not (FALSE)

Returns

string xml document @access public

Reimplemented in ilTestResultsToXML.

Definition at line 446 of file class.ilXmlWriter.php.

    {
        // format xml data
        if ($format) {
            $xmlStr = $this->xmlFormatData($this->xmlStr);
        } else {
            $xmlStr = $this->xmlStr;
        }
        
        return $xmlStr;
    }

References $format, $xmlStr, and xmlFormatData().

Referenced by ilCategoryXmlWriter\getXml(), ilChatroomXMLWriter\getXML(), ilCourseXMLWriter\getXML(), ilExerciseXMLWriter\getXML(), ilFileXMLWriter\getXML(), ilForumXMLWriter\getXML(), ilGroupXMLWriter\getXML(), ilLearningSequenceXMLWriter\getXml(), ilContainerReferenceXmlWriter\getXml(), ilMD2XML\getXML(), ilUserXMLWriter\getXML(), ilObjectXMLWriter\getXML(), ilSoapInstallationInfoXMLWriter\getXML(), ilSoapRoleObjectXMLWriter\getXML(), ilSoapStructureObjectXMLWriter\getXML(), and ilXMLResultSetWriter\getXML().

Here is the call graph for this function:

Here is the caller graph for this function:

xmlElement()

ilXmlWriter::xmlElement	(		$tag,
			$attrs = null,
			$data = null,
			$encode = true,
			$escape = true
	)

Writes a basic element (no children, just textual content)

Parameters

string	tag name
array	attributes (name => value)
string	data
boolean	ecode attributes' values and data (TRUE) or not (FALSE)
boolean	escape attributes' values and data (TRUE) or not (FALSE) @access public

Definition at line 389 of file class.ilXmlWriter.php.

    {
        // check for existing data (element's content)
        if (is_string($data) or
            is_integer($data) or
            is_float($data)) {
            // write starttag
            $this->xmlStartTag($tag, $attrs, false, $encode, $escape);
            
            // write text
            $this->xmlData($data, $encode, $escape);
            
            // write endtag
            $this->xmlEndTag($tag);
        } else { // no data
            // write starttag (= empty tag)
            $this->xmlStartTag($tag, $attrs, true, $encode, $escape);
        }
    }

References $data, $tag, xmlData(), xmlEndTag(), and xmlStartTag().

Referenced by ilUserXMLWriter\__addElement(), ilObjectXMLWriter\__appendObjectProperties(), ilObjectXMLWriter\__appendOperations(), ilXMLResultSetWriter\__appendRow(), ilObjectXMLWriter\__appendTimeTargets(), ilGroupXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilGroupXMLWriter\__buildExtraSettings(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilGroupXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilGroupXMLWriter\__buildTitleDescription(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilLPXmlWriter\addLPInformation(), ilAdvancedMDFieldDefinitionFloat\addPropertiesToXML(), ilAdvancedMDFieldDefinitionInteger\addPropertiesToXML(), ilAdvancedMDFieldDefinitionSelect\addPropertiesToXML(), ilAdvancedMDFieldDefinitionText\addPropertiesToXML(), assQuestionExport\addQtiMetaDataField(), ilSoapLearningProgressAdministration\addUserProgress(), ilExerciseXMLWriter\attachMarking(), ilContainerReferenceXmlWriter\buildTarget(), ilContainerReferenceXmlWriter\buildTitle(), ilCategoryXmlWriter\buildTranslations(), ilAuthProviderSaml\buildUserAttributeXml(), ilTestResultsToXML\exportActiveIDs(), ilChatroomXMLWriter\exportData(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilExerciseXMLWriter\handleAssignmentFiles(), ilExerciseXMLWriter\handleAssignmentMembers(), ilTestExportRandomQuestionSet\populateCommonSettings(), ilTestExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveMaterials\toXml(), ilCourseObjectiveQuestion\toXml(), ilLOSettings\toXml(), ilLinkResourceItems\toXML(), ilObjLinkResource\toXML(), ilAdvancedMDRecord\toXML(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilDidacticTemplateIncludeFilterPattern\toXml(), ilDidacticTemplateSetting\toXml(), ilMultilingualism\toXml(), ilLORandomTestQuestionPools\toXml(), ilLOTestAssignments\toXml(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeDescription(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilLearningSequenceXMLWriter\writeOwner(), ilRoleXmlExport\writeRole(), ilLearningSequenceXMLWriter\writeSettings(), and ilLearningSequenceXMLWriter\writeTitle().

Here is the call graph for this function:

Here is the caller graph for this function:

xmlEncodeData()

ilXmlWriter::xmlEncodeData

(

$data

)

Encodes text from input encoding into output encoding.

Parameters

string

input text

Returns

string encoded text @access private

Definition at line 182 of file class.ilXmlWriter.php.

    {
        if ($this->inEnc == $this->outEnc) {
            $encodedData = $data;
        } else {
            switch (strtolower($this->outEnc)) {
                case "utf-8":
                    if (strtolower($this->inEnc) == "iso-8859-1") {
                        $encodedData = utf8_encode($data);
                    } else {
                        die("<b>Error</b>: Cannot encode iso-8859-1 data in " . $this->outEnc .
                                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
                    }
                    break;
                
                case "iso-8859-1":
                    if (strtolower($this->inEnc) == "utf-8") {
                        $encodedData = utf8_decode($data);
                    } else {
                        die("<b>Error</b>: Cannot encode utf-8 data in " . $this->outEnc .
                                " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
                    }
                    break;
                    
                default:
                    die("<b>Error</b>: Cannot encode " . $this->inEnc . " data in " . $this->outEnc .
                            " in <b>" . __FILE__ . "</b> on line <b>" . __LINE__ . "</b><br />");
            }
        }
        return $encodedData;
    }

References $data.

Referenced by xmlData(), and xmlStartTag().

Here is the caller graph for this function:

xmlEndTag()

ilXmlWriter::xmlEndTag

(

$tag

)

Writes an endtag.

Parameters

string

tag name @access public

Definition at line 343 of file class.ilXmlWriter.php.

    {
        $this->xmlStr .= "</" . $tag . ">";
    }

References $tag.

Referenced by ilObjectXMLWriter\__appendObjectProperties(), ilXMLResultSetWriter\__appendRow(), ilObjectXMLWriter\__appendTimeTargets(), ilCourseXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilCourseXMLWriter\__buildFooter(), ilGroupXMLWriter\__buildFooter(), ilUserXMLWriter\__buildFooter(), ilObjectXMLWriter\__buildFooter(), ilSoapInstallationInfoXMLWriter\__buildFooter(), ilSoapRoleObjectXMLWriter\__buildFooter(), ilXMLResultSetWriter\__buildFooter(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilCourseXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilXMLResultSetWriter\__buildRows(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainer\_exportContainerSettings(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), assQuestionExport\addQtiMetaDataField(), ilSoapLearningProgressAdministration\addUserProgress(), ilExerciseXMLWriter\attachMarking(), ilCategoryXmlWriter\buildFooter(), ilContainerReferenceXmlWriter\buildFooter(), ilCategoryXmlWriter\buildTranslations(), ilSoapInstallationInfoXMLWriter\end(), ilTestResultsToXML\exportActiveIDs(), assClozeTestExport\exportAnswerSpecificFeedbacks(), ilChatroomXMLWriter\exportData(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilTestResultsToXML\getXML(), ilExerciseXMLWriter\handleAssignmentFiles(), ilExerciseXMLWriter\handleAssignmentMembers(), ilObjQuestionPool\objectToXmlWriter(), ilTestExportRandomQuestionSet\populateQuestionSetConfigXml(), ilTestExportRandomQuestionSet\populateQuestionStages(), ilTestExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveQuestion\toXml(), ilLinkResourceItems\toXML(), ilObjLinkResource\toXML(), ilAdvancedMDRecord\toXML(), ilDidacticTemplateBlockRoleAction\toXml(), ilDidacticTemplateLocalPolicyAction\toXml(), ilDidacticTemplateLocalRoleAction\toXml(), ilDidacticTemplateSetting\toXml(), ilMultilingualism\toXml(), ilFolderXmlWriter\write(), ilRoleXmlExport\write(), ilAdvancedMDRecordXMLWriter\write(), ilContainerXmlWriter\write(), ilDidacticTemplateXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeFooter(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), ilContainerXmlWriter\writeSubitems(), and xmlElement().

Here is the caller graph for this function:

xmlFormatData()

ilXmlWriter::xmlFormatData

(

$data

)

Indents text for better reading.

Parameters

string

input text

Returns

string indented text @access private

Definition at line 220 of file class.ilXmlWriter.php.

    {
        // regular expression for tags
        $formatedXml = preg_replace_callback("|<[^>]*>[^<]*|", array($this, "xmlFormatElement"), $data);
        
        return $formatedXml;
    }

References $data.

Referenced by xmlDumpFile(), and xmlDumpMem().

Here is the caller graph for this function:

xmlFormatElement()

ilXmlWriter::xmlFormatElement

(

$array

)

Callback function for xmlFormatData; do not invoke directly.

Parameters

array

result of reg. expr. search

Returns

string indented substring @access private

Definition at line 234 of file class.ilXmlWriter.php.

    {
        $found = trim($array[0]);
        
        static $indent;
        
        // linebreak (default)
        $nl = "\n";
        
        $tab = str_repeat(" ", $indent * 2);
        
        // closing tag
        if (substr($found, 0, 2) == "</") {
            if ($indent) {
                $indent--;
            }
            $tab = str_repeat(" ", $indent * 2);
        } elseif (substr($found, -2, 1) == "/" or // opening and closing, comment, ...
                strpos($found, "/>") or
                substr($found, 0, 2) == "<!") {
            // do not change indent
        } elseif (substr($found, 0, 2) == "<?") {
            // do not change indent
            // no linebreak
            $nl = "";
        } else { // opening tag
            $indent++;
        }
        
        // content
        if (substr($found, -1) != ">") {
            $found = str_replace(">", ">\n" . str_repeat(" ", ($indent + 0) * 2), $found);
        }
        
        return $nl . $tab . $found;
    }

References $tab.

xmlHeader()

ilXmlWriter::xmlHeader

(

)

Writes xml header @access public.

Definition at line 275 of file class.ilXmlWriter.php.

    {
        // version and encoding
        $this->xmlStr .= "<?xml version=\"" . $this->version . "\" encoding=\"" . $this->outEnc . "\"?>";
        
        // dtd definition
        if ($this->dtdDef <> "") {
            $this->xmlStr .= $this->dtdDef;
        }
        
        // stSheet
        if ($this->stSheet <> "") {
            $this->xmlStr .= $this->stSheet;
        }
        
        // generated comment
        if ($this->genCmt <> "") {
            $this->xmlComment($this->genCmt);
        }
        
        return $xmlStr;
    }

References $dtdDef, $stSheet, $xmlStr, and xmlComment().

Referenced by ilCourseXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilCategoryXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), ilFolderXmlWriter\buildHeader(), ilGroupReferenceXmlWriter\buildHeader(), ilWebLinkXmlWriter\buildHeader(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilContainerXmlWriter\buildHeader(), ilContainerReferenceXmlWriter\buildHeader(), ilLPXmlWriter\buildHeader(), ilContObjectManifestBuilder\buildManifest(), ilLMContObjectManifestBuilder\buildManifest(), ilTestResultsToXML\getXML(), assClozeTestExport\toXML(), assErrorTextExport\toXML(), assFileUploadExport\toXML(), assFlashQuestionExport\toXML(), assFormulaQuestionExport\toXML(), assImagemapQuestionExport\toXML(), assJavaAppletExport\toXML(), assMatchingQuestionExport\toXML(), assMultipleChoiceExport\toXML(), assNumericExport\toXML(), assOrderingHorizontalExport\toXML(), assOrderingQuestionExport\toXML(), assSingleChoiceExport\toXML(), assTextQuestionExport\toXML(), assTextSubsetExport\toXML(), SurveyMatrixQuestion\toXML(), SurveyMetricQuestion\toXML(), SurveyMultipleChoiceQuestion\toXML(), SurveySingleChoiceQuestion\toXML(), SurveyTextQuestion\toXML(), ilObjSurveyQuestionPool\toXML(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilDidacticTemplateXmlWriter\write(), and ilRoleXmlExport\writeHeader().

Here is the call graph for this function:

Here is the caller graph for this function:

xmlSetDtdDef()

ilXmlWriter::xmlSetDtdDef

(

$dtdDef

)

Sets dtd definition.

Parameters

string

dtd definition @access public

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

    {
        $this->dtdDef = $dtdDef;
    }

References $dtdDef.

Referenced by ilCourseXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilContObjectExport\buildExportFileXML(), ilGlossaryExport\buildExportFileXML(), ilTestExport\buildExportFileXML(), ilQuestionpoolExport\buildExportFileXML(), ilCategoryXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), ilFolderXmlWriter\buildHeader(), ilGroupReferenceXmlWriter\buildHeader(), ilWebLinkXmlWriter\buildHeader(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilContainerXmlWriter\buildHeader(), ilContainerReferenceXmlWriter\buildHeader(), ilObjSCORM2004LearningModule\exportScorm(), ilSCORM2004Asset\exportScorm(), ilLearningSequenceXMLWriter\writeHeader(), and ilRoleXmlExport\writeHeader().

Here is the caller graph for this function:

xmlSetGenCmt()

ilXmlWriter::xmlSetGenCmt

(

$genCmt

)

Sets generated comment.

Parameters

string

generated comment @access public

Definition at line 121 of file class.ilXmlWriter.php.

    {
        $this->genCmt = $genCmt;
    }

References $genCmt.

Referenced by ilCourseXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilCategoryXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), ilFolderXmlWriter\buildHeader(), ilGroupReferenceXmlWriter\buildHeader(), ilWebLinkXmlWriter\buildHeader(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilContainerXmlWriter\buildHeader(), ilContainerReferenceXmlWriter\buildHeader(), ilLearningSequenceXMLWriter\writeHeader(), and ilRoleXmlExport\writeHeader().

Here is the caller graph for this function:

xmlSetStSheet()

ilXmlWriter::xmlSetStSheet

(

$stSheet

)

Sets stylesheet.

Parameters

string

stylesheet @access public

Definition at line 111 of file class.ilXmlWriter.php.

    {
        $this->stSheet = $stSheet;
    }

References $stSheet.

xmlStartTag()

ilXmlWriter::xmlStartTag	(		$tag,
			$attrs = null,
			$empty = false,
			$encode = true,
			$escape = true
	)

Writes a starttag.

Parameters

string	tag name
array	attributes (name => value)
boolean	tag empty (TRUE) or not (FALSE)
boolean	ecode attributes' values (TRUE) or not (FALSE)
boolean	escape attributes' values (TRUE) or not (FALSE) @access public

Definition at line 307 of file class.ilXmlWriter.php.

    {
        // write first part of the starttag
        $this->xmlStr .= "<" . $tag;
        
        // check for existing attributes
        if (is_array($attrs)) {
            // write attributes
            foreach ($attrs as $name => $value) {
                // encode
                if ($encode) {
                    $value = $this->xmlEncodeData($value);
                }
                
                // escape
                if ($escape) {
                    $value = ilXmlWriter::_xmlEscapeData($value);
                }
                
                $this->xmlStr .= " " . $name . "=\"" . $value . "\"";
            }
        }
        
        // write last part of the starttag
        if ($empty) {
            $this->xmlStr .= "/>";
        } else {
            $this->xmlStr .= ">";
        }
    }

References $name, $tag, _xmlEscapeData(), and xmlEncodeData().

Referenced by ilObjectXMLWriter\__appendObjectProperties(), ilXMLResultSetWriter\__appendRow(), ilObjectXMLWriter\__appendTimeTargets(), ilCourseXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilCourseXMLWriter\__buildCourseStart(), ilGroupXMLWriter\__buildGroup(), ilUserXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilCourseXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilXMLResultSetWriter\__buildRows(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainer\_exportContainerSettings(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), assQuestionExport\addQtiMetaDataField(), ilSoapLearningProgressAdministration\addUserProgress(), ilExerciseXMLWriter\attachMarking(), ilCategoryXmlWriter\buildCategory(), ilContainerReferenceXmlWriter\buildReference(), ilCategoryXmlWriter\buildTranslations(), ilTestResultsToXML\exportActiveIDs(), assClozeTestExport\exportAnswerSpecificFeedbacks(), ilChatroomXMLWriter\exportData(), ilTestResultsToXML\exportPassResult(), ilObjSCORM2004LearningModule\exportPDF(), ilSCORM2004Asset\exportPDF(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilTestResultsToXML\getXML(), ilExerciseXMLWriter\handleAssignmentFiles(), ilExerciseXMLWriter\handleAssignmentMembers(), ilObjQuestionPool\objectToXmlWriter(), ilTestExportRandomQuestionSet\populateQuestionSetConfigXml(), ilTestExportRandomQuestionSet\populateQuestionStages(), ilTestExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapInstallationInfoXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveQuestion\toXml(), ilLinkResourceItems\toXML(), ilObjLinkResource\toXML(), ilAdvancedMDRecord\toXML(), ilDidacticTemplateBlockRoleAction\toXml(), ilDidacticTemplateLocalPolicyAction\toXml(), ilDidacticTemplateLocalRoleAction\toXml(), ilDidacticTemplateSetting\toXml(), ilMultilingualism\toXml(), ilFolderXmlWriter\write(), ilRoleXmlExport\write(), ilAdvancedMDRecordXMLWriter\write(), ilContainerXmlWriter\write(), ilDidacticTemplateXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeLearningSequence(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), ilContainerXmlWriter\writeSubitems(), and xmlElement().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$dtdDef

ilXmlWriter::$dtdDef = ""

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

Referenced by xmlHeader(), and xmlSetDtdDef().

$genCmt

ilXmlWriter::$genCmt = "Generated by ILIAS XmlWriter"

Definition at line 66 of file class.ilXmlWriter.php.

Referenced by xmlSetGenCmt().

$inEnc

ilXmlWriter::$inEnc

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

Referenced by __construct().

$outEnc

ilXmlWriter::$outEnc

Definition at line 38 of file class.ilXmlWriter.php.

Referenced by __construct().

$stSheet

ilXmlWriter::$stSheet = ""

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

Referenced by xmlHeader(), and xmlSetStSheet().

$version

ilXmlWriter::$version

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

Referenced by __construct(), and ilFileXMLWriter\start().

$xmlStr

ilXmlWriter::$xmlStr

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

Referenced by xmlDumpFile(), xmlDumpMem(), and xmlHeader().

---

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

• Services/Xml/classes/class.ilXmlWriter.php