OFXAggregate Class

Properties   Methods   Events   Config Settings   Errors  

The OFXAggregate class supports parsing of XML aggregates that can be retrieved from other classes.

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.

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.

Aggregate Property (InEBank_OFXAggregate Class)

The full text of the current aggregate.

Object Oriented Interface

public function getAggregate();


public function setAggregate($value);

Procedural Interface

inebank_ofxaggregate_get($res, 1 );


inebank_ofxaggregate_set($res, 1, $value );

Default Value

''

Remarks

Aggregate contains the full text of the XML aggregate currently being represented by the class's DOM. You may set this to a value obtained from any aggregate property of any other control (such as SignOnInfoAggregate from FIProfile). Once set, you can use XPath to walk the DOM tree. XElement and XText will retrieve the current element's name and contents, and XChildren can be used to get the number of children.

Data Type

String

NamespaceCount Property (InEBank_OFXAggregate Class)

The number of records in the Namespace arrays.

Object Oriented Interface

public function getNamespaceCount();


public function setNamespaceCount($value);

Procedural Interface

inebank_ofxaggregate_get($res, 2 );


inebank_ofxaggregate_set($res, 2, $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 (InEBank_OFXAggregate Class)

The Prefix for the Namespace .

Object Oriented Interface

public function getNamespacePrefix($namespaceindex);


public function setNamespacePrefix($namespaceindex, $value);

Procedural Interface

inebank_ofxaggregate_get($res, 3 , $namespaceindex);


inebank_ofxaggregate_set($res, 3, $value , $namespaceindex);

Default Value

''

Remarks

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 (InEBank_OFXAggregate Class)

Namespace URI associated with the corresponding Prefix .

Object Oriented Interface

public function getNamespaceURI($namespaceindex);


public function setNamespaceURI($namespaceindex, $value);

Procedural Interface

inebank_ofxaggregate_get($res, 4 , $namespaceindex);


inebank_ofxaggregate_set($res, 4, $value , $namespaceindex);

Default Value

''

Remarks

Namespace URI associated with the corresponding NamespacePrefix. This is usually a URL 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

XChildCount Property (InEBank_OFXAggregate Class)

The number of records in the XChild arrays.

Object Oriented Interface

public function getXChildCount();


public function setXChildCount($value);

Procedural Interface

inebank_ofxaggregate_get($res, 5 );


inebank_ofxaggregate_set($res, 5, $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 (InEBank_OFXAggregate Class)

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

Object Oriented Interface

public function getXChildName($xchildindex);

Procedural Interface

inebank_ofxaggregate_get($res, 6 , $xchildindex);

Default Value

''

Remarks

The XChildName property provides the local name (without 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 (InEBank_OFXAggregate Class)

Namespace of the element.

Object Oriented Interface

public function getXChildNamespace($xchildindex);

Procedural Interface

inebank_ofxaggregate_get($res, 7 , $xchildindex);

Default Value

''

Remarks

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 (InEBank_OFXAggregate Class)

Prefix of the element (if any).

Object Oriented Interface

public function getXChildPrefix($xchildindex);

Procedural Interface

inebank_ofxaggregate_get($res, 8 , $xchildindex);

Default Value

''

Remarks

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 (InEBank_OFXAggregate Class)

The inner text of the element.

Object Oriented Interface

public function getXChildXText($xchildindex);

Procedural Interface

inebank_ofxaggregate_get($res, 9 , $xchildindex);

Default Value

''

Remarks

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

XElement Property (InEBank_OFXAggregate Class)

The name of the current element.

Object Oriented Interface

public function getXElement();


public function setXElement($value);

Procedural Interface

inebank_ofxaggregate_get($res, 10 );


inebank_ofxaggregate_set($res, 10, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XNamespace Property (InEBank_OFXAggregate Class)

The namespace of the current element.

Object Oriented Interface

public function getXNamespace();


public function setXNamespace($value);

Procedural Interface

inebank_ofxaggregate_get($res, 11 );


inebank_ofxaggregate_set($res, 11, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XParent Property (InEBank_OFXAggregate Class)

The parent of the current element.

Object Oriented Interface

public function getXParent();

Procedural Interface

inebank_ofxaggregate_get($res, 12 );

Default Value

''

Remarks

The current element is specified via the XPath property.

This property is read-only.

Data Type

String

XPath Property (InEBank_OFXAggregate Class)

Provides a way to point to a specific element in the document.

Object Oriented Interface

public function getXPath();


public function setXPath($value);

Procedural Interface

inebank_ofxaggregate_get($res, 13 );


inebank_ofxaggregate_set($res, 13, $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:

When XPath is set to a valid path, XElement points to the name of the element, with XParent, XNamespace, XPrefix, XChildName, XChildNamespace, XChildPrefix, XChildXText, and XText providing other properties of the element. The attributes of the current element are provided in the XAttributesName, XAttributesNamespace, XAttributesPrefix, and XAttributesValue properties.

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

Example (Setting XPath):

Data Type

String

XPrefix Property (InEBank_OFXAggregate Class)

The prefix of the current element.

Object Oriented Interface

public function getXPrefix();


public function setXPrefix($value);

Procedural Interface

inebank_ofxaggregate_get($res, 14 );


inebank_ofxaggregate_set($res, 14, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

XText Property (InEBank_OFXAggregate Class)

The text of the current element.

Object Oriented Interface

public function getXText();


public function setXText($value);

Procedural Interface

inebank_ofxaggregate_get($res, 15 );


inebank_ofxaggregate_set($res, 15, $value );

Default Value

''

Remarks

The current element is specified via the XPath property.

Data Type

String

Config Method (InEBank_OFXAggregate Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

inebank_ofxaggregate_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.

HasXPath Method (InEBank_OFXAggregate Class)

Checks whether a certain XPath exists inside the aggregate.

Object Oriented Interface

public function doHasXPath($xpath);

Procedural Interface

inebank_ofxaggregate_do_hasxpath($res, $xpath);

Remarks

Used when there is no assurance that a certain XPath exists inside an aggregate.

Error Event (InEBank_OFXAggregate Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

inebank_ofxaggregate_register_callback($res, 1, 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.

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

Config Settings (OFXAggregate Class)

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

Trappable Errors (OFXAggregate Class)

XML Errors

	101   Invalid attribute index.
	102   No attributes available.
	103   Invalid namespace index.
	104   No namespaces available.
	105   Invalid element index.
	106   No elements available.
	107   Attribute does not exist.
	201   Unbalanced element tag.
	202   Unknown element prefix (can't find namespace).
	203   Unknown attribute prefix (can't find namespace).
	204   Invalid XML markup.
	205   Invalid end state for parser.
	206   Document contains unbalanced elements.
	207   Invalid XPath.
	208   No such child.
	209   Top element does not match start of path.
	210   DOM tree unavailable (set BuildDOM to true and reparse).
	302   Can't open file.
	401   Invalid XML would be generated.
	402   An invalid XML name has been specified.