MediaWiki  REL1_22
Public Member Functions
ApiFormatRaw Class Reference
API

Formatter that spits out anything you like with any desired MIME type. More...

Inheritance diagram for ApiFormatRaw:
Inheritance graph
[legend]
Collaboration diagram for ApiFormatRaw:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($main, $errorFallback)
 Constructor.
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result.
 getMimeType ()
 Overriding class returns the mime type that should be sent to the client.

Detailed Description

Formatter that spits out anything you like with any desired MIME type.

Definition at line 31 of file ApiFormatRaw.php.

Constructor & Destructor Documentation

ApiFormatRaw::__construct ( $  main,
$  errorFallback 
)

Constructor.

Parameters:
$mainApiMain object
$errorFallbackApiFormatBase object to fall back on for errors

Reimplemented from ApiFormatBase.

Definition at line 38 of file ApiFormatRaw.php.

Member Function Documentation

ApiFormatRaw::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 57 of file ApiFormatRaw.php.

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

ApiFormatRaw::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 43 of file ApiFormatRaw.php.

References ApiBase\dieDebug(), and ApiBase\getResultData().

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