Qore XML Module  1.5
Qore::Xml Namespace Reference

Qore::Xml namespace. More...

Namespaces

 Option
 Qore::Xml::Option namespace.
 

Classes

class  AbstractXmlIoInputCallback
 The AbstractXmlIoInputCallback class provides an interface for providing input callbacks to libxml2 More...
 
class  FileSaxIterator
 The FileSaxIterator class provides a SAX iterator for file-based XML data based on libxml2 More...
 
class  InputStreamSaxIterator
 The InputStreamSaxIterator class provides a SAX iterator for input streams based on libxml2 More...
 
class  SaxIterator
 The SaxIterator class provides a SAX iterator for XML data based on libxml2 More...
 
class  XmlDoc
 The XmlDoc class provides access to a parsed XML document by wrapping a C xmlDocPtr from libxml2 More...
 
class  XmlNode
 The XmlNode class provides information about the components of an XML document. More...
 
class  XmlReader
 The XmlReader class allows XML strings to be iterated and parsed piecewise. More...
 
class  XmlRpcClient
 The XmlRpcClient class provides easy access to XML-RPC web services. More...
 

Functions

string makeFormattedXMLFragment (hash h, *string encoding)
 serializes a hash into an XML string with whitespace formatting but without an XML header More...
 
nothing makeFormattedXMLFragment ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
string makeFormattedXMLString (string key, hash h, *string encoding)
 serializes a hash into an XML string with whitespace formatting and with an XML header More...
 
string makeFormattedXMLString (hash h, *string encoding)
 serializes a hash into an XML string with whitespace formatting and with an XML header More...
 
string makeXMLFragment (hash h, *string encoding)
 serializes a hash into an XML string without whitespace formatting and without an XML header More...
 
nothing makeXMLFragment ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
string makeXMLString (string key, hash h, *string encoding)
 serializes a hash into an XML string without whitespace formatting but with an XML header More...
 
string makeXMLString (hash h, *string encoding)
 serializes a hash into an XML string without whitespace formatting but with an XML header More...
 
string make_xml (string key, hash h, *int flags, *string encoding)
 serializes a hash into an XML string with an XML header More...
 
string make_xml (hash h, *int flags, *string encoding)
 serializes a hash into an XML string with an XML header More...
 
string make_xml (hash h, hash opts)
 serializes a hash into an XML string with various options of formatting More...
 
string make_xml_fragment (hash h, *int flags, *string encoding)
 serializes a hash into an XML string without whitespace formatting and without an XML header More...
 
hash parseXML (string xml, *string encoding)
 Parses an XML string and returns a Qore hash structure. More...
 
nothing parseXML ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
hash parseXMLAsData (string xml, *string encoding)
 Parses an XML string as data (does not necessarily preserve key order) and returns a Qore hash structure. More...
 
nothing parseXMLAsData ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
hash parseXMLAsDataWithRelaxNG (string xml, string relaxng, *string encoding)
 Parses an XML string as data (does not preserve hash order with out-of-order duplicate keys: collapses all to the same list), validates the XML string against a RelaxNG schema string, and returns a Qore hash structure. More...
 
hash parseXMLAsDataWithSchema (string xml, string xsd, *string encoding)
 Parses an XML string as data (does not preserve hash order with out-of-order duplicate keys: collapses all to the same list), validates the XML string against an XSD schema string, and returns a Qore hash structure. More...
 
hash parseXMLWithRelaxNG (string xml, string relaxng, *string encoding)
 Parses an XML string, validates the XML string against a RelaxNG schema string, and returns a Qore hash structure. More...
 
hash parseXMLWithSchema (string xml, string xsd, *string encoding)
 Parses an XML string, validates the XML string against an XSD schema string, and returns a Qore hash structure. More...
 
hash parse_xml (string xml, *int pflags, *string encoding)
 Parses an XML string and returns a Qore hash structure. More...
 
