Inherits ApiFormatBase.
Public Member Functions | |
__construct ($main, $errorFallback) | |
Constructor. | |
getMimeType () | |
Overriding class returns the mime type that should be sent to the client. | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getVersion () | |
Returns a string that identifies the version of the extending class. |
Definition at line 35 of file ApiFormatRaw.php.
ApiFormatRaw::__construct | ( | $ | main, | |
$ | errorFallback | |||
) |
Constructor.
$main | ApiMain object | |
$errorFallback | Formatter object to fall back on for errors |
Reimplemented from ApiFormatBase.
Definition at line 42 of file ApiFormatRaw.php.
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 56 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.
Reimplemented from ApiFormatBase.
Definition at line 47 of file ApiFormatRaw.php.
References ApiBase::dieDebug(), and ApiBase::getResultData().
ApiFormatRaw::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
Reimplemented from ApiBase.
Definition at line 68 of file ApiFormatRaw.php.