ApiFormatWddx Class Reference

API WDDX output formatter. More...

Inheritance diagram for ApiFormatWddx:

Collaboration diagram for ApiFormatWddx:

List of all members.

Public Member Functions
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getDescription ()
	Returns the description string for this module.
	getMimeType ()
	Overriding class returns the mime type that should be sent to the client.
	slowWddxPrinter ($elemValue, $indent=0)
	Recursively go through the object and output its data in WDDX format.

---

Detailed Description

API WDDX output formatter.

Definition at line 31 of file ApiFormatWddx.php.

---

Member Function Documentation

ApiFormatWddx::execute

(

)

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 37 of file ApiFormatWddx.php.

References ApiFormatBase\getIsHtml(), ApiBase\getResultData(), ApiFormatBase\printText(), and slowWddxPrinter().

ApiFormatWddx::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiFormatBase.

Definition at line 107 of file ApiFormatWddx.php.

ApiFormatWddx::getMimeType

(

)

Overriding class returns the mime type that should be sent to the client.

This method is not called if getIsHtml() returns true.

Returns:

string

Reimplemented from ApiFormatBase.

Definition at line 33 of file ApiFormatWddx.php.

ApiFormatWddx::slowWddxPrinter	(	$	elemValue,
		$	indent = 0
	)

Recursively go through the object and output its data in WDDX format.

Parameters:

$elemValue
$indent	int

Definition at line 66 of file ApiFormatWddx.php.

References array(), as, ApiBase\dieDebug(), Xml\element(), ApiFormatBase\getIsHtml(), and ApiFormatBase\printText().

Referenced by execute().

---

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

• includes/api/ApiFormatWddx.php