hash parse_xml_with_dtd (string xml, string dtd, *int pflags, *string encoding)
 Parses an XML string, validates the XML string against a DTD string, and returns a Qore hash structure. More...
 
hash parse_xml_with_relaxng (string xml, string relaxng, *int pflags, *string encoding)
 Parses an XML string, validates the XML string against a RelaxNG schema string, and returns a Qore hash structure. More...
 
hash parse_xml_with_schema (string xml, string xsd, *int pflags, *string encoding)
 Parses an XML string, validates the XML string against an XSD schema string, and returns a Qore hash structure. More...
 
auto get_xml_value (auto n)
 Helper function returning an XML value. More...
 
string makeFormattedXMLRPCCallString (string method,...)
 Serializes the argument into an XML string in XML-RPC call format with whitespace formatting. More...
 
string makeFormattedXMLRPCCallStringArgs (string method, any argv)
 Serializes the argument into an XML string in XML-RPC call format with whitespace formatting. More...
 
string makeFormattedXMLRPCCallStringArgsWithEncoding (string encoding, string method, any argv)
 Serializes the argument into an XML string in XML-RPC call format with whitespace formatting. More...
 
string makeFormattedXMLRPCCallStringWithEncoding (string encoding, string method,...)
 Serializes the argument into an XML string in XML-RPC call format with whitespace formatting with an explicit encoding. More...
 
string makeFormattedXMLRPCFaultResponseString (softint code, string msg)
 Serializes the argument into an XML string in XML-RPC fault response format with whitespace formatting. More...
 
string makeFormattedXMLRPCFaultResponseStringWithEncoding (string encoding, softint code, string msg)
 Serializes the argument into an XML string in XML-RPC fault response format with whitespace formatting with an explicit output encoding. More...
 
string makeFormattedXMLRPCResponseString (...)
 Serializes the arguments into an XML string formatted for an XML-RPC response with whitespace formatting. More...
 
string makeFormattedXMLRPCResponseStringWithEncoding (string encoding,...)
 Serializes the arguments into an XML string formatted for an XML-RPC response with whitespace formatting and with an explicit output encoding. More...
 
*string makeFormattedXMLRPCValueString (any value, *string encoding)
 Serializes the arguments into an XML string in XML-RPC value format with whitespace formatting but without an XML header. More...
 
string makeXMLRPCCallString (string method,...)
 Serializes the argument into an XML string in XML-RPC call format without whitespace formatting. More...
 
string makeXMLRPCCallStringArgs (string method, any args)
 Serializes the argument into an XML string in XML-RPC call format without whitespace formatting. More...
 
string makeXMLRPCCallStringArgsWithEncoding (string encoding, string method, any args)
 Serializes the argument into an XML string in XML-RPC call format without whitespace formatting with an explicit encoding. More...
 
string makeXMLRPCCallStringWithEncoding (string encoding, string method,...)
 Serializes the argument into an XML string in XML-RPC call format without whitespace formatting with an explicit encoding. More...
 
string makeXMLRPCFaultResponseString (softint code, string msg)
 Serializes the argument into an XML string in XML-RPC fault response format without whitespace formatting. More...
 
string makeXMLRPCFaultResponseStringWithEncoding (string encoding, softint code, string msg)
 Serializes the argument into an XML string in XML-RPC fault response format without whitespace formatting with an explicit output encoding. More...
 
string makeXMLRPCResponseString (...)
 Serializes the arguments into an XML string formatted for an XML-RPC response without whitespace formatting. More...
 
string makeXMLRPCResponseStringWithEncoding (string encoding,...)
 Serializes the arguments into an XML string formatted for an XML-RPC response without whitespace formatting and with an explicit output encoding. More...
 
*string makeXMLRPCValueString (any value, *string encoding)
 Serializes the arguments into an XML string in XML-RPC value format without whitespace formatting and without an XML header. More...
 
string make_xmlrpc_call (string method, any args, *int flags, *string encoding)
 Serializes the argument into an XML string in XML-RPC call format. More...
 
