STransPhotoXML Class Reference
[Translators]
A class that reads photoviewer XML and outputs a photoviewer.
More...
Public Member Functions | |
| doc () | |
| returns a brief description of this class. | |
| escapeForJavascriptOutput ($text) | |
| escapes javascript sensitive characters for outputting strings. | |
| translate ($si) | |
| Translates the photo XML into html. | |
Protected Member Functions | |
| createPhotoHTML ($xmlobj) | |
| A helper function that puts together the html for a photoviewer. | |
| createPhotoJS ($xmlobj) | |
| A helper function that puts together the javascript for a photoviewer. | |
Protected Attributes | |
| $curPhotoCount | |
| $photoNum | |
| $prefix | |
| $thumbscriptpath | |
Detailed Description
A class that reads photoviewer XML and outputs a photoviewer.Definition at line 7 of file STransPhotoXML.php5.
Member Function Documentation
| STransPhotoXML::createPhotoHTML | ( | $ | xmlobj | ) | [protected] |
A helper function that puts together the html for a photoviewer.
For internal use only.
- Parameters:
-
$xmlobj [SimpleXMLObject]: the entire XML bing translated.
- Returns:
- [string]: HTML ready to be added to the page.
Definition at line 156 of file STransPhotoXML.php5.
References STrans::getOption().
Referenced by translate().
| STransPhotoXML::createPhotoJS | ( | $ | xmlobj | ) | [protected] |
A helper function that puts together the javascript for a photoviewer.
For internal use only.
- Parameters:
-
$xmlobj [SimpleXMLObject]: the entire XML bing translated.
- Returns:
- [string]: javascript ready to be added to the page.
Definition at line 64 of file STransPhotoXML.php5.
References escapeForJavascriptOutput(), and STrans::getOption().
Referenced by translate().
| STransPhotoXML::doc | ( | ) |
returns a brief description of this class.
- Returns:
- [string]: A brief description of this class.
Reimplemented from STransXML.
Definition at line 27 of file STransPhotoXML.php5.
| STransPhotoXML::escapeForJavascriptOutput | ( | $ | text | ) |
escapes javascript sensitive characters for outputting strings.
- Parameters:
-
$text [string]: the text to be escaped.
- Returns:
- [string]: the text with all the sensitive characters escaped.
Definition at line 203 of file STransPhotoXML.php5.
Referenced by createPhotoJS().
| STransPhotoXML::translate | ( | $ | si | ) |
Translates the photo XML into html.
- Returns:
- [boolean]: returns false on error, nothing on success.
Reimplemented from STransXML.
Definition at line 39 of file STransPhotoXML.php5.
References createPhotoHTML(), createPhotoJS(), SXMLHelper::parse(), and STrans::sendToTarget().
Member Data Documentation
STransPhotoXML::$curPhotoCount [protected] |
For internal use only.
another count variable, this one counts the photos (unused).
Definition at line 18 of file STransPhotoXML.php5.
STransPhotoXML::$photoNum [protected] |
For internal use only.
The number of the current photo album (for unique id)
Definition at line 11 of file STransPhotoXML.php5.
STransPhotoXML::$prefix [protected] |
For internal use only.
All the div names have the same prefix for identification. this stores that prefix
Definition at line 15 of file STransPhotoXML.php5.
STransPhotoXML::$thumbscriptpath [protected] |
For internal use only.
apparently stores the path for the thumb nails, but it isn't used in this code.
Definition at line 21 of file STransPhotoXML.php5.
The documentation for this class was generated from the following file:
- pr2/translate/STransPhotoXML.php5
