STransXML Class Reference
[Translators]

the parent class for all the STransStdXML classes. Contains helper functions for translating XML into HTML. More...

Inheritance diagram for STransXML:

[legend]

List of all members.

Public Member Functions
	doc ()
	returns a brief description of this class.
	getInFormat ()
	gets the desired input format (always XML). This will always return xml, because that is all this translator translates.
	getOutFormat ()
	the desired output format (always HTML). This will always return html, because that is all this translator can translate into.
	translate ($si)
	Gets the desired custom translator (if set, from parent) and retrieves an XML object. Any SInput with the name "Main" is handled differently.

---

Detailed Description

the parent class for all the STransStdXML classes. Contains helper functions for translating XML into HTML.

---

Member Function Documentation

STransXML::doc

(

)

returns a brief description of this class.

Returns:

[string]: a brief description of this class.

Reimplemented from STrans.

Reimplemented in STransBookXML, STransListXML, STransNavXML, STransPhotoXML, STransStdXML, and STransStdXML3.

STransXML::getInFormat

(

)

gets the desired input format (always XML). This will always return xml, because that is all this translator translates.

Returns:

[string]: the string 'xml'.

Reimplemented from STrans.

Reimplemented in STransStdXML, and STransStdXML3.

STransXML::getOutFormat

(

)

the desired output format (always HTML). This will always return html, because that is all this translator can translate into.

Returns:

[string]: the string 'html'.

Reimplemented from STrans.

Reimplemented in STransStdXML, and STransStdXML3.

STransXML::translate

(

$

si

)

Gets the desired custom translator (if set, from parent) and retrieves an XML object. Any SInput with the name "Main" is handled differently.

Parameters:

$si

[SInput]: the SInput object being loaded.

Returns:

[boolean]: True on success, false on failure.

Reimplemented from STrans.

Reimplemented in STransBookXML, STransListXML, STransNavXML, STransNSDLSearchXML, STransPhotoXML, STransSDRMetadata, STransStdXML, STransStdXML3, STransXFormsXML, and TransSDRPendingXML.

---

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

• pr2/translate/STransXML.php5