string make_xmlrpc_fault (softint code, string msg, *int flags, *string encoding)
 Serializes the argument into an XML string in XML-RPC fault response format without whitespace formatting. More...
 
string make_xmlrpc_response (any call_args, *int flags, *string encoding)
 Serializes the arguments into an XML string formatted for an XML-RPC response without whitespace formatting. More...
 
*string make_xmlrpc_value (any value, *int flags, *string encoding)
 Serializes the arguments into an XML string in XML-RPC value format without whitespace formatting and without an XML header. More...
 
hash parseXMLRPCCall (string xml, *string encoding)
 Deserializies an XML-RPC call string, returning a Qore data structure representing the call information. More...
 
nothing parseXMLRPCCall ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
hash parseXMLRPCResponse (string xml, *string encoding)
 Deserializies an XML-RPC response string, returning a Qore data structure representing the response information. More...
 
nothing parseXMLRPCResponse ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
any parseXMLRPCValue (string xml, *string encoding)
 Deserializies an XML-RPC value string and returns a Qore data structure representing the information. More...
 
nothing parseXMLRPCValue ()
 This is a variant that is basically a noop, included for backwards-compatibility for functions that ignored type errors in the calling parameters. More...
 
hash parse_xmlrpc_call (string xml, *string encoding)
 Deserializies an XML-RPC call string, returning a Qore data structure representing the call information. More...
 
hash parse_xmlrpc_response (string xml, *string encoding)
 Deserializies an XML-RPC response string, returning a Qore data structure representing the response information. More...
 
any parse_xmlrpc_value (string xml, *string encoding)
 Deserializies an XML-RPC value string and returns a Qore data structure representing the information. More...
 

Variables

const ElementTypeMap
 gives a map from element type codes to symbolic names
 
const XML_ATTRIBUTE_DECL = XML_ATTRIBUTE_DECL
 Indicates an attribute declaration.
 
const XML_ATTRIBUTE_NODE = XML_ATTRIBUTE_NODE
 Indicates an attribute.
 
const XML_CDATA_SECTION_NODE = XML_CDATA_SECTION_NODE
 Indicates CDATA: unparsed character data.
 
const XML_COMMENT_NODE = XML_COMMENT_NODE
 Indicates a comment.
 
const XML_DOCB_DOCUMENT_NODE = XML_DOCB_DOCUMENT_NODE
 Indicates a docbook document element.
 
const XML_DOCUMENT_FRAG_NODE = XML_DOCUMENT_FRAG_NODE
 Indicates a document fragment.
 
const XML_DOCUMENT_NODE = XML_DOCUMENT_NODE
 Indicates a document.
 
const XML_DOCUMENT_TYPE_NODE = XML_DOCUMENT_TYPE_NODE
 Indicates a document type.
 
const XML_DTD_NODE = XML_DTD_NODE
 Indicates a DTD.
 
const XML_ELEMENT_DECL = XML_ELEMENT_DECL
 Indicates an element declaration.
 
const XML_ELEMENT_NODE = XML_ELEMENT_NODE
 Indicates an element.
 
const XML_ENTITY_DECL = XML_ENTITY_DECL
 Indicates an entity declaration.
 
const XML_ENTITY_NODE = XML_ENTITY_NODE
 Indicates an entity.
 
const XML_ENTITY_REF_NODE = XML_ENTITY_REF_NODE
 Indicates an entity reference.
 
const XML_HTML_DOCUMENT_NODE = XML_HTML_DOCUMENT_NODE
 Indicates an HTML document.
 
const XML_NAMESPACE_DECL = XML_NAMESPACE_DECL
 Indicates a namespace declaration.
 
const XML_NOTATION_NODE = XML_NOTATION_NODE
 Indicates a DTD notation.
 
const XML_PI_NODE = XML_PI_NODE
 Indicates a processing instruction.
 
const XML_TEXT_NODE = XML_TEXT_NODE
 Indicates text.
 
