ILIAS
Release_3_10_x_branch Revision 61812
|
XML writer class. More...
Public Member Functions | |
ilXmlWriter ($version="1.0", $outEnc="utf-8", $inEnc="utf-8") | |
constructor | |
_ilXmlWriter () | |
destructor public | |
xmlSetDtdDef ($dtdDef) | |
Sets dtd definition. | |
xmlSetStSheet ($stSheet) | |
Sets stylesheet. | |
xmlSetGenCmt ($genCmt) | |
Sets generated comment. | |
_xmlEscapeData ($data) | |
Escapes reserved characters. | |
xmlEncodeData ($data) | |
Encodes text from input encoding into output encoding. | |
xmlFormatData ($data) | |
Indents text for better reading. | |
xmlFormatElement ($array) | |
Callback function for xmlFormatData; do not invoke directly. | |
xmlHeader () | |
Writes xml header public. | |
xmlStartTag ($tag, $attrs=NULL, $empty=FALSE, $encode=TRUE, $escape=TRUE) | |
Writes a starttag. | |
xmlEndTag ($tag) | |
Writes an endtag. | |
xmlComment ($comment) | |
Writes a comment. | |
xmlData ($data, $encode=TRUE, $escape=TRUE) | |
Writes data. | |
xmlElement ($tag, $attrs=NULL, $data=Null, $encode=TRUE, $escape=TRUE) | |
Writes a basic element (no children, just textual content) | |
xmlDumpFile ($file, $format=TRUE) | |
Dumps xml document from memory into a file. | |
xmlDumpMem ($format=TRUE) | |
Returns xml document from memory. | |
appendXML ($a_str) | |
append xml string to document | |
xmlClear () | |
clears xmlStr public |
Data Fields | |
$xmlStr | |
$version | |
$outEnc | |
$inEnc | |
$dtdDef = "" | |
$stSheet = "" | |
$genCmt = "Generated by ILIAS XmlWriter" |
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 37 of file class.ilXmlWriter.php.
ilXmlWriter::_ilXmlWriter | ( | ) |
destructor public
Definition at line 110 of file class.ilXmlWriter.php.
ilXmlWriter::_xmlEscapeData | ( | $data | ) |
Escapes reserved characters.
string | input text |
Definition at line 152 of file class.ilXmlWriter.php.
References $data.
Referenced by ilLPFilterGUI\getFO(), ilLPItemListGUI\renderObjectListFO(), ilLPItemListGUI\renderSimpleProgressFO(), xmlData(), and xmlStartTag().
ilXmlWriter::appendXML | ( | $a_str | ) |
append xml string to document
Definition at line 524 of file class.ilXmlWriter.php.
Referenced by ilCourseXMLWriter\__buildMetaData().
ilXmlWriter::ilXmlWriter | ( | $version = "1.0" , |
|
$outEnc = "utf-8" , |
|||
$inEnc = "utf-8" |
|||
) |
constructor
string | xml version |
string | output encoding |
string | input encoding public |
Definition at line 95 of file class.ilXmlWriter.php.
References $inEnc, $outEnc, and $version.
Referenced by ilAdvancedMDRecordXMLWriter\__construct(), ilCourseXMLWriter\ilCourseXMLWriter(), ilExerciseXMLWriter\ilExerciseXMLWriter(), ilFileXMLWriter\ilFileXMLWriter(), ilGroupXMLWriter\ilGroupXMLWriter(), ilMD2XML\ilMD2XML(), ilnetucateXMLAPI\ilnetucateXMLAPI(), ilObjectXMLWriter\ilObjectXMLWriter(), ilSoapInstallationInfoXMLWriter\ilSoapInstallationInfoXMLWriter(), ilSoapRoleObjectXMLWriter\ilSoapRoleObjectXMLWriter(), ilSoapStructureObjectXMLWriter\ilSoapStructureObjectXMLWriter(), ilUserXMLWriter\ilUserXMLWriter(), and ilXMLResultSetWriter\ilXMLResultSetWriter().
ilXmlWriter::xmlClear | ( | ) |
clears xmlStr public
Definition at line 533 of file class.ilXmlWriter.php.
Referenced by ilnetucateXMLAPI\addClass(), ilnetucateXMLAPI\addCourse(), ilnetucateXMLAPI\addUser(), ilnetucateXMLAPI\addUserOLD(), ilnetucateXMLAPI\editClass(), ilnetucateXMLAPI\editCourse(), ilnetucateXMLAPI\editUser(), ilnetucateXMLAPI\findClass(), ilnetucateXMLAPI\findCourseClasses(), ilnetucateXMLAPI\findRegisteredUsersByRole(), ilnetucateXMLAPI\findUser(), ilnetucateXMLAPI\joinClass(), ilnetucateXMLAPI\registerUser(), ilnetucateXMLAPI\removeClass(), ilnetucateXMLAPI\removeCourse(), ilnetucateXMLAPI\removeUser(), ilnetucateXMLAPI\unregisterUser(), and ilnetucateXMLAPI\userLogin().
ilXmlWriter::xmlComment | ( | $comment | ) |
Writes a comment.
string | comment public |
Definition at line 405 of file class.ilXmlWriter.php.
Referenced by xmlHeader().
ilXmlWriter::xmlData | ( | $data, | |
$encode = TRUE , |
|||
$escape = TRUE |
|||
) |
Writes data.
string | data |
string | ecode data (TRUE) or not (FALSE) |
string | escape data (TRUE) or not (FALSE) public |
Definition at line 417 of file class.ilXmlWriter.php.
References $data, _xmlEscapeData(), and xmlEncodeData().
Referenced by xmlElement().
ilXmlWriter::xmlDumpFile | ( | $file, | |
$format = TRUE |
|||
) |
Dumps xml document from memory into a file.
string | file name (full path) |
boolean | indent text (TRUE) or not (FALSE) public |
Definition at line 471 of file class.ilXmlWriter.php.
References $file, $xmlStr, and xmlFormatData().
ilXmlWriter::xmlDumpMem | ( | $format = TRUE | ) |
Returns xml document from memory.
boolean | indent text (TRUE) or not (FALSE) |
Definition at line 506 of file class.ilXmlWriter.php.
References $xmlStr, and xmlFormatData().
Referenced by ilSoapInstallationInfoXMLWriter\getXML(), ilMD2XML\getXML(), ilXMLResultSetWriter\getXML(), ilGroupXMLWriter\getXML(), ilSoapStructureObjectXMLWriter\getXML(), ilCourseXMLWriter\getXML(), ilObjectXMLWriter\getXML(), ilUserXMLWriter\getXML(), ilSoapRoleObjectXMLWriter\getXML(), ilFileXMLWriter\getXML(), ilExerciseXMLWriter\getXML(), and ilnetucateXMLAPI\sendRequest().
ilXmlWriter::xmlElement | ( | $tag, | |
$attrs = NULL , |
|||
$data = Null , |
|||
$encode = TRUE , |
|||
$escape = TRUE |
|||
) |
Writes a basic element (no children, just textual content)
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) public |
Definition at line 443 of file class.ilXmlWriter.php.
References $data, xmlData(), xmlEndTag(), and xmlStartTag().
Referenced by ilUserXMLWriter\__addElement(), ilObjectXMLWriter\__appendObject(), ilObjectXMLWriter\__appendOperations(), ilXMLResultSetWriter\__appendRow(), ilGroupXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilGroupXMLWriter\__buildMember(), ilCourseXMLWriter\__buildObject(), ilGroupXMLWriter\__buildRegistration(), ilCourseXMLWriter\__buildSetting(), ilGroupXMLWriter\__buildTitleDescription(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilExerciseXMLWriter\attachMarking(), ilSoapRoleObjectXMLWriter\start(), ilFileXMLWriter\start(), ilAdvancedMDRecord\toXML(), and ilAdvancedMDFieldDefinition\toXML().
ilXmlWriter::xmlEncodeData | ( | $data | ) |
Encodes text from input encoding into output encoding.
string | input text |
Definition at line 205 of file class.ilXmlWriter.php.
References $data.
Referenced by xmlData(), and xmlStartTag().
ilXmlWriter::xmlEndTag | ( | $tag | ) |
Writes an endtag.
string | tag name public |
Definition at line 395 of file class.ilXmlWriter.php.
Referenced by ilObjectXMLWriter\__appendObject(), ilXMLResultSetWriter\__appendRow(), ilCourseXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilSoapInstallationInfoXMLWriter\__buildFooter(), ilXMLResultSetWriter\__buildFooter(), ilUserXMLWriter\__buildFooter(), ilSoapRoleObjectXMLWriter\__buildFooter(), ilObjectXMLWriter\__buildFooter(), ilGroupXMLWriter\__buildFooter(), ilCourseXMLWriter\__buildFooter(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilCourseXMLWriter\__buildMember(), ilCourseXMLWriter\__buildObject(), ilGroupXMLWriter\__buildRegistration(), ilXMLResultSetWriter\__buildRows(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilnetucateXMLAPI\addClass(), ilnetucateXMLAPI\addCourse(), ilnetucateXMLAPI\addUser(), ilnetucateXMLAPI\addUserOLD(), ilExerciseXMLWriter\attachMarking(), ilnetucateXMLAPI\editClass(), ilnetucateXMLAPI\editCourse(), ilnetucateXMLAPI\editUser(), ilSoapInstallationInfoXMLWriter\end(), ilnetucateXMLAPI\findClass(), ilnetucateXMLAPI\findCourseClasses(), ilnetucateXMLAPI\findRegisteredUsersByRole(), ilnetucateXMLAPI\findUser(), ilnetucateXMLAPI\joinClass(), ilnetucateXMLAPI\registerUser(), ilnetucateXMLAPI\removeClass(), ilnetucateXMLAPI\removeCourse(), ilnetucateXMLAPI\removeUser(), ilSoapRoleObjectXMLWriter\start(), ilFileXMLWriter\start(), ilAdvancedMDRecord\toXML(), ilAdvancedMDFieldDefinition\toXML(), ilnetucateXMLAPI\unregisterUser(), ilnetucateXMLAPI\uploadPicture(), ilnetucateXMLAPI\userLogin(), ilAdvancedMDRecordXMLWriter\write(), and xmlElement().
ilXmlWriter::xmlFormatData | ( | $data | ) |
Indents text for better reading.
string | input text |
Reimplemented in ilnetucateXMLAPI.
Definition at line 253 of file class.ilXmlWriter.php.
References $data.
Referenced by xmlDumpFile(), and xmlDumpMem().
ilXmlWriter::xmlFormatElement | ( | $array | ) |
Callback function for xmlFormatData; do not invoke directly.
array | result of reg. expr. search |
Definition at line 267 of file class.ilXmlWriter.php.
References $tab.
ilXmlWriter::xmlHeader | ( | ) |
Writes xml header public.
Definition at line 317 of file class.ilXmlWriter.php.
References $dtdDef, $stSheet, $xmlStr, and xmlComment().
Referenced by ilSoapInstallationInfoXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilCourseXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilnetucateXMLAPI\addClass(), ilnetucateXMLAPI\addCourse(), ilnetucateXMLAPI\addUser(), ilnetucateXMLAPI\addUserOLD(), ilContObjectExport\buildExportFilePDF(), ilAdvancedMDRecordXMLWriter\buildHeader(), ilContObjectManifestBuilder\buildManifest(), ilnetucateXMLAPI\editClass(), ilnetucateXMLAPI\editCourse(), ilnetucateXMLAPI\editUser(), ilnetucateXMLAPI\findClass(), ilnetucateXMLAPI\findCourseClasses(), ilnetucateXMLAPI\findRegisteredUsersByRole(), ilnetucateXMLAPI\findUser(), ilnetucateXMLAPI\joinClass(), ilnetucateXMLAPI\registerUser(), ilnetucateXMLAPI\removeClass(), ilnetucateXMLAPI\removeCourse(), ilnetucateXMLAPI\removeUser(), assFlashQuestionExport\toXML(), assMultipleChoiceExport\toXML(), assTextQuestionExport\toXML(), assTextSubsetExport\toXML(), assJavaAppletExport\toXML(), assNumericExport\toXML(), assOrderingQuestionExport\toXML(), assSingleChoiceExport\toXML(), assClozeTestExport\toXML(), assMatchingQuestionExport\toXML(), assImagemapQuestionExport\toXML(), SurveyTextQuestion\toXML(), SurveyNominalQuestion\toXML(), SurveyOrdinalQuestion\toXML(), SurveyMetricQuestion\toXML(), ilObjSurveyQuestionPool\toXML(), SurveyMatrixQuestion\toXML(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilnetucateXMLAPI\unregisterUser(), ilnetucateXMLAPI\uploadPicture(), and ilnetucateXMLAPI\userLogin().
ilXmlWriter::xmlSetDtdDef | ( | $dtdDef | ) |
Sets dtd definition.
string | dtd definition public |
Definition at line 121 of file class.ilXmlWriter.php.
References $dtdDef.
Referenced by ilSoapInstallationInfoXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilCourseXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), ilQuestionpoolExport\buildExportFileXML(), ilGlossaryExport\buildExportFileXML(), ilContObjectExport\buildExportFileXML(), ilTestExport\buildExportFileXML(), and ilAdvancedMDRecordXMLWriter\buildHeader().
ilXmlWriter::xmlSetGenCmt | ( | $genCmt | ) |
Sets generated comment.
string | generated comment public |
Definition at line 141 of file class.ilXmlWriter.php.
References $genCmt.
Referenced by ilSoapInstallationInfoXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilSoapStructureObjectXMLWriter\__buildHeader(), ilCourseXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilFileXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilExerciseXMLWriter\__buildHeader(), and ilAdvancedMDRecordXMLWriter\buildHeader().
ilXmlWriter::xmlSetStSheet | ( | $stSheet | ) |
Sets stylesheet.
string | stylesheet public |
Definition at line 131 of file class.ilXmlWriter.php.
References $stSheet.
ilXmlWriter::xmlStartTag | ( | $tag, | |
$attrs = NULL , |
|||
$empty = FALSE , |
|||
$encode = TRUE , |
|||
$escape = TRUE |
|||
) |
Writes a starttag.
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) public |
Definition at line 352 of file class.ilXmlWriter.php.
References _xmlEscapeData(), and xmlEncodeData().
Referenced by ilObjectXMLWriter\__appendObject(), ilXMLResultSetWriter\__appendRow(), ilCourseXMLWriter\__buildAdmin(), ilSoapInstallationInfoXMLWriter\__buildClient(), ilXMLResultSetWriter\__buildColSpecs(), ilSoapInstallationInfoXMLWriter\__buildHeader(), ilGroupXMLWriter\__buildHeader(), ilXMLResultSetWriter\__buildHeader(), ilCourseXMLWriter\__buildHeader(), ilUserXMLWriter\__buildHeader(), ilSoapRoleObjectXMLWriter\__buildHeader(), ilObjectXMLWriter\__buildHeader(), ilSoapInstallationInfoXMLWriter\__buildInstallationInfo(), ilCourseXMLWriter\__buildMember(), ilCourseXMLWriter\__buildObject(), ilGroupXMLWriter\__buildRegistration(), ilXMLResultSetWriter\__buildRows(), ilCourseXMLWriter\__buildSetting(), ilCourseXMLWriter\__buildSubscriber(), ilCourseXMLWriter\__buildTutor(), ilCourseXMLWriter\__buildWaitingList(), ilUserXMLWriter\__handlePreferences(), ilUserXMLWriter\__handleUser(), ilAdvancedMDValues\_appendXMLByObjId(), ilnetucateXMLAPI\addClass(), ilnetucateXMLAPI\addCourse(), ilnetucateXMLAPI\addUser(), ilnetucateXMLAPI\addUserOLD(), ilExerciseXMLWriter\attachMarking(), ilnetucateXMLAPI\editClass(), ilnetucateXMLAPI\editCourse(), ilnetucateXMLAPI\editUser(), ilnetucateXMLAPI\findClass(), ilnetucateXMLAPI\findCourseClasses(), ilnetucateXMLAPI\findRegisteredUsersByRole(), ilnetucateXMLAPI\findUser(), ilnetucateXMLAPI\joinClass(), ilnetucateXMLAPI\registerUser(), ilnetucateXMLAPI\removeClass(), ilnetucateXMLAPI\removeCourse(), ilnetucateXMLAPI\removeUser(), ilSoapInstallationInfoXMLWriter\start(), ilSoapRoleObjectXMLWriter\start(), ilFileXMLWriter\start(), ilAdvancedMDRecord\toXML(), ilAdvancedMDFieldDefinition\toXML(), ilnetucateXMLAPI\unregisterUser(), ilnetucateXMLAPI\uploadPicture(), ilnetucateXMLAPI\userLogin(), ilAdvancedMDRecordXMLWriter\write(), and xmlElement().
ilXmlWriter::$dtdDef = "" |
Definition at line 72 of file class.ilXmlWriter.php.
Referenced by xmlHeader(), and xmlSetDtdDef().
ilXmlWriter::$genCmt = "Generated by ILIAS XmlWriter" |
Definition at line 86 of file class.ilXmlWriter.php.
Referenced by xmlSetGenCmt().
ilXmlWriter::$inEnc |
Definition at line 65 of file class.ilXmlWriter.php.
Referenced by ilXmlWriter().
ilXmlWriter::$outEnc |
Definition at line 58 of file class.ilXmlWriter.php.
Referenced by ilXmlWriter().
ilXmlWriter::$stSheet = "" |
Definition at line 79 of file class.ilXmlWriter.php.
Referenced by xmlHeader(), and xmlSetStSheet().
ilXmlWriter::$version |
Definition at line 51 of file class.ilXmlWriter.php.
Referenced by ilXmlWriter(), and ilFileXMLWriter\start().
ilXmlWriter::$xmlStr |
Definition at line 44 of file class.ilXmlWriter.php.
Referenced by xmlDumpFile(), xmlDumpMem(), and xmlHeader().