ApiFormatTxt Class Reference

API Text output formatter. More...

Inheritance diagram for ApiFormatTxt:

Collaboration diagram for ApiFormatTxt:

List of all members.

Public Member Functions
	__construct ($main, $format)
	Constructor If $format ends with 'fm', pretty-print the output in HTML.
	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.
	getVersion ()
	Returns a string that identifies the version of the extending class.

---

Detailed Description

API Text output formatter.

Definition at line 31 of file ApiFormatTxt.php.

---

Constructor & Destructor Documentation

ApiFormatTxt::__construct	(	$	main,
		$	format
	)

Constructor If $format ends with 'fm', pretty-print the output in HTML.

Parameters:

$main	ApiMain
$format	string Format name

Reimplemented from ApiFormatBase.

Definition at line 33 of file ApiFormatTxt.php.

---

Member Function Documentation

ApiFormatTxt::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 44 of file ApiFormatTxt.php.

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

Here is the call graph for this function:

ApiFormatTxt::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiFormatBase.

Definition at line 48 of file ApiFormatTxt.php.

ApiFormatTxt::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 37 of file ApiFormatTxt.php.

ApiFormatTxt::getVersion

(

)

Returns a string that identifies the version of the extending class.

Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword

Returns:

string

Reimplemented from ApiBase.

Definition at line 52 of file ApiFormatTxt.php.

---

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

• includes/api/ApiFormatTxt.php