STransObject Class Reference
[Translators]

the Default translator class that takes data objects as input and outputs HTML. More...

Inheritance diagram for STransObject:

[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)
	Outputs errors. Always. This translator should be extended, not used directly.
Public Attributes
const	MINIMAL
Protected Attributes
	$XMLObj

---

Detailed Description

the Default translator class that takes data objects as input and outputs HTML.

Extend this class if you want to write any page-specific object translators (such as translators that take SModel objects and turn them into html).

Author:

Jonathan Stuart-Moore <jwsm@shodor.org> (6/13/07)

Definition at line 11 of file STransObject.php5.

---

Member Function Documentation

STransObject::doc

(

)

returns a brief description of this class.

Returns:

[string]: A brief description of this class.

Reimplemented from STrans.

Definition at line 29 of file STransObject.php5.

STransObject::getInFormat

(

)

returns the desired input type

Returns:

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

Reimplemented from STrans.

Definition at line 42 of file STransObject.php5.

STransObject::getOutFormat

(

)

returns the output type

Returns:

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

Reimplemented from STrans.

Definition at line 50 of file STransObject.php5.

STransObject::translate

(

$

si

)

Outputs errors. Always. This translator should be extended, not used directly.

Returns:

[boolean]: always returns true.

Reimplemented from STrans.

Definition at line 58 of file STransObject.php5.

References SObject::getError(), SObject::hasError(), SObject::setError(), SObject::setPrettyError(), and SObject::setWarning().

---

Member Data Documentation

STransObject::$XMLObj [protected]

For internal use only.

Another mysterious, unused variable. This is set to an empty string.

Definition at line 23 of file STransObject.php5.

const STransObject::MINIMAL

For internal use only.

Mysterious variables whose values are 1, 2, and 3 that aren't currently used.

Definition at line 16 of file STransObject.php5.

---

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

• pr2/translate/STransObject.php5