ILIAS
trunk Revision v11.0_alpha-3011-gc6b235a2e85
|
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...
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" |
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.
Definition at line 32 of file class.ilXmlWriter.php.
ilXmlWriter::__construct | ( | string | $version = "1.0" , |
string | $outEnc = "utf-8" , |
||
string | $inEnc = "utf-8" |
||
) |
Reimplemented in ilForumXMLWriter.
Definition at line 48 of file class.ilXmlWriter.php.
ilXmlWriter::appendXML | ( | string | $a_str | ) |
append xml string to document
Definition at line 391 of file class.ilXmlWriter.php.
Referenced by ilDidacticTemplateLocalPolicyAction\toXml(), and ilDidacticTemplateLocalRoleAction\toXml().
ilXmlWriter::xmlClear | ( | ) |
clears xmlStr
Definition at line 399 of file class.ilXmlWriter.php.
Referenced by ilFolderXmlWriter\init(), ilLPXmlWriter\init(), and ilWebLinkXmlWriter\init().
|
private |
Writes a comment.
Definition at line 289 of file class.ilXmlWriter.php.
References $comment.
Referenced by xmlHeader().
Writes data.
Definition at line 297 of file class.ilXmlWriter.php.
References $data.
Referenced by ilContainer\_exportContainerSettings(), and ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionStages().
ilXmlWriter::xmlDumpFile | ( | string | $file, |
bool | $format = true |
||
) |
Dumps xml document from memory into a file.
Reimplemented in ilTestResultsToXML.
Definition at line 346 of file class.ilXmlWriter.php.
ilXmlWriter::xmlDumpMem | ( | bool | $format = true | ) |
Returns xml document from memory.
Reimplemented in ilTestResultsToXML.
Definition at line 376 of file class.ilXmlWriter.php.
Referenced by ilCategoryXmlWriter\getXml(), ilChatroomXMLWriter\getXML(), ilContainerReferenceXmlWriter\getXml(), ilCourseXMLWriter\getXML(), ilExerciseXMLWriter\getXML(), ilFileXMLWriter\getXML(), ilForumXMLWriter\getXML(), ilGroupXMLWriter\getXML(), ilLearningSequenceXMLWriter\getXml(), ilObjectXMLWriter\getXML(), ilSoapInstallationInfoXMLWriter\getXML(), ilSoapRoleObjectXMLWriter\getXML(), ilSoapStructureObjectXMLWriter\getXML(), ilXMLResultSetWriter\getXML(), and ilUserXMLWriter\getXML().
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.
Referenced by ilGroupXMLWriter\__buildAdmin(), ilGroupXMLWriter\__buildExtraSettings(), ilGroupXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildTitleDescription(), ilGroupXMLWriter\__buildTitleDescription(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilLPXmlWriter\addLPInformation(), ilAdvancedMDFieldDefinitionFloat\addPropertiesToXML(), ilAdvancedMDFieldDefinitionGroupBased\addPropertiesToXML(), ilAdvancedMDFieldDefinitionInteger\addPropertiesToXML(), ilAdvancedMDFieldDefinitionSelect\addPropertiesToXML(), ilAdvancedMDFieldDefinitionText\addPropertiesToXML(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), assQuestionExport\addSuggestedSolution(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendOperations(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), 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(), ilLMPageObject\exportXML(), ilSoapStructureObject\exportXML(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateCommonSettings(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilAdvancedMDRecord\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveMaterials\toXml(), ilCourseObjectiveQuestion\toXml(), ilLOSettings\toXml(), ilDidacticTemplateIconHandler\toXml(), ilMultilingualism\toXml(), ilDidacticTemplateExcludeFilterPattern\toXml(), ilDidacticTemplateIncludeFilterPattern\toXml(), ilDidacticTemplateSetting\toXml(), ilObjLinkResource\toXML(), ilWebLinkParameter\toXML(), ilLORandomTestQuestionPools\toXml(), ilLOTestAssignments\toXml(), ilWebLinkItem\toXML(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeLearningSequence(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), and ilRoleXmlExport\writeRole().
|
private |
Encodes text from input encoding into output encoding.
Definition at line 136 of file class.ilXmlWriter.php.
References $data.
Referenced by xmlStartTag().
ilXmlWriter::xmlEndTag | ( | string | $tag | ) |
Writes an endtag.
Definition at line 281 of file class.ilXmlWriter.php.
Referenced by ilCourseXMLWriter\__buildAdmin(), ilCourseXMLWriter\__buildFooter(), ilGroupXMLWriter\__buildFooter(), ilUserXMLWriter\__buildFooter(), ilCourseXMLWriter\__buildMember(), ilGroupXMLWriter\__buildPeriod(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilContainer\_exportContainerSettings(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), assQuestionExport\addSuggestedSolution(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), ilSoapInstallationInfoXMLWriter\buildClient(), ilXMLResultSetWriter\buildColSpecs(), ilCategoryXmlWriter\buildFooter(), ilContainerReferenceXmlWriter\buildFooter(), ilObjectXMLWriter\buildFooter(), ilSoapInstallationInfoXMLWriter\buildFooter(), ilSoapRoleObjectXMLWriter\buildFooter(), ilXMLResultSetWriter\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(), ilSoapStructureObject\exportXML(), ilTestResultsToXML\getXML(), ilObjQuestionPool\objectToXmlWriter(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionSetConfigXml(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionStages(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilAdvancedMDRecord\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveQuestion\toXml(), ilDidacticTemplateBlockRoleAction\toXml(), ilDidacticTemplateLocalPolicyAction\toXml(), ilDidacticTemplateLocalRoleAction\toXml(), ilMultilingualism\toXml(), ilDidacticTemplateSetting\toXml(), ilObjLinkResource\toXML(), ilWebLinkItem\toXML(), ilRoleXmlExport\write(), ilAdvancedMDRecordXMLWriter\write(), ilContainerXmlWriter\write(), ilDidacticTemplateXmlWriter\write(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeFooter(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), and ilContainerXmlWriter\writeSubitems().
|
private |
Escapes reserved characters.
Definition at line 89 of file class.ilXmlWriter.php.
References $data.
Referenced by xmlStartTag().
ilXmlWriter::xmlFormatData | ( | string | $data | ) |
Indents text for better reading.
Definition at line 151 of file class.ilXmlWriter.php.
References $data.
|
private |
Callback function for xmlFormatData; do not invoke directly.
Definition at line 166 of file class.ilXmlWriter.php.
ilXmlWriter::xmlHeader | ( | ) |
Writes xml header.
Definition at line 214 of file class.ilXmlWriter.php.
References $dtdDef, $stSheet, and xmlComment().
Referenced by ilCourseXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilCategoryXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilContainerXmlWriter\buildHeader(), ilContainerReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), ilFolderXmlWriter\buildHeader(), ilGroupReferenceXmlWriter\buildHeader(), ilObjectXMLWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilSoapStructureObjectXMLWriter\buildHeader(), ilXMLResultSetWriter\buildHeader(), ilLPXmlWriter\buildHeader(), ilWebLinkXmlWriter\buildHeader(), ilTestResultsToXML\getXML(), ilDidacticTemplateXmlWriter\write(), and ilRoleXmlExport\writeHeader().
ilXmlWriter::xmlSetDtdDef | ( | string | $dtdDef | ) |
Sets dtd definition.
Definition at line 65 of file class.ilXmlWriter.php.
References $dtdDef.
Referenced by ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilObjectXMLWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilSoapStructureObjectXMLWriter\buildHeader(), ilXMLResultSetWriter\buildHeader(), ilRoleXmlExport\writeHeader(), and ilLearningSequenceXMLWriter\writeHeader().
ilXmlWriter::xmlSetGenCmt | ( | string | $genCmt | ) |
Sets generated comment.
Definition at line 81 of file class.ilXmlWriter.php.
References $genCmt.
Referenced by ilCourseXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilCategoryXmlWriter\buildHeader(), ilCategoryReferenceXmlWriter\buildHeader(), ilContainerXmlWriter\buildHeader(), ilContainerReferenceXmlWriter\buildHeader(), ilCourseReferenceXmlWriter\buildHeader(), ilFolderXmlWriter\buildHeader(), ilGroupReferenceXmlWriter\buildHeader(), ilObjectXMLWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilSoapStructureObjectXMLWriter\buildHeader(), ilWebLinkXmlWriter\buildHeader(), ilRoleXmlExport\writeHeader(), and ilLearningSequenceXMLWriter\writeHeader().
|
private |
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 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(), assQuestionExport\addAnswerSpecificFeedback(), ilLPXmlWriter\addLPInformation(), assQuestionExport\addQTIMaterial(), ilObjTest\addQTIMaterial(), assQuestionExport\addQtiMetaDataField(), assQuestionExport\addSuggestedSolution(), ilDataSet\addTypesXml(), ilSoapLearningProgressAdministration\addUserProgress(), ilObjectXMLWriter\appendObjectProperties(), ilObjectXMLWriter\appendPathToObject(), ilXMLResultSetWriter\appendRow(), ilObjectXMLWriter\appendTimeTargets(), ilCategoryXmlWriter\buildCategory(), ilSoapInstallationInfoXMLWriter\buildClient(), ilXMLResultSetWriter\buildColSpecs(), ilObjectXMLWriter\buildHeader(), ilSoapInstallationInfoXMLWriter\buildHeader(), ilSoapRoleObjectXMLWriter\buildHeader(), ilXMLResultSetWriter\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(), ilSoapStructureObject\exportXML(), ilTestResultsToXML\getXML(), ilObjQuestionPool\objectToXmlWriter(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionSetConfigXml(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateQuestionStages(), ILIAS\Test\ExportImport\ExportRandomQuestionSet\populateSelectionDefinitions(), ilChatroomXMLWriter\start(), ilExerciseXMLWriter\start(), ilFileXMLWriter\start(), ilForumXMLWriter\start(), ilSoapInstallationInfoXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilAdvancedMDFieldDefinition\toXML(), ilAdvancedMDRecord\toXML(), ilAdvancedMDRecordTranslations\toXML(), ilCourseObjective\toXml(), ilCourseObjectiveQuestion\toXml(), ilDidacticTemplateBlockRoleAction\toXml(), ilDidacticTemplateLocalPolicyAction\toXml(), ilDidacticTemplateLocalRoleAction\toXml(), ilMultilingualism\toXml(), ilDidacticTemplateSetting\toXml(), ilObjLinkResource\toXML(), ilWebLinkItem\toXML(), ilRoleXmlExport\write(), ilAdvancedMDRecordXMLWriter\write(), ilContainerXmlWriter\write(), ilDidacticTemplateXmlWriter\write(), ilFolderXmlWriter\write(), ilContainerXmlWriter\writeCourseItemInformation(), ilLearningSequenceXMLWriter\writeLearningSequence(), ilLearningSequenceXMLWriter\writeLPSettings(), ilLearningSequenceXMLWriter\writeLSItems(), ilRoleXmlExport\writeRole(), and ilContainerXmlWriter\writeSubitems().
|
private |
Definition at line 42 of file class.ilXmlWriter.php.
Referenced by xmlHeader(), and xmlSetDtdDef().
|
private |
Definition at line 46 of file class.ilXmlWriter.php.
Referenced by xmlSetGenCmt().
|
private |
Definition at line 40 of file class.ilXmlWriter.php.
Referenced by __construct(), and ilForumXMLWriter\__construct().
|
private |
Definition at line 38 of file class.ilXmlWriter.php.
Referenced by __construct(), and ilForumXMLWriter\__construct().
|
private |
Definition at line 44 of file class.ilXmlWriter.php.
Referenced by xmlHeader(), and xmlSetStSheet().
|
private |
Definition at line 36 of file class.ilXmlWriter.php.
Referenced by __construct(), ilForumXMLWriter\__construct(), and ilFileXMLWriter\start().
|
private |
Definition at line 34 of file class.ilXmlWriter.php.