OFXAggregate Class

Properties Methods Events Configuration Settings Errors

The OFXAggregate component supports parsing of XML aggregates that can be retrieved from other components.

Class Name

InEBank_OFXAggregate

Procedural Interface

 inebank_ofxaggregate_open();
 inebank_ofxaggregate_close($res);
 inebank_ofxaggregate_register_callback($res, $id, $function);
 inebank_ofxaggregate_get_last_error($res);
 inebank_ofxaggregate_get_last_error_code($res);
 inebank_ofxaggregate_set($res, $id, $index, $value);
 inebank_ofxaggregate_get($res, $id, $index);
 inebank_ofxaggregate_do_config($res, $configurationstring);
 inebank_ofxaggregate_do_hasxpath($res, $xpath);

Remarks

The OFXAggregate class supports simple XML aggregate traversal functionality. Simply set the Aggregate property to the value received from any aggregate property of any class in the package (e.g. the TxAggregate property from BankStatement or CCStatement). You can then use XPath to walk the Document Object Model (DOM) tree.

Property List

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


Aggregate	The full text of the current aggregate.
NamespaceCount	The number of records in the Namespace arrays.
NamespacePrefix	The Prefix for the Namespace .
NamespaceURI	Namespace URI associated with the corresponding Prefix .
XChildrenCount	The number of records in the XChild arrays.
XChildName	The Name property provides the local name (without prefix) of the element.
XChildNamespace	Namespace of the element.
XChildPrefix	Prefix of the element (if any).
XChildXText	The inner text of the element.
XElement	The name of the current element.
XNamespace	The namespace of the current element.
XParent	The parent of the current element.
XPath	Provides a way to point to a specific element in the document.
XPrefix	The prefix of the current element.
XText	The text of the current element.

Method List

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


Config	Sets or retrieves a configuration setting .
HasXPath	Checks whether a certain XPath exists inside the aggregate.

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.

Configuration Settings

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


IgnoreBadAttributePrefixes	If true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixes	If true, bad (unknown) element prefixes are ignored.
CacheContent	If true, the original XML is saved in a buffer.
ErrorOnEmptyAttr	If true, passing an invalid attribute to the Attr method will throw an exception.
PreserveWhitespace	If true, leading and trailing whitespace in element text is preserved.
CodePage	The system code page used for Unicode to Multibyte translations.