This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilXmlWriter:

Collaboration diagram for ilXmlWriter:

Public Member Functions
	__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...

Private Member Functions
	xmlSetStSheet (string $stSheet)
	Sets stylesheet. More...

	xmlEscapeData (string $data)
	Escapes reserved characters. More...

	xmlEncodeData (string $data)
	Encodes text from input encoding into output encoding. More...

	xmlFormatElement (array $array)
	Callback function for xmlFormatData; do not invoke directly. More...

	xmlComment (string $comment)
	Writes a comment. More...

Private Attributes
string	$xmlStr

string	$version

string	$outEnc

string	$inEnc

string	$dtdDef = ""

string	$stSheet = ""

string	$genCmt = "Generated by ILIAS XmlWriter"

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 30 of file class.ilXmlWriter.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $inEnc, $outEnc, and $version.

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

Member Function Documentation

◆ appendXML()

ilXmlWriter::appendXML ( string $a_str )

append xml string to document

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

Referenced by ilCourseXMLWriter\__buildMetaData(), ilGroupXMLWriter\__buildMetaData(), ilLMPageObject\exportFO(), ilObjMediaObject\exportXML(), ilGlossaryDefinition\exportXMLDefinition(), ilStructureObject\exportXMLMetaData(), ilGlossaryDefinition\exportXMLMetaData(), ilLMPageObject\exportXMLMetaData(), ilObjGlossary\exportXMLMetaData(), ilObjContentObject\exportXMLMetaData(), ilLMPageObject\exportXMLPageContent(), ilDidacticTemplateLocalRoleAction\toXml(), ilObjLinkResource\toXML(), and ilDidacticTemplateLocalPolicyAction\toXml().

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

Here is the caller graph for this function:

◆ xmlClear()

ilXmlWriter::xmlClear ( )

clears xmlStr

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

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

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

Here is the caller graph for this function:

◆ xmlComment()

ilXmlWriter::xmlComment ( string $comment )

private

Writes a comment.

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

Referenced by xmlHeader().

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

Here is the caller graph for this function:

◆ xmlData()

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

Writes data.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xmlDumpFile()

ilXmlWriter::xmlDumpFile	(	string	$file,
		bool	$format = `true`
	)

