XML Class

Properties   Methods   Events   Config Settings   Errors  

The XML class can be used to both parse and create XML documents.

Class Name

IPWorks_XML

Procedural Interface

 ipworks_xml_open();
 ipworks_xml_close($res);
 ipworks_xml_register_callback($res, $id, $function);
 ipworks_xml_get_last_error($res);
 ipworks_xml_get_last_error_code($res);
 ipworks_xml_set($res, $id, $index, $value);
 ipworks_xml_get($res, $id, $index);
 ipworks_xml_do_config($res, $configurationstring);
 ipworks_xml_do_endelement($res);
 ipworks_xml_do_flush($res);
 ipworks_xml_do_getattr($res, $attrname);
 ipworks_xml_do_hasxpath($res, $xpath);
 ipworks_xml_do_loaddom($res, $filename);
 ipworks_xml_do_loadschema($res, $schema);
 ipworks_xml_do_parse($res);
 ipworks_xml_do_putattr($res, $name, $namespaceuri, $value);
 ipworks_xml_do_putcdata($res, $text);
 ipworks_xml_do_putcomment($res, $text);
 ipworks_xml_do_putelement($res, $name, $namespaceuri, $value);
 ipworks_xml_do_putraw($res, $text);
 ipworks_xml_do_putstring($res, $text);
 ipworks_xml_do_removeattr($res, $attrname);
 ipworks_xml_do_removechildren($res);
 ipworks_xml_do_removeelement($res);
 ipworks_xml_do_reset($res);
 ipworks_xml_do_save($res);
 ipworks_xml_do_savedom($res, $filename);
 ipworks_xml_do_startelement($res, $name, $namespaceuri);
 ipworks_xml_do_tryxpath($res, $xpath);

Remarks

The XML class can operate as either a parser or writer of XML.

Parsing XML

The XML 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 Document Object Model (DOM) structures with close to zero heap allocations. Additionally, BuildDOM can be set to False, which reduces the overhead of creating the DOM and offers a fast forward-only parsing implementation that fires events to provide the parsed data.

When parsing a document, events will fire to provide information about the parsed data. After Parse returns, the document may be navigated by setting XPath if BuildDOM is True (default). If BuildDOM is False, parsed data are accessible only through the events.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• Characters
• Comment
• EndElement
• EndPrefixMapping
• EvalEntity
• IgnorableWhitespace
• Meta
• PI
• SpecialSection
• StartElement
• StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

If parsing multiple documents, call Reset between documents to reset the parser.

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, and so on are encountered, but the structure of the document will not be checked for "well-formedness", and the internal DOM structure will not be built.

Writing XML

To use the class, first decide whether or not to write to file, or to OutputData.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• OutputFile
• OutputData: The output data are written to this property if no other destination is specified.

To begin writing the XML document, first optionally set XMLDeclaration. If this is not set, the class will use a default XML declaration at the beginning of the document.

Next, begin adding elements to your document. Calling StartElement will open an element with the specified name. To create a nested structure, continue calling StartElement to open more child elements. To write a value within an element, call PutString. To close the element that was last opened, call EndElement. Each time EndElement is called, the element at the current level is closed. Alternatively, calling PutElement will write the element specified with the value specified and will also close the element.

To write an attribute of the current element, after calling StartElement call PutAttr. Call PutAttr multiple times to add multiple attributes.

Writing comments or CDATA can be done at any time with the PutComment and PutCData methods.

To close your XML document, call Save. You can call Save from any location, and it will close any remaining open elements automatically.

Property List

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

BuildDOM Property (IPWorks_XML Class)

When set to True, this property creates an internal object model of the XML document.

Object Oriented Interface

public function getBuildDOM();
public function setBuildDOM($value);

Procedural Interface

ipworks_xml_get($res, 1 );
ipworks_xml_set($res, 1, $value );

Default Value

true

Remarks

Set BuildDOM to True when you need to browse the current document through XPath.

Validate is automatically set to True when BuildDOM is set to True.

Data Type

Boolean

InputData Property (IPWorks_XML Class)

This property specifies the XML data to parse.

Object Oriented Interface

public function getInputData();
public function setInputData($value);

