STransSDRMetadata Class Reference
[Translators]

A specific translator for some special XML (I am not sure what or why). More...

Inheritance diagram for STransSDRMetadata:

[legend]

List of all members.

Public Member Functions
	translate ($si)
	Translates a certain part of the XML (I don't know what or why).
Public Attributes
const	NEWTAB
Protected Member Functions
	conglomerateTagValues ($xml, $tag)
	Concatenates the values of the sub tags of a given XML Tag into a comma-seperated list.
	wrapInLink ($link, $tab)
	Embeds the given link in an a href tag (the name and href of the link will be the same).
	wrapInTableRow ($key, $value, $hilight=false)
	Wraps the given key and value in a table row with two fields (one for the key, one for the value).

---

Detailed Description

A specific translator for some special XML (I am not sure what or why).

Definition at line 7 of file STransSDRMetadata.php5.

---

Member Function Documentation

STransSDRMetadata::conglomerateTagValues	(	$	xml,
		$	tag
	)			[protected]

Concatenates the values of the sub tags of a given XML Tag into a comma-seperated list.

For internal use only.

Parameters:

	$xml	[SimpleXMLObject]: The parent of the tags whose values are being concatenated.
	$tag	[string]: The tag name of the child tags.

Returns:

[string]: A string of the tags in a comma-seperated list, or the string "<i>none listed</i>" if there are no child tags of the given name.

Definition at line 88 of file STransSDRMetadata.php5.

Referenced by translate().

STransSDRMetadata::translate

(

$

si

)

Translates a certain part of the XML (I don't know what or why).

Parameters:

$si

[SInput]: The SInput object to translate.

Reimplemented from STransXML.

Definition at line 21 of file STransSDRMetadata.php5.

References conglomerateTagValues(), SXMLHelper::parse(), STrans::sendToTarget(), wrapInLink(), and wrapInTableRow().

STransSDRMetadata::wrapInLink	(	$	link,
		$	tab
	)			[protected]

Embeds the given link in an a href tag (the name and href of the link will be the same).

For internal use only.

Parameters:

	$link	[string]: the link to be wrapped.
	$tab	[integer]: if it equals the local NEWTAB variable (1), sets the link to open in a new window (or tab).

Returns:

[string]: The HTML ready to be added to the document.

Definition at line 104 of file STransSDRMetadata.php5.

Referenced by translate().

STransSDRMetadata::wrapInTableRow	(	$	key,
		$	value,
		$	hilight = false
	)			[protected]

Wraps the given key and value in a table row with two fields (one for the key, one for the value).

For internal use only.

Parameters:

	$key	[string]: What should go in the first field.
	$value	[string]: What should go in the second field.
	$hilight	[string]: Defaults to false. If true, sets the row to be hilighted.

Returns:

[string]: HTML ready to be added to the page.

Definition at line 71 of file STransSDRMetadata.php5.

Referenced by translate().

---

Member Data Documentation

const STransSDRMetadata::NEWTAB

For internal use only.

The constant for whether or not to make a new tab for the wrapInLink function

Definition at line 13 of file STransSDRMetadata.php5.

---

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

• pr2/translate/STransSDRMetadata.php5