STransNavXML Class Reference
[Translators]

Translates a given NavXML resource into HTML for PageRender. More...

Inheritance diagram for STransNavXML:

[legend]

List of all members.

Public Member Functions
	doc ()
	returns a brief description of this class
	translate ($si)
	Translates the NavXML resource into html.
Protected Member Functions
	createSearchBox ($xml)
	Reads the search bar section of the xml and creates a search box (if necessary). Like almost all the translator functions, this inputs its results directly into PageRender.
	formatNavBrowseHtml ($navXml, $si)
	Translates all the XML for the "Browse" menu.
	formatNavJumpToHtml ($navXml, $si)
	Translates all the XML for the "Jump To" menu.
	formatNavLocHtml ($navXml)
	Translates all the XML for the "Breadcrumbs Trail".

---

Detailed Description

Translates a given NavXML resource into HTML for PageRender.

STransNavXML translates a NavXML string to generate all the navigation elements of your page ---the breadcrumbs and the jump-to, browse, and search controls.

Author:

Jonathan Stuart-Moore <jwsm@shodor.org>

---

Member Function Documentation

STransNavXML::createSearchBox

(

$

xml

)

[protected]

Reads the search bar section of the xml and creates a search box (if necessary). Like almost all the translator functions, this inputs its results directly into PageRender.

Parameters:

$xml

[SimpleXMLObject]: The xml being translated.

STransNavXML::doc

(

)

returns a brief description of this class

Returns:

[string]: A brief description of this class

Reimplemented from STransXML.

STransNavXML::formatNavBrowseHtml	(	$	navXml,
		$	si
	)			[protected]

Translates all the XML for the "Browse" menu.

Parameters:

	$navXml	[SimpleXMLObject]: The (entire) XML object being translated (Not just the browse tags, though the name may seem to imply that).
	$si	[SInput]: The SInput object being translated.

STransNavXML::formatNavJumpToHtml	(	$	navXml,
		$	si
	)			[protected]

Translates all the XML for the "Jump To" menu.

Parameters:

	$navXml	[SimpleXMLObject]: The (entire) XML object being translated (Not just the jump to tags, though the name may seem to imply that).
	$si	[SInput]: The SInput object being translated.

STransNavXML::formatNavLocHtml

(

$

navXml

)

[protected]

Translates all the XML for the "Breadcrumbs Trail".

Parameters:

$navXml

[SimpleXMLObject]: The (entire) XML object being translated (Not just the breadcrumb tags, though the name may seem to imply that).

STransNavXML::translate

(

$

si

)

Translates the NavXML resource into html.

Parameters:

$si

[SInput]: the current SInput object being translated.

Returns:

[boolean]: always returns true.

Reimplemented from STransXML.

---

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

• pr2/translate/STransNavXML.php5