STransMediaDocument Class Reference
[Translators]

This class translates document resources into html for display. More...

Inheritance diagram for STransMediaDocument:

[legend]

List of all members.

Public Member Functions
	doc ()
	returns a brief description of this class
	getInFormat ()
	returns the desired input type
	getOutFormat ()
	returns the output type
	translate ($si)
	Translates the document resource into html.

---

Detailed Description

This class translates document resources into html for display.

---

Member Function Documentation

STransMediaDocument::doc

(

)

returns a brief description of this class

Returns:

[string]: A brief description of this class

Reimplemented from STrans.

STransMediaDocument::getInFormat

(

)

returns the desired input type

Returns:

[string]: Always returns the string 'media_document', the only input this handles.

Reimplemented from STrans.

STransMediaDocument::getOutFormat

(

)

returns the output type

Returns:

[string]: Always returns the string 'html', the only output this gives.

Reimplemented from STrans.

STransMediaDocument::translate

(

$

si

)

Translates the document resource into html.

Parameters:

$si

[SInput]: the current SInput object being translated.

Returns:

[boolean]: always returns true.

Reimplemented from STrans.

---

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

• pr2/translate/STransMediaDocument.php5