ilXmlWriter Class Reference

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

Deprecated:

will be removed with ILIAS 11, use the PHP native XML writer instead.

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 32 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 48 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 391 of file class.ilXmlWriter.php.

Referenced by ilCourseXMLWriter\__buildMetaData(), ilGroupXMLWriter\__buildMetaData(), ilObjMediaObject\exportXML(), 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 399 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 289 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 297 of file class.ilXmlWriter.php.

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

Referenced by ilContainer\_exportContainerSettings(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\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 346 of file class.ilXmlWriter.php.

References $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 376 of file class.ilXmlWriter.php.

References $xmlStr, and xmlFormatData().

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

                                                   : 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 318 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(), ilAdvancedMDFieldDefinitionInteger\addPropertiesToXML(), ilAdvancedMDFieldDefinitionText\addPropertiesToXML(), ilAdvancedMDFieldDefinitionSelect\addPropertiesToXML(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), ilDataSet\addRecordsXml(), assQuestionExport\addSolutionHints(), assQuestionExport\addSuggestedSolution(), 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(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilObjQuestionPool\exportTitleAndDescription(), ilSoapStructureObject\exportXML(), ilLMPageObject\exportXML(), ilGlossaryTerm\exportXML(), ilObjContentObject\exportXMLProperties(), ilObjectXMLWriter\getXML(), ilExerciseXMLWriter\handleAssignmentMembers(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateCommonSettings(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilExerciseXMLWriter\start(), ilForumXMLWriter\start(), ilFileXMLWriter\start(), ilDidacticTemplateIncludeFilterPattern\toXml(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilWebLinkItem\toXML(), ilWebLinkParameter\toXML(), ilMDFormat\toXML(), ilMDEntity\toXML(), ilMDIdentifier\toXML(), ilMDIdentifier_\toXML(), ilMDLocation\toXML(), ilMDDescription\toXML(), ilMDKeyword\toXML(), ilMDLanguage\toXML(), ilMDTaxon\toXML(), ilDidacticTemplateIconHandler\toXml(), ilMDAnnotation\toXML(), ilMDTypicalAgeRange\toXML(), ilMDTaxonPath\toXML(), ilObjLinkResource\toXML(), ilMDLifecycle\toXML(), ilMDContribute\toXML(), ilMDRights\toXML(), ilLOTestAssignments\toXml(), ilAdvancedMDRecordTranslations\toXML(), ilMDClassification\toXML(), ilMDRequirement\toXML(), ilMultilingualism\toXml(), ilLORandomTestQuestionPools\toXml(), ilMDTechnical\toXML(), ilMDGeneral\toXML(), ilCourseObjectiveMaterials\toXml(), ilDidacticTemplateSetting\toXml(), ilLOSettings\toXml(), ilCourseObjective\toXml(), ilMDEducational\toXML(), ilAdvancedMDRecord\toXML(), ilCourseObjectiveQuestion\toXml(), ilAdvancedMDFieldDefinition\toXML(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeLearningSequence(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), and ilRoleXmlExport\writeRole().

     : 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 136 of file class.ilXmlWriter.php.

References $data.

Referenced by xmlData(), and xmlStartTag().

                                                : string
    {
        if ($this->inEnc == $this->outEnc) {
            $encodedData = $data;
        } else {
            throw new ilException(
                'Differing in and out-encodings are not supported.'
            );
        }
        return $encodedData;
    }

Here is the caller graph for this function:

xmlEndTag()

ilXmlWriter::xmlEndTag

(

string

$tag

)

Writes an endtag.

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

Referenced by ilCourseXMLWriter\__buildAdmin(), ilUserXMLWriter\__buildFooter(), ilGroupXMLWriter\__buildFooter(), ilCourseXMLWriter\__buildFooter(), ilCourseXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainer\_exportContainerSettings(), ilLMPageObject\_exportXMLAlias(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), ilDataSet\addRecordsXml(), assQuestionExport\addSuggestedSolution(), ilUserDefinedFields\addToXML(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), ilExerciseXMLWriter\attachMarking(), ilSoapInstallationInfoXMLWriter\buildClient(), ilXMLResultSetWriter\buildColSpecs(), ilSoapInstallationInfoXMLWriter\buildFooter(), ilXMLResultSetWriter\buildFooter(), ilCategoryXmlWriter\buildFooter(), ilContainerReferenceXmlWriter\buildFooter(), ilSoapRoleObjectXMLWriter\buildFooter(), ilObjectXMLWriter\buildFooter(), ilSoapInstallationInfoXMLWriter\buildInstallationInfo(), ilXMLResultSetWriter\buildRows(), ilCategoryXmlWriter\buildTranslations(), ilSoapInstallationInfoXMLWriter\end(), ilTestResultsToXML\exportActiveIDs(), assClozeTestExport\exportAnswerSpecificFeedbacks(), ilChatroomXMLWriter\exportData(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilStructureObject\exportXML(), ilSoapStructureObject\exportXML(), ilLMPageObject\exportXML(), ilGlossaryTerm\exportXML(), ilObjContentObject\exportXML(), ilObjContentObject\exportXMLProperties(), ilObjectXMLWriter\getXML(), ilTestResultsToXML\getXML(), ilExerciseXMLWriter\handleAssignmentMembers(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), ilObjQuestionPool\objectToXmlWriter(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionSetConfigXml(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionStages(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilExerciseXMLWriter\start(), ilForumXMLWriter\start(), ilFileXMLWriter\start(), ilWebLinkItem\toXML(), ilMDOrComposite\toXML(), ilDidacticTemplateLocalRoleAction\toXml(), ilMDAnnotation\toXML(), ilMDTaxonPath\toXML(), ilDidacticTemplateBlockRoleAction\toXml(), ilObjLinkResource\toXML(), ilDidacticTemplateLocalPolicyAction\toXml(), ilMDLifecycle\toXML(), ilMDContribute\toXML(), ilMDMetaMetadata\toXML(), ilMDRights\toXML(), ilMD\toXML(), ilMDRelation\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilMDClassification\toXML(), ilMDRequirement\toXML(), ilMultilingualism\toXml(), ilMDTechnical\toXML(), ilMDGeneral\toXML(), ilDidacticTemplateSetting\toXml(), ilCourseObjective\toXml(), ilMDEducational\toXML(), ilAdvancedMDRecord\toXML(), ilCourseObjectiveQuestion\toXml(), ilAdvancedMDFieldDefinition\toXML(), ilDidacticTemplateXmlWriter\write(), ilFolderXmlWriter\write(), ilAdvancedMDRecordXMLWriter\write(), ilContainerXmlWriter\write(), ilRoleXmlExport\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeFooter(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), ilContainerXmlWriter\writeSubitems(), and xmlElement().

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

Here is the caller graph for this function:

xmlEscapeData()

ilXmlWriter::xmlEscapeData ( string  $data )

private

Escapes reserved characters.

Definition at line 89 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 151 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 166 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 214 of file class.ilXmlWriter.php.

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

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

                               : 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 65 of file class.ilXmlWriter.php.

References $dtdDef.

Referenced by ilUserXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilXMLResultSetWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapStructureObjectXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilObjectXMLWriter\buildHeader(), ilLearningSequenceXMLWriter\writeHeader(), and ilRoleXmlExport\writeHeader().

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

Here is the caller graph for this function:

xmlSetGenCmt()

ilXmlWriter::xmlSetGenCmt

(

string

$genCmt

)

Sets generated comment.

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

References $genCmt.

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

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

Here is the caller graph for this function:

xmlSetStSheet()

ilXmlWriter::xmlSetStSheet ( string  $stSheet )

private

Sets stylesheet.

Definition at line 73 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 238 of file class.ilXmlWriter.php.

References null, xmlEncodeData(), and xmlEscapeData().

Referenced by ilCourseXMLWriter\__buildAdmin(), ilCourseXMLWriter\__buildCourseStart(), ilGroupXMLWriter\__buildGroup(), ilUserXMLWriter\__buildHeader(), ilCourseXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainer\_exportContainerSettings(), ilLMPageObject\_exportXMLAlias(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), SurveyQuestion\addMaterialTag(), ilObjSurvey\addMaterialTag(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), ilDataSet\addRecordsXml(), assQuestionExport\addSuggestedSolution(), ilUserDefinedFields\addToXML(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), ilExerciseXMLWriter\attachMarking(), ilCategoryXmlWriter\buildCategory(), ilSoapInstallationInfoXMLWriter\buildClient(), ilXMLResultSetWriter\buildColSpecs(), ilXMLResultSetWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilObjectXMLWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildInstallationInfo(), ilContainerReferenceXmlWriter\buildReference(), ilXMLResultSetWriter\buildRows(), ilCategoryXmlWriter\buildTranslations(), ilTestResultsToXML\exportActiveIDs(), assClozeTestExport\exportAnswerSpecificFeedbacks(), ilChatroomXMLWriter\exportData(), ilTestResultsToXML\exportPassResult(), ilTestResultsToXML\exportRandomTestQuestions(), ilTestResultsToXML\exportResultCache(), ilTestResultsToXML\exportTestResults(), ilTestResultsToXML\exportTestSequence(), ilTestResultsToXML\exportTestSolutions(), ilTestResultsToXML\exportTestTimes(), ilStructureObject\exportXML(), ilSoapStructureObject\exportXML(), ilLMPageObject\exportXML(), ilGlossaryTerm\exportXML(), ilObjContentObject\exportXML(), ilObjContentObject\exportXMLProperties(), ilObjectXMLWriter\getXML(), ilTestResultsToXML\getXML(), ilExerciseXMLWriter\handleAssignmentMembers(), SurveyTextQuestion\insertXML(), SurveyMultipleChoiceQuestion\insertXML(), SurveySingleChoiceQuestion\insertXML(), SurveyMetricQuestion\insertXML(), SurveyMatrixQuestion\insertXML(), ilObjQuestionPool\objectToXmlWriter(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionSetConfigXml(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionStages(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilSoapInstallationInfoXMLWriter\start(), ilChatroomXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilExerciseXMLWriter\start(), ilForumXMLWriter\start(), ilFileXMLWriter\start(), ilWebLinkItem\toXML(), ilMDOrComposite\toXML(), ilDidacticTemplateLocalRoleAction\toXml(), ilMDAnnotation\toXML(), ilMDTaxonPath\toXML(), ilDidacticTemplateBlockRoleAction\toXml(), ilObjLinkResource\toXML(), ilDidacticTemplateLocalPolicyAction\toXml(), ilMDLifecycle\toXML(), ilMDContribute\toXML(), ilMDMetaMetadata\toXML(), ilMDRights\toXML(), ilMD\toXML(), ilMDRelation\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilMDClassification\toXML(), ilMDRequirement\toXML(), ilMultilingualism\toXml(), ilMDTechnical\toXML(), ilMDGeneral\toXML(), ilDidacticTemplateSetting\toXml(), ilCourseObjective\toXml(), ilMDEducational\toXML(), ilAdvancedMDRecord\toXML(), ilCourseObjectiveQuestion\toXml(), ilAdvancedMDFieldDefinition\toXML(), ilDidacticTemplateXmlWriter\write(), ilAdvancedMDRecordXMLWriter\write(), ilFolderXmlWriter\write(), ilContainerXmlWriter\write(), ilRoleXmlExport\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeLearningSequence(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), ilContainerXmlWriter\writeSubitems(), and xmlElement().

     : 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 42 of file class.ilXmlWriter.php.

Referenced by xmlHeader(), and xmlSetDtdDef().

$genCmt

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

private

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

Referenced by xmlSetGenCmt().

$inEnc

string ilXmlWriter::$inEnc

private

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

Referenced by ilForumXMLWriter\__construct(), and __construct().

$outEnc

string ilXmlWriter::$outEnc

private

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

Referenced by ilForumXMLWriter\__construct(), and __construct().

$stSheet

string ilXmlWriter::$stSheet = ""

private

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

Referenced by xmlHeader(), and xmlSetStSheet().

$version

string ilXmlWriter::$version

private

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

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

$xmlStr

string ilXmlWriter::$xmlStr

private

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

Referenced by xmlDumpFile(), and xmlDumpMem().

---

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

• components/ILIAS/Xml/classes/class.ilXmlWriter.php