SXMLModel Class Reference
[XML Objects]

Base class for XML model classes. More...

Inheritance diagram for SXMLModel:

[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.
Protected Member Functions
	registerNodeName ($name)
	Registers the name of the root node for the XML this object represents.

---

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.

Definition at line 12 of file SXMLModel.php5.

---

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.

Definition at line 38 of file SXMLModel.php5.

SXMLModel::getNodeName

(

)

Retrieves root node name.

Returns:

Name of root node

Definition at line 56 of file SXMLModel.php5.

Referenced by SDRContextObj::getXMLImpl().

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.

Definition at line 67 of file SXMLModel.php5.

Referenced by SDRVocabList::getXMLImpl(), and SDRResourceObj::getXMLImpl().

SXMLModel::populate

(

$

constraints

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$constraints

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Reimplemented from SModel2.

Definition at line 27 of file SXMLModel.php5.

SXMLModel::registerNodeName

(

$

name

)

[protected]

Registers the name of the root node for the XML this object represents.

For internal use only.

Parameters:

$name

[string]: name of root node

Definition at line 47 of file SXMLModel.php5.

Referenced by SDRVocabList::__construct(), SDRResultsInfoObj::__construct(), SDRResponse::__construct(), SDRResourceObj::__construct(), SDRResourceList::__construct(), SDRRelationshipObj::__construct(), SDRRelationshipList::__construct(), SDRMetadataObj::__construct(), SDRContextObj::__construct(), SDRAlignmentObj::__construct(), SDRAlignmentList::__construct(), SDRAlignmentAncestryObj::__construct(), and SDRContextObj::setXMLImpl().

---

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

• SWAT/model2/SXMLModel.php5