Dumps xml document from memory into a file.

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

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

                                                                   : void
     {
         // open file
         if (!($fp = fopen($file, "w+"))) {
             throw new RuntimeException(
                 "<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);
     }

Here is the call graph for this function:

◆ xmlDumpMem()

ilXmlWriter::xmlDumpMem ( bool $format = true )

Returns xml document from memory.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xmlElement()

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

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

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

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

Referenced by ilUserXMLWriter\__addElement(), ilGroupXMLWriter\__buildAdmin(), ilGroupXMLWriter\__buildExtraSettings(), ilGroupXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilGroupXMLWriter\__buildTitleDescription(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainerSortingSettings\_exportContainerSortingSettings(), ilLMPageObject\_exportXMLAlias(), ilLPXmlWriter\addLPInformation(), SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), ilAdvancedMDFieldDefinitionGroupBased\addPropertiesToXML(), ilAdvancedMDFieldDefinitionFloat\addPropertiesToXML(), ilAdvancedMDFieldDefinitionText\addPropertiesToXML(), ilAdvancedMDFieldDefinitionInteger\addPropertiesToXML(), ilAdvancedMDFieldDefinitionSelect\addPropertiesToXML(), assQuestion\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), ilDataSet\addRecordsXml(), assQuestionExport\addSolutionHints(), ilUserDefinedData\addToXML(), ilUserDefinedFields\addToXML(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendOperations(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), ilExerciseXMLWriter\attachMarking(), ilXMLResultSetWriter\buildColSpecs(), ilCourseReferenceXmlWriter\buildCourseSettings(), ilSoapInstallationInfoXMLWriter\buildInstallationInfo(), ilContainerReferenceXmlWriter\buildTarget(), ilContainerReferenceXmlWriter\buildTitle(), ilCategoryXmlWriter\buildTranslations(), ilAuthProviderSaml\buildUserAttributeXml(), ilTestResultsToXML\exportActiveIDs(), ilChatroomXMLWriter\exportData(), ilStructureObject\exportFO(), ilLMPageObject\exportFO(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilSoapStructureObject\exportXML(), ilGlossaryTerm\exportXML(), ilLMPageObject\exportXML(), ilObjContentObject\exportXMLProperties(), ilObjectXMLWriter\getXML(), ilExerciseXMLWriter\handleAssignmentFiles(), ilExerciseXMLWriter\handleAssignmentMembers(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), ilTestExportRandomQuestionSet\populateCommonSettings(), ilTestExportRandomQuestionSet\populateSelectionDefinitions(), ilSoapRoleObjectXMLWriter\start(), ilChatroomXMLWriter\start(), ilForumXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilDidacticTemplateIncludeFilterPattern\toXml(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilWebLinkItem\toXML(), ilMDFormat\toXML(), ilWebLinkParameter\toXML(), ilMDEntity\toXML(), ilMDIdentifier\toXML(), ilMDIdentifier_\toXML(), ilMDLocation\toXML(), ilMDKeyword\toXML(), ilDidacticTemplateIconHandler\toXml(), ilMDDescription\toXML(), ilMDLanguage\toXML(), ilMDTaxon\toXML(), ilMDAnnotation\toXML(), ilMDTypicalAgeRange\toXML(), ilMDTaxonPath\toXML(), ilObjLinkResource\toXML(), ilMDContribute\toXML(), ilMDLifecycle\toXML(), ilMDRights\toXML(), ilMDClassification\toXML(), ilMDRequirement\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilLOTestAssignments\toXml(), ilMultilingualism\toXml(), ilLORandomTestQuestionPools\toXml(), ilMDTechnical\toXML(), ilMDGeneral\toXML(), ilCourseObjectiveMaterials\toXml(), ilMDEducational\toXML(), ilDidacticTemplateSetting\toXml(), ilLOSettings\toXml(), ilCourseObjective\toXml(), ilAdvancedMDRecord\toXML(), ilCourseObjectiveQuestion\toXml(), ilAdvancedMDFieldDefinition\toXML(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeDescription(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilLearningSequenceXMLWriter\writeOwner(), ilRoleXmlExport\writeRole(), ilLearningSequenceXMLWriter\writeSettings(), and ilLearningSequenceXMLWriter\writeTitle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xmlEncodeData()

ilXmlWriter::xmlEncodeData ( string $data )

private

Encodes text from input encoding into output encoding.

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

References $data.

Referenced by xmlData(), and xmlStartTag().

                                                 : string
     {
         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;
     }

Here is the caller graph for this function:

◆ xmlEndTag()

ilXmlWriter::xmlEndTag ( string $tag )

Writes an endtag.

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

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

Here is the caller graph for this function:

◆ xmlEscapeData()

ilXmlWriter::xmlEscapeData ( string $data )

private

Escapes reserved characters.

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

Referenced by xmlData(), and xmlStartTag().

                                                 : string
     {
         $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 = ("&#" . $code . ";");
                     }
                     break;
             }
 
             $escapedData .= $character;
             $position++;
         }
         return $escapedData;
     }

Here is the caller graph for this function:

◆ xmlFormatData()

ilXmlWriter::xmlFormatData ( string $data )

Indents text for better reading.

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

Referenced by xmlDumpFile(), and xmlDumpMem().

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

Here is the caller graph for this function:

◆ xmlFormatElement()

ilXmlWriter::xmlFormatElement ( array $array )

private

Callback function for xmlFormatData; do not invoke directly.

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

                                                    : string
     {
         $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;
     }

◆ xmlHeader()

ilXmlWriter::xmlHeader ( )

Writes xml header.

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ xmlSetDtdDef()

ilXmlWriter::xmlSetDtdDef ( string $dtdDef )

Sets dtd definition.

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

References $dtdDef.

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

Here is the caller graph for this function:

◆ xmlSetGenCmt()

ilXmlWriter::xmlSetGenCmt ( string $genCmt )

Sets generated comment.

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

References $genCmt.

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

Here is the caller graph for this function:

◆ xmlSetStSheet()

ilXmlWriter::xmlSetStSheet ( string $stSheet )

private

Sets stylesheet.

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

References $stSheet.

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

◆ xmlStartTag()

ilXmlWriter::xmlStartTag	(	string	$tag,
		?array	$attrs = `null`,
		bool	$empty = `false`,
		bool	$encode = `true`,
		bool	$escape = `true`
	)

Writes a starttag.

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

References $name, xmlEncodeData(), and xmlEscapeData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $dtdDef

string ilXmlWriter::$dtdDef = ""

private

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

Referenced by xmlHeader(), and xmlSetDtdDef().

◆ $genCmt

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

private

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

Referenced by xmlSetGenCmt().

◆ $inEnc

string ilXmlWriter::$inEnc

private

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

Referenced by __construct().

◆ $outEnc

string ilXmlWriter::$outEnc

private

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

Referenced by __construct().

◆ $stSheet

string ilXmlWriter::$stSheet = ""

private

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

Referenced by xmlHeader(), and xmlSetStSheet().

◆ $version

string ilXmlWriter::$version

private

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

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

◆ $xmlStr

string ilXmlWriter::$xmlStr

private

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

Referenced by xmlDumpFile(), and xmlDumpMem().

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

Services/Xml/classes/class.ilXmlWriter.php

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ appendXML()

◆ xmlClear()

◆ xmlComment()

◆ xmlData()

◆ xmlDumpFile()

◆ xmlDumpMem()

◆ xmlElement()

◆ xmlEncodeData()

◆ xmlEndTag()

◆ xmlEscapeData()

◆ xmlFormatData()

◆ xmlFormatElement()

◆ xmlHeader()

◆ xmlSetDtdDef()

◆ xmlSetGenCmt()

◆ xmlSetStSheet()

◆ xmlStartTag()

Field Documentation

◆ $dtdDef

◆ $genCmt

◆ $inEnc

◆ $outEnc

◆ $stSheet

◆ $version

◆ $xmlStr