STransNSDLSearchXML Class Reference
[Translators]

Translates the xml for NSDL search bars. More...

Inheritance diagram for STransNSDLSearchXML:

Inheritance graph
[legend]

List of all members.

Public Member Functions

 translate ($si)
 Translates the XML into html.

Protected Member Functions

 addForwardBackButtons ($xml, $si)
 adds buttons for going forward and backward through search results.
 addHeaderFooter ($xml, $si)
 creates the header, then the footer (in sequential calls) for a given XML. not used.
 buildCWISURL ($ss, $sr)
 A CWIS URL building helper function.


Detailed Description

Translates the xml for NSDL search bars.

Definition at line 7 of file STransNSDLSearchXML.php5.


Member Function Documentation

STransNSDLSearchXML::addForwardBackButtons ( xml,
si 
) [protected]

adds buttons for going forward and backward through search results.

For internal use only.

Parameters:
$xml [SimpleXMLObject]: The XML being translated.
$si [SInput]: the SInput object being translated.
Returns:
[string]: the HTML for the forward/backward buttons.

Definition at line 120 of file STransNSDLSearchXML.php5.

References buildCWISURL(), and SConfig::getOption().

Referenced by translate().

STransNSDLSearchXML::addHeaderFooter ( xml,
si 
) [protected]

creates the header, then the footer (in sequential calls) for a given XML. not used.

For internal use only.

Parameters:
$xml [SimpleXMLObject]: the XML being translated.
$si [SInput]: the SInput being translated.
Returns:
[string]: The HTML for the header/footer.

Definition at line 61 of file STransNSDLSearchXML.php5.

References SWATFunctions::stripArgs().

STransNSDLSearchXML::buildCWISURL ( ss,
sr 
) [protected]

A CWIS URL building helper function.

For internal use only.

Parameters:
$ss [string]: the search string (I Think);
$sr [integer]: the search results number.
Returns:
[string]: A completed CWIS URL.

Definition at line 172 of file STransNSDLSearchXML.php5.

References SWATFunctions::stripArgs().

Referenced by addForwardBackButtons().

STransNSDLSearchXML::translate ( si  ) 

Translates the XML into html.

Parameters:
$si [SInput]: the current SInput object being translated.
Returns:
[boolean]: always returns true.

Reimplemented from STransXML.

Definition at line 18 of file STransNSDLSearchXML.php5.

References addForwardBackButtons(), SXMLHelper::parse(), and STrans::sendToTarget().


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

Generated on Wed Nov 24 02:06:45 2010 for Common by  doxygen 1.5.6