Procedural Interface

ipworks_xml_get($res, 2 );
ipworks_xml_set($res, 2, $value );

Default Value

''

Remarks

This property specifies the XML to be processed. Set this property before calling Parse.

This property may be set to a complete XML document or to partial data. When setting partial data, call Parse after each chunk of data is set. For instance:

//Parse the following in chunks: <test>1</test> xml.InputData = "<test>" xml.Parse(); xml.InputData = "1<test>" xml.Parse();

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

Data Type

String

InputFile Property (IPWorks_XML Class)

This property specifies the file to process.

Object Oriented Interface

public function getInputFile();
public function setInputFile($value);

Procedural Interface

ipworks_xml_get($res, 3 );
ipworks_xml_set($res, 3, $value );

Default Value

''

Remarks

This property specifies the file to be processed. Set this property to the full or relative path to the file that will be processed.

After setting this property, call Parse to parse the document.

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

Data Type

String

NamespaceCount Property (IPWorks_XML Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();
public function setNamespaceCount($value);

Procedural Interface

ipworks_xml_get($res, 4 );
ipworks_xml_set($res, 4, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• NamespacePrefix
• NamespaceURI

The array indices start at 0 and end at NamespaceCount - 1.

This property is not available at design time.

Data Type

Integer

NamespacePrefix Property (IPWorks_XML Class)

This property contains the Prefix for the Namespace .

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);
public function setNamespacePrefix($namespaceindex, $value);

Procedural Interface

ipworks_xml_get($res, 5 , $namespaceindex);
ipworks_xml_set($res, 5, $value , $namespaceindex);

Default Value

''

Remarks

This property contains the NamespacePrefix for the Namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

NamespaceURI Property (IPWorks_XML Class)

This property contains the namespace URI associated with the corresponding Prefix .

Object Oriented Interface

public function getNamespaceURI($namespaceindex);
public function setNamespaceURI($namespaceindex, $value);

Procedural Interface

ipworks_xml_get($res, 6 , $namespaceindex);
ipworks_xml_set($res, 6, $value , $namespaceindex);

Default Value

''

Remarks

This property contains the namespace URI associated with the corresponding NamespacePrefix. This URL is usually pointing to the XML schema for the namespace.

The $namespaceindex parameter specifies the index of the item in the array. The size of the array is controlled by the NamespaceCount property.

This property is not available at design time.

Data Type

String

OutputData Property (IPWorks_XML Class)

The output XML after processing.

Object Oriented Interface

public function getOutputData();
public function setOutputData($value);

Procedural Interface

ipworks_xml_get($res, 7 );
ipworks_xml_set($res, 7, $value );

Default Value

''

Remarks

This property will be populated with the output from the operation if OutputFile is not set.

Data Type

String

OutputFile Property (IPWorks_XML Class)

This property includes the path to a local file where the output will be written.

Object Oriented Interface

public function getOutputFile();
public function setOutputFile($value);

Procedural Interface

ipworks_xml_get($res, 8 );
ipworks_xml_set($res, 8, $value );

Default Value

''

Remarks

This property specifies the file to which the output will be written. This may be set to an absolute or relative path.

Output Properties

The class will determine the destination of the output based on which properties are set.

The order in which the output properties are checked is as follows:

• OutputFile
• OutputData: The output data are written to this property if no other destination is specified.

Data Type

String

Overwrite Property (IPWorks_XML Class)

This property indicates whether or not the class should overwrite files.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworks_xml_get($res, 9 );
ipworks_xml_set($res, 9, $value );

Default Value

false

Remarks

This property indicates whether or not the class will overwrite OutputFile. If Overwrite is False, an error will be thrown whenever OutputFile exists before an operation. The default value is False.

Data Type

Boolean

Validate Property (IPWorks_XML Class)

This property controls whether documents are validated during parsing.

Object Oriented Interface

public function getValidate();
public function setValidate($value);

Procedural Interface

ipworks_xml_get($res, 10 );
ipworks_xml_set($res, 10, $value );

Default Value

true

Remarks

When true (default), the document will be validated during parsing. To disable validation set Validate to false. Disabling validation may be useful in cases in which data can still be parsed even if the document is not well formed.

Data Type

Boolean

AttrCount Property (IPWorks_XML Class)

The number of records in the Attr arrays.

Object Oriented Interface

public function getAttrCount();
public function setAttrCount($value);

Procedural Interface

ipworks_xml_get($res, 11 );
ipworks_xml_set($res, 11, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• AttrName
• AttrNamespace
• AttrPrefix
• AttrValue

The array indices start at 0 and end at AttrCount - 1.

This property is not available at design time.

Data Type

Integer

AttrName Property (IPWorks_XML Class)

The Name provides the local name (without prefix) of the attribute.

Object Oriented Interface

public function getAttrName($attrindex);

Procedural Interface

ipworks_xml_get($res, 12 , $attrindex);

Default Value

''

Remarks

The AttrName provides the local name (without prefix) of the attribute.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrNamespace Property (IPWorks_XML Class)

This property contains the attribute namespace.

Object Oriented Interface

public function getAttrNamespace($attrindex);

Procedural Interface

ipworks_xml_get($res, 13 , $attrindex);

Default Value

''

Remarks

This property contains the attribute namespace.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrPrefix Property (IPWorks_XML Class)

This property contains the attribute prefix (if any).

Object Oriented Interface

public function getAttrPrefix($attrindex);

Procedural Interface

ipworks_xml_get($res, 14 , $attrindex);

Default Value

''

Remarks

This property contains the attribute prefix (if any). If the attribute does not have a prefix, this property is empty.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

AttrValue Property (IPWorks_XML Class)

This property contains the attribute value.

Object Oriented Interface

public function getAttrValue($attrindex);

Procedural Interface

ipworks_xml_get($res, 15 , $attrindex);

Default Value

''

Remarks

This property contains the attribute value.

The $attrindex parameter specifies the index of the item in the array. The size of the array is controlled by the AttrCount property.

This property is read-only and not available at design time.

Data Type

String

XChildCount Property (IPWorks_XML Class)

The number of records in the XChild arrays.

Object Oriented Interface

public function getXChildCount();
public function setXChildCount($value);

Procedural Interface

ipworks_xml_get($res, 16 );
ipworks_xml_set($res, 16, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• XChildName
• XChildNamespace
• XChildPrefix
• XChildXText

The array indices start at 0 and end at XChildCount - 1.

This property is not available at design time.

Data Type

Integer

XChildName Property (IPWorks_XML Class)

The Name property provides the local name (without a prefix) of the element.

Object Oriented Interface

public function getXChildName($xchildindex);

Procedural Interface

ipworks_xml_get($res, 17 , $xchildindex);

Default Value

''

Remarks

The XChildName property provides the local name (without a prefix) of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildNamespace Property (IPWorks_XML Class)

This property contains the namespace of the element.

Object Oriented Interface

public function getXChildNamespace($xchildindex);

Procedural Interface

ipworks_xml_get($res, 18 , $xchildindex);

Default Value

''

Remarks

This property contains the namespace of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildPrefix Property (IPWorks_XML Class)

This property contains the prefix of the element (if any).

Object Oriented Interface

public function getXChildPrefix($xchildindex);

Procedural Interface

ipworks_xml_get($res, 19 , $xchildindex);

Default Value

''

Remarks

This property contains the prefix of the element (if any). If the element does not have a prefix, this property is empty.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XChildXText Property (IPWorks_XML Class)

This property contains the inner text of the element.

Object Oriented Interface

public function getXChildXText($xchildindex);

Procedural Interface

ipworks_xml_get($res, 20 , $xchildindex);

Default Value

''

Remarks

This property contains the inner text of the element.

The $xchildindex parameter specifies the index of the item in the array. The size of the array is controlled by the XChildCount property.

This property is read-only and not available at design time.

Data Type

String

XCommentCount Property (IPWorks_XML Class)

The number of records in the XComment arrays.

Object Oriented Interface

public function getXCommentCount();
public function setXCommentCount($value);

Procedural Interface

ipworks_xml_get($res, 21 );
ipworks_xml_set($res, 21, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• XCommentText

The array indices start at 0 and end at XCommentCount - 1.

This property is not available at design time.

Data Type

Integer

XCommentText Property (IPWorks_XML Class)

This property holds the comment text.

Object Oriented Interface

public function getXCommentText($xcommentindex);
public function setXCommentText($xcommentindex, $value);

Procedural Interface

ipworks_xml_get($res, 22 , $xcommentindex);
ipworks_xml_set($res, 22, $value , $xcommentindex);

Default Value

''

Remarks

This property holds the comment text.

The $xcommentindex parameter specifies the index of the item in the array. The size of the array is controlled by the XCommentCount property.

This property is not available at design time.

Data Type

String

XElement Property (IPWorks_XML Class)

This property includes the name of the current element.

Object Oriented Interface

public function getXElement();
public function setXElement($value);

Procedural Interface

ipworks_xml_get($res, 23 );
ipworks_xml_set($res, 23, $value );

Default Value

''

Remarks

The current element is specified through the XPath property.

Data Type

String

XMLDeclarationEncoding Property (IPWorks_XML Class)

This property specifies the XML encoding to use.

Object Oriented Interface

public function getXMLDeclarationEncoding();
public function setXMLDeclarationEncoding($value);

Procedural Interface

ipworks_xml_get($res, 24 );
ipworks_xml_set($res, 24, $value );

Default Value

'utf-8'

Remarks

This property specifies the XML encoding to use.

This may be set before writing a document. The default value is UTF-8.

This is applicable only when writing XML.

This property is not available at design time.

Data Type

String

XMLDeclarationStandalone Property (IPWorks_XML Class)

This property indicates whether the standalone attribute is present in the declaration with a value of True.

Object Oriented Interface

public function getXMLDeclarationStandalone();
public function setXMLDeclarationStandalone($value);

Procedural Interface

ipworks_xml_get($res, 25 );
ipworks_xml_set($res, 25, $value );

Default Value

true

Remarks

This property indicates whether the standalone attribute is present in the declaration with a value of True.

This may be set before writing a document. The default value is True.

This is applicable only when writing XML.

This property is not available at design time.

Data Type

Boolean

XMLDeclarationVersion Property (IPWorks_XML Class)

This property specifies the XML version.

Object Oriented Interface

public function getXMLDeclarationVersion();
public function setXMLDeclarationVersion($value);

Procedural Interface

ipworks_xml_get($res, 26 );
ipworks_xml_set($res, 26, $value );

Default Value

'1.0'

Remarks

This property specifies the XML version.

This may be set before writing a document. The default value is 1.0.

This is applicable only when writing XML.

This property is not available at design time.

Data Type

String

XNamespace Property (IPWorks_XML Class)

This property includes the namespace of the current element.

Object Oriented Interface

public function getXNamespace();
public function setXNamespace($value);

Procedural Interface

ipworks_xml_get($res, 27 );
ipworks_xml_set($res, 27, $value );

Default Value

''

Remarks

The current element is specified through the XPath property.

Data Type

String

XParent Property (IPWorks_XML Class)

This property includes the parent of the current element.

Object Oriented Interface

public function getXParent();

Procedural Interface

ipworks_xml_get($res, 28 );

Default Value

''

Remarks

The current element is specified through the XPath property.

This property is read-only.

Data Type

String

XPath Property (IPWorks_XML Class)

This property provides a way to point to a specific element in the document.

Object Oriented Interface

public function getXPath();
public function setXPath($value);

Procedural Interface

ipworks_xml_get($res, 29 );
ipworks_xml_set($res, 29, $value );

Default Value

''

Remarks

XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Data Type

String

XPrefix Property (IPWorks_XML Class)

This property includes the prefix of the current element.

Object Oriented Interface

public function getXPrefix();
public function setXPrefix($value);

Procedural Interface

ipworks_xml_get($res, 30 );
ipworks_xml_set($res, 30, $value );

Default Value

''

Remarks

The current element is specified through the XPath property.

Data Type

String

XSubTree Property (IPWorks_XML Class)

This property includes a snapshot of the current element in the document.

Object Oriented Interface

public function getXSubTree();

Procedural Interface

ipworks_xml_get($res, 31 );

Default Value

''

Remarks

The current element is specified through the XPath property. For this property to work, you must set the CacheContent to True.

This property is read-only.

Data Type

String

XText Property (IPWorks_XML Class)

This property includes the text of the current element.

Object Oriented Interface

public function getXText();
public function setXText($value);

Procedural Interface

ipworks_xml_get($res, 32 );
ipworks_xml_set($res, 32, $value );

Default Value

''

Remarks

The current element is specified through the XPath property.

Data Type

String

Config Method (IPWorks_XML Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworks_xml_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

EndElement Method (IPWorks_XML Class)

This method writes the closing tag of an open XML element.

Object Oriented Interface

public function doEndElement();

Procedural Interface

ipworks_xml_do_endelement($res);

Remarks

This method writes the closing tag of the XML element most recently opened using StartElement.

If no elements are opened, the call fails with an error

Flush Method (IPWorks_XML Class)

This method flushes the parser and checks its end state.

Object Oriented Interface

public function doFlush();

Procedural Interface

ipworks_xml_do_flush($res);

Remarks

When Flush is called, the parser flushes all its buffers, firing events as necessary, and then checks its end state. If Validate is True, the parser verifies that all open elements were closed, returning an error if not.

GetAttr Method (IPWorks_XML Class)

This method returns the value of the specified attribute.

Object Oriented Interface

public function doGetAttr($attrname);

Procedural Interface

ipworks_xml_do_getattr($res, $attrname);

Remarks

This method returns the value of the attribute specified by the AttrName parameter.

If the attribute does not exist, an empty string is returned. The behavior when an attribute does not exit is controlled by ErrorOnEmptyAttr.

Please refer to the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties for more information.

HasXPath Method (IPWorks_XML Class)

This method determines whether a specific element exists in the document.

Object Oriented Interface

public function doHasXPath($xpath);

Procedural Interface

ipworks_xml_do_hasxpath($res, $xpath);

Remarks

This method determines whether a particular XPath exists within the document. This may be used to check if a path exists before setting it through XPath.

This method returns True if the xpath exists, and False if not.

See XPath for details on the XPath syntax.

LoadDOM Method (IPWorks_XML Class)

This method loads the document object model (DOM) from a file.

Object Oriented Interface

public function doLoadDOM($filename);

Procedural Interface

ipworks_xml_do_loaddom($res, $filename);

Remarks

The LoadDOM method loads a DOM structure previously saved by SaveDOM from the file specified in FileName.

Please refer to the SaveDOM method for more information.

LoadSchema Method (IPWorks_XML Class)

This method loads the XML schema.

Object Oriented Interface

public function doLoadSchema($schema);

Procedural Interface

ipworks_xml_do_loadschema($res, $schema);

Remarks

This functionality is not yet implemented.

This method loads the schema specified in the Schema parameter. The Schema may be specified as either a string or the path to a file on disk.

The class will validate the input data during parsing to verify whether or not it adheres to the schema.

Parse Method (IPWorks_XML Class)

This method parses the specified XML data.

Object Oriented Interface

public function doParse();

Procedural Interface

ipworks_xml_do_parse($res);

Remarks

This method parses the specified XML data.

When parsing a document, events will fire to provide information about the parsed data. After Parse returns, the document may be navigated by setting XPath if BuildDOM is True (default). If BuildDOM is False, parsed data are accessible only through the events.

Events are fired only when qualifying conditions (e.g., the beginning of a new element) are met. In the meantime, text will be buffered internally. The following events will fire during parsing:

• Characters
• Comment
• EndElement
• EndPrefixMapping
• EvalEntity
• IgnorableWhitespace
• Meta
• PI
• SpecialSection
• StartElement
• StartPrefixMapping

If BuildDOM is True (default), XPath may be set after this method returns. XPath implements a subset of the XML XPath specification, allowing you to point to specific elements in the XML documents.

The path is a series of one or more element accessors separated by '/'. The path can be absolute (starting with '/') or relative to the current XPath location.

The following are possible values for an element accessor:

BuildDOM must be set to True before parsing the document for the XPath functionality to be available.

Example. Setting XPath:

Input Properties

The class will determine the source of the input based on which properties are set.

The order in which the input properties are checked is as follows:

• InputFile
• InputData

If parsing multiple documents, call Reset between documents to reset the parser.

PutAttr Method (IPWorks_XML Class)

This method writes an XML attribute.

Object Oriented Interface

public function doPutAttr($name, $namespaceuri, $value);

Procedural Interface

ipworks_xml_do_putattr($res, $name, $namespaceuri, $value);

Remarks

This method writes an XML attribute on the currently opened XML element. It must be called right after calling StartElement and before any calls to PutString, PutComment, or PutRaw.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

Certain attribute names will be handled in special ways by this method. If Name is "xmlns" or uses the "xmlns" prefix, the attribute will be interpreted as a namespace declaration, regardless of the value of NamespaceURI. Similarly, any attribute using the "xml" prefix will be interpreted as a special attribute (like "xml:lang") and NamespaceURI will be ignored.

PutCData Method (IPWorks_XML Class)

This method writes an XML CDATA block.

Object Oriented Interface

public function doPutCData($text);

Procedural Interface

ipworks_xml_do_putcdata($res, $text);

Remarks

This methods writes a new XML CDATA block with the specified text inside the current element.

PutComment Method (IPWorks_XML Class)

This method writes an XML comment block.

Object Oriented Interface

public function doPutComment($text);

Procedural Interface

ipworks_xml_do_putcomment($res, $text);

Remarks

This method writes a new XML comment block with the specified text.

PutElement Method (IPWorks_XML Class)

This method writes a simple XML element with a value.

Object Oriented Interface

public function doPutElement($name, $namespaceuri, $value);

Procedural Interface

ipworks_xml_do_putelement($res, $name, $namespaceuri, $value);

Remarks

This method writes a simple XML element with no attributes and the specified value between the opening and closing tags.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling PutElement or StartElement, if a NamespaceURI is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

PutRaw Method (IPWorks_XML Class)

This method writes a raw XML fragment.

Object Oriented Interface

public function doPutRaw($text);

Procedural Interface

ipworks_xml_do_putraw($res, $text);

Remarks

This method writes a raw XML fragment to the output, without escaping and without verification. If an XML element opening tag has been written before the raw fragment, the fragment will be written as a child of the current element.

Use of this method should be carefully considered as it can easily lead to malformed XML content.

PutString Method (IPWorks_XML Class)

This method writes text inside an XML element.

Object Oriented Interface

public function doPutString($text);

Procedural Interface

ipworks_xml_do_putstring($res, $text);

Remarks

This method will XML escape the value provided and write the resulting escaped text between the opening and closing tags of an XML element.

RemoveAttr Method (IPWorks_XML Class)

This method removes an attribute.

Object Oriented Interface

public function doRemoveAttr($attrname);

Procedural Interface

ipworks_xml_do_removeattr($res, $attrname);

Remarks

This method removes an attribute at the specified XPath

This functionality is not yet implemented.

RemoveChildren Method (IPWorks_XML Class)

This method removes the children of the element as the specified XPath.

Object Oriented Interface

public function doRemoveChildren();

Procedural Interface

ipworks_xml_do_removechildren($res);

Remarks

This method removes the children of the element specified by XPath.

When called, the class will remove the children of the element from the internal representation of the XML (the DOM). The element itself remains, with no children. This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveChildren:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the children of the apple element while leaving the apple element in place.

xml.XPath = "/food/fruits/apple"; xml.RemoveChildren();

The XML stored in the DOM is now:

<food>
	<fruits>
		<apple>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

RemoveElement Method (IPWorks_XML Class)

This method removes the element as the specified XPath.

Object Oriented Interface

public function doRemoveElement();

Procedural Interface

ipworks_xml_do_removeelement($res);

Remarks

This method removes the element specified by XPath.

When called, the class will remove the element and its children from the internal representation of the XML (the DOM). This may be used at any time after Parse returns, or from within the EndElement event as a document is parsed to remove sections of a document that will not be needed later. By removing unnecessary elements from the DOM, memory consumption is reduced and overall performance is improved.

Example. RemoveElement:

Given the XML

<food>
	<fruits>
		<apple>
			<color>red</color>
		</apple>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

This code removes the apple element and its children.

xml.XPath = "/food/fruits/apple"; xml.RemoveElement();

The XML stored in the DOM is now:

<food>
	<fruits>
		<banana>
			<color>yellow</color>
		</banana>
	</fruits>
</food>

Reset Method (IPWorks_XML Class)

This method resets the parser.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworks_xml_do_reset($res);

Remarks

When called, the parser flushes all its buffers, firing events as necessary, and then initializes itself to its default state.

Reset must also be used as signal to the parser that the current stream of text has terminated.

Save Method (IPWorks_XML Class)

This method closes the class writing stream.

Object Oriented Interface

public function doSave();

Procedural Interface

ipworks_xml_do_save($res);

Remarks

This method will close any open XML elements, and then close the OutputFile if necessary.

SaveDOM Method (IPWorks_XML Class)

This method saves the DOM to a file.

Object Oriented Interface

public function doSaveDOM($filename);

Procedural Interface

ipworks_xml_do_savedom($res, $filename);

Remarks

The SaveDOM method saves the current DOM structure to the file specified in FileName. This enables the component to later load the DOM without incurring any parsing overhead.

Please refer to the LoadDOM method for more information.

StartElement Method (IPWorks_XML Class)

This method writes the opening tag of an XML element.

Object Oriented Interface

public function doStartElement($name, $namespaceuri);

Procedural Interface

ipworks_xml_do_startelement($res, $name, $namespaceuri);

Remarks

This method writes the opening tag of a new XML element. If an XML element is already opened, then this element is written as a child.

If Name is a local name without a prefix, the class will automatically introduce a new xmlns="NamespaceURI" attribute, if necessary.

If Name is in the form prefix:local, then class will automatically introduce a new xmlns:prefix="NamespaceURI" as necessary.

When calling PutElement or StartElement, if a NamespaceURI is not specified, an empty namespace will be defined for the element. If a namespace should be associated with the element, a NamespaceURI value must be provided. When creating the XML, the class will determine if the namespace already exists to avoid duplicate definitions of the same namespace. For example, to create this XML:

<book xmlns='urn:loc.gov:books'
      xmlns:isbn='urn:ISBN:0-395-36341-6'>
    <title>Cheaper by the Dozen</title>
    <isbn:number>1568491379</isbn:number>
</book>

TryXPath Method (IPWorks_XML Class)

This method navigates to the specified XPath if it exists.

Object Oriented Interface

public function doTryXPath($xpath);

Procedural Interface

ipworks_xml_do_tryxpath($res, $xpath);

Remarks

This method will attempt to navigate to the specified XPath parameter if it exists within the document.

If the XPath exists, the XPath property will be updated and this method returns True.

If the XPath does not exist, the XPath property is not updated and this method returns False.

Characters Event (IPWorks_XML Class)

This event is fired for plaintext segments of the input stream.

Object Oriented Interface

public function fireCharacters($param);

Procedural Interface

ipworks_xml_register_callback($res, 1, array($this, 'fireCharacters'));

Parameter List

 'text'

Remarks

The Characters event provides the plaintext content of the XML document (i.e., the text inside the tags). The text is provided through the Text parameter.

The text includes white space as well as end-of-line characters, except for ignorable whitespace, which is fired through the IgnorableWhitespace event.

Comment Event (IPWorks_XML Class)

This event is fired when a comment section is encountered.

Object Oriented Interface

public function fireComment($param);

Procedural Interface

ipworks_xml_register_callback($res, 2, array($this, 'fireComment'));

Parameter List

 'text'

Remarks

The Comment event is fired whenever a comment section (<!-- ..text... -->) is found in the document.

The full text of the comment is provided by the Text parameter.

EndElement Event (IPWorks_XML Class)

This event is fired when an end-element tag is encountered.

Object Oriented Interface

public function fireEndElement($param);

Procedural Interface

ipworks_xml_register_callback($res, 3, array($this, 'fireEndElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The EndElement event is fired when an end-element tag is found in the document.

The element name is provided by the Element parameter.

The IsEmpty parameter is true when the event corresponds to an empty element declaration.

EndPrefixMapping Event (IPWorks_XML Class)

This event is fired when leaving the scope of a namespace declaration.

Object Oriented Interface

public function fireEndPrefixMapping($param);

Procedural Interface

ipworks_xml_register_callback($res, 4, array($this, 'fireEndPrefixMapping'));

Parameter List

 'prefix'

Remarks

The StartPrefixMapping event is fired when entering the scope of a namespace declaration.

Error Event (IPWorks_XML Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworks_xml_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

EvalEntity Event (IPWorks_XML Class)

This event is fired every time an entity needs to be evaluated.

Object Oriented Interface

public function fireEvalEntity($param);

Procedural Interface

ipworks_xml_register_callback($res, 6, array($this, 'fireEvalEntity'));

Parameter List

 'entity'
 'value'

Remarks

The Value parameter contains a suggested value for the entity (normally the entity name itself). You may set Value to a value of your choice, which will be later passed into the text stream.

IgnorableWhitespace Event (IPWorks_XML Class)

This event is fired when a section of ignorable whitespace is encountered.

Object Oriented Interface

public function fireIgnorableWhitespace($param);

Procedural Interface

ipworks_xml_register_callback($res, 7, array($this, 'fireIgnorableWhitespace'));

Parameter List

 'text'

Remarks

The ignorable whitespace section is provided by the Text parameter.

Meta Event (IPWorks_XML Class)

This event fires when a meta section is encountered.

Object Oriented Interface

public function fireMeta($param);

Procedural Interface

ipworks_xml_register_callback($res, 8, array($this, 'fireMeta'));

Parameter List

 'text'

Remarks

The Meta event is fired whenever a meta information section (<! ..text... >) is found in the document.

The full text of the meta section is provided by the Text parameter.

PI Event (IPWorks_XML Class)

This event is fired when a processing instruction section is encountered.

Object Oriented Interface

public function firePI($param);

Procedural Interface

ipworks_xml_register_callback($res, 9, array($this, 'firePI'));

Parameter List

 'text'

Remarks

The PI event is fired whenever a processing instruction section (<? ..text... ?>) is found in the document.

The full text of the processing instruction is provided by the Text parameter.

SpecialSection Event (IPWorks_XML Class)

This event is fired when a special section is encountered.

Object Oriented Interface

public function fireSpecialSection($param);

Procedural Interface

ipworks_xml_register_callback($res, 10, array($this, 'fireSpecialSection'));

Parameter List

 'sectionid'
 'text'

Remarks

The SpecialSection event is fired whenever a special section (such as <![ CDATA [ ..text... ]]>) is found in the document.

The full text of the special section is provided by the Text parameter, and the SectionId parameter provides the section identifier (e.g., CDATA).

StartElement Event (IPWorks_XML Class)

This event is fired when a begin-element tag is encountered in the document.

Object Oriented Interface

public function fireStartElement($param);

Procedural Interface

ipworks_xml_register_callback($res, 11, array($this, 'fireStartElement'));

Parameter List

 'namespace'
 'element'
 'qname'
 'isempty'

Remarks

The StartElement event is fired when a begin-element tag is found in the document.

The element name is provided through the Element parameter. The attribute names and values (if any) are provided through the AttrName, AttrNamespace, AttrPrefix, and AttrValue properties.

The IsEmpty parameter is True when the event corresponds to an empty element declaration.

StartPrefixMapping Event (IPWorks_XML Class)

This event is fired when entering the scope of a namespace declaration.

Object Oriented Interface

public function fireStartPrefixMapping($param);

Procedural Interface

ipworks_xml_register_callback($res, 12, array($this, 'fireStartPrefixMapping'));

Parameter List

 'prefix'
 'uri'

Remarks

The EndPrefixMapping event is fired when leaving the scope of a namespace declaration.

XML Event (IPWorks_XML Class)

This event is fired as XML is written.

Object Oriented Interface

public function fireXML($param);

Procedural Interface

ipworks_xml_register_callback($res, 13, array($this, 'fireXML'));

Parameter List

 'text'

Remarks

This event is fired when XML is output. The Text parameter holds the data being written.

This functionality is not yet implemented.

Config Settings (XML Class)

XML Config Settings

<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
...

Base Config Settings

Trappable Errors (XML Class)

XML Errors