STransStdXML3 Class Reference
[Translators]

The newest XML translator. Coordinates translation of the various SInput objects. Mostly interacts with the STransXML3Helper.php, handing tags to it. More...

Inheritance diagram for STransStdXML3:

[legend]

List of all members.

Public Member Functions

doc ()

INSERT BRIEF DESCRIPTION HERE.

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.

getPage ()

Gets the current SPage object.

translate ($si)

gets the desired translator and creates an XML object for translation. The helper translates into HTML, which is automatically appended to the page. If the resource source code is in snap, is will just pull the source. Otherwise, it parses the root tag to find out what kind of resource it is (if there is no root tag it isn't happy). If the translation helper doesn't submit all the output to the page for it, it submits it itself (as in the case of XML Resources).

Public Attributes

const XML_UNKNOWN

Protected Member Functions

translateAlbum ($xmlAlbum, $si)

A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.

translateList ($xmlList, $si)

A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.

translateResource ($xmlResource)

A function that calls another function of the same name in the XML helper class.

Protected Attributes

$transHelperClass

Detailed Description

The newest XML translator. Coordinates translation of the various SInput objects. Mostly interacts with the STransXML3Helper.php, handing tags to it.

Definition at line 8 of file STransStdXML3.php5.

Member Function Documentation

STransStdXML3::doc ( )

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:: [TYPE]: RETURN DESCRIPTION

Reimplemented from STransXML.

Definition at line 31 of file STransStdXML3.php5.

STransStdXML3::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 STransXML.

Definition at line 45 of file STransStdXML3.php5.

STransStdXML3::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 STransXML.

Definition at line 54 of file STransStdXML3.php5.

STransStdXML3::getPage ( )

Gets the current SPage object.

Returns:: [object]: the current page.

Definition at line 141 of file STransStdXML3.php5.

STransStdXML3::translate ( $ si )

gets the desired translator and creates an XML object for translation. The helper translates into HTML, which is automatically appended to the page. If the resource source code is in snap, is will just pull the source. Otherwise, it parses the root tag to find out what kind of resource it is (if there is no root tag it isn't happy). If the translation helper doesn't submit all the output to the page for it, it submits it itself (as in the case of XML Resources).

Parameters:

$si

[SInput]:

Reimplemented from STransXML.

Definition at line 65 of file STransStdXML3.php5.

References STrans::getInputOption(), SXMLHelper::parse(), STrans::sendToTarget(), STrans::setOption(), translateAlbum(), translateList(), translateResource(), and XML_UNKNOWN.

STransStdXML3::translateAlbum	(	$	xmlAlbum,
		$	si
	)			`[protected]`

A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.

For internal use only.

Parameters:

	$xmlAlbum	[xmlDom]: An XML Dom object representing the source of the SInput.
	$si	[SInput]: The current SInput Object.

Definition at line 116 of file STransStdXML3.php5.

Referenced by translate().

STransStdXML3::translateList	(	$	xmlList,
		$	si
	)			`[protected]`

A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.

For internal use only.

Parameters:

	$xmlList	[xmlDom]: An XML Dom object representing the source of the SInput.
	$si	[SInput]: The current SInput Object.

Definition at line 126 of file STransStdXML3.php5.

Referenced by translate().

STransStdXML3::translateResource ( $ xmlResource ) [protected]

A function that calls another function of the same name in the XML helper class.

For internal use only.

Parameters:

$xmlResource

[xmlDom]: An XML Dom object representing the source of the SInput.

Returns:: [string]: the HTML from translation

Definition at line 134 of file STransStdXML3.php5.

Referenced by translate().

Member Data Documentation

STransStdXML3::$transHelperClass [protected]

For internal use only.

The XML helper class this class uses.

Reimplemented from STrans.

Definition at line 22 of file STransStdXML3.php5.

const STransStdXML3::XML_UNKNOWN

For internal use only.

This is a list of possible root tags (Resource, List, or Album). The root type is passed to the Helper.

Definition at line 14 of file STransStdXML3.php5.

Referenced by translate().

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

pr2/translate/STransStdXML3.php5


Public Member Functions
	doc ()
	INSERT BRIEF DESCRIPTION HERE.
	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.
	getPage ()
	Gets the current SPage object.
	translate ($si)
	gets the desired translator and creates an XML object for translation. The helper translates into HTML, which is automatically appended to the page. If the resource source code is in snap, is will just pull the source. Otherwise, it parses the root tag to find out what kind of resource it is (if there is no root tag it isn't happy). If the translation helper doesn't submit all the output to the page for it, it submits it itself (as in the case of XML Resources).
Public Attributes
const	XML_UNKNOWN
Protected Member Functions
	translateAlbum ($xmlAlbum, $si)
	A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.
	translateList ($xmlList, $si)
	A function that calls another function of the same name in the XML helper class. This function uses the same returns as the helper class, but has one less parameter The second parameter for the function in the helper class refers to this class, and so is unnecessary for this class.
	translateResource ($xmlResource)
	A function that calls another function of the same name in the XML helper class.
Protected Attributes
	$transHelperClass

STransStdXML3 Class Reference [Translators]

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation

STransStdXML3 Class Reference
[Translators]