SXMLModel Class Reference
[XML Objects]

Base class for XML model classes. More...

Inheritance diagram for SXMLModel:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 commit ($updateObj=false)
 INSERT BRIEF DESCRIPTION HERE.
 getNodeName ()
 Retrieves root node name.
 getXML ($options=array())
 Overridden getXML() more specific for database classes.
 populate ($constraints)
 INSERT BRIEF DESCRIPTION HERE.


Detailed Description

Base class for XML model classes.

This class uses SModel2 but is geared for processing XML data sources. Since SModel2 already includes a great deal of XML processing, this class is fairly lightweight compared to, e.g., SDatabaseModel.


Member Function Documentation

SXMLModel::commit ( updateObj = false  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$updateObj [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Reimplemented from SModel2.

SXMLModel::getNodeName (  ) 

Retrieves root node name.

Returns:
Name of root node

SXMLModel::getXML ( options = array()  ) 

Overridden getXML() more specific for database classes.

All that this method does different is have the root node name default to the table name

Parameters:
$options [array]: options to control generation of XML
Returns:
[mixed]: string of XML or SimpleXML object

Reimplemented from SModel2.

SXMLModel::populate ( constraints  ) 

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:
$constraints [TYPE]: DESCRIPTION
Returns:
[TYPE]: RETURN DESCRIPTION

Reimplemented from SModel2.


The documentation for this class was generated from the following file:

Generated on Wed Nov 24 02:04:02 2010 for Common by  doxygen 1.5.6