XMLp Class

Properties   Methods   Events   Configuration Settings   Errors  

The XMLp component implements a SAX2-compliant XML parser with XPath DOM traversal that can be used to parse and verify the structure of XML documents.

Class Name

IPWorks_XMLp

Procedural Interface

 ipworks_xmlp_open();
 ipworks_xmlp_close($res);
 ipworks_xmlp_register_callback($res, $id, $function);
 ipworks_xmlp_get_last_error($res);
 ipworks_xmlp_get_last_error_code($res);
 ipworks_xmlp_set($res, $id, $index, $value);
 ipworks_xmlp_get($res, $id, $index);
 ipworks_xmlp_do_attr($res, $attrname);
 ipworks_xmlp_do_config($res, $configurationstring);
 ipworks_xmlp_do_flush($res);
 ipworks_xmlp_do_hasxpath($res, $xpath);
 ipworks_xmlp_do_input($res, $text);
 ipworks_xmlp_do_loaddom($res, $filename);
 ipworks_xmlp_do_parsefile($res, $filename);
 ipworks_xmlp_do_reset($res);
 ipworks_xmlp_do_savedom($res, $filename);

Remarks

The XMLp class parses XML documents and verifies that they are well-formed. The results are provided through a set of events complying with the SAX2 specification.

In addition, the document structure may be queried through an XPath mechanism that supports a subset of the XPath specification.

The parser is optimized for read applications, with a very fast engine that builds internal DOM structures with close to zero heap allocations.

The class takes pieces of XML code through the Input method, until Flush is called. The document is parsed and fires events like StartElement, EndElement, Characters, IgnorableWhitespace, PI, etc. Entities are evaluated inside the EvalEntity event. If BuildDOM is set to True, an internal DOM structure is created, which in turn enables properties such as XPath, XElement, XText, etc. which allow traversal of the document structure.

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildren, and XText providing other properties of the element. The XAttributes properties provides the attributes of the current element.

An additional "relaxed" mode allows for lexical parsing of non-XML documents (e.g. HTML). This is enabled by setting Validate to False. In this case, events will be fired as elements, entities, etc. are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.