const XML_XINCLUDE_END = XML_XINCLUDE_END
 Indicates an XML xinclude end element.
 
const XML_XINCLUDE_START = XML_XINCLUDE_START
 Indicates an XML xinclude start element.
 
const NodeTypeMap
 provides a map from node type values to symbolic names
 
const XML_NODE_TYPE_ATTRIBUTE = XML_READER_TYPE_ATTRIBUTE
 Indicates an attribute node.
 
const XML_NODE_TYPE_CDATA = XML_READER_TYPE_CDATA
 Indicates a CDATA node: unparsed character data.
 
const XML_NODE_TYPE_COMMENT = XML_READER_TYPE_COMMENT
 Indicates an XML comment.
 
const XML_NODE_TYPE_DOCUMENT = XML_READER_TYPE_DOCUMENT
 Indicates a document node.
 
const XML_NODE_TYPE_DOCUMENT_FRAGMENT = XML_READER_TYPE_DOCUMENT_FRAGMENT
 Indicates a document fragment node.
 
const XML_NODE_TYPE_DOCUMENT_TYPE = XML_READER_TYPE_DOCUMENT_TYPE
 Indicates a document type node.
 
const XML_NODE_TYPE_ELEMENT = XML_READER_TYPE_ELEMENT
 Indicates an XML element.
 
const XML_NODE_TYPE_END_ELEMENT = XML_READER_TYPE_END_ELEMENT
 Indicates an end element node.
 
const XML_NODE_TYPE_END_ENTITY = XML_READER_TYPE_END_ENTITY
 Indicates an end entity node.
 
const XML_NODE_TYPE_ENTITY = XML_READER_TYPE_ENTITY
 Indicates an entity reference node.
 
const XML_NODE_TYPE_ENTITY_REFERENCE = XML_READER_TYPE_ENTITY_REFERENCE
 Indicates an entity reference node.
 
const XML_NODE_TYPE_NONE = XML_READER_TYPE_NONE
 Indicates no node is available.
 
const XML_NODE_TYPE_NOTATION = XML_READER_TYPE_NOTATION
 Indicates a notation node.
 
const XML_NODE_TYPE_PROCESSING_INSTRUCTION = XML_READER_TYPE_PROCESSING_INSTRUCTION
 Indicates an XML processing instruction.
 
const XML_NODE_TYPE_SIGNIFICANT_WHITESPACE = XML_READER_TYPE_SIGNIFICANT_WHITESPACE
 Indicates a significant whitespace node.
 
const XML_NODE_TYPE_TEXT = XML_READER_TYPE_TEXT
 Indicates a text node.
 
const XML_NODE_TYPE_WHITESPACE = XML_READER_TYPE_WHITESPACE
 Indicates a whitespace node.
 
const XML_NODE_TYPE_XML_DECLARATION = XML_READER_TYPE_XML_DECLARATION
 Indicates an XML declaration node.
 
const XGF_ADD_FORMATTING = XGF_ADD_FORMATTING
 use whitespace formatting including line breaks to make generated XML more readable
 
const XGF_NONE = XGF_NONE
 no flags; standard XML generation without whitespace formatting and characters without unicode character references
 
const XGF_USE_NUMERIC_REFS = XGF_USE_NUMERIC_REFS
 use numeric character references instead of native characters for non-ascii character when generating XML More...
 
const XPF_ADD_COMMENTS = XPF_ADD_COMMENTS
 decode XML comments More...
 
const XPF_NONE = XPF_NONE
 no flags; standard XML parsing without character reference conversion
 
const XPF_PRESERVE_ORDER = XPF_PRESERVE_ORDER
 decode XML as data; do not try to preserve element order by re-writing hash keys More...
 
const XPF_STRIP_NS_PREFIXES = XPF_STRIP_NS_PREFIXES
 strip namespace prefixes from element names when parsing More...
 

Detailed Description

Qore::Xml namespace.