Public Member Functions | |
__construct ($main, $format) | |
Constructor If $format ends with 'fm', pretty-print the output in HTML. | |
getMimeType () | |
Overriding class returns the mime type that should be sent to the client. | |
getNeedsRawData () | |
Whether this formatter needs raw data such as _element tags. | |
getWantsHelp () | |
Whether this formatter can format the help message in a nice way. | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getAllowedParams () | |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getDescription () | |
Returns the description string for this module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Private Attributes | |
$mIsRaw |
Definition at line 34 of file ApiFormatJson.php.
ApiFormatJson::__construct | ( | $ | main, | |
$ | format | |||
) |
Constructor If $format ends with 'fm', pretty-print the output in HTML.
$main | ApiMain | |
$format | string Format name |
Reimplemented from ApiFormatBase.
Definition at line 38 of file ApiFormatJson.php.
ApiFormatJson::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 61 of file ApiFormatJson.php.
References FormatJson::encode(), ApiBase::extractRequestParams(), ApiFormatBase::getIsHtml(), ApiBase::getResultData(), and ApiFormatBase::printText().
ApiFormatJson::getAllowedParams | ( | ) |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
Reimplemented from ApiBase.
Definition at line 76 of file ApiFormatJson.php.
ApiFormatJson::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiFormatBase.
Definition at line 88 of file ApiFormatJson.php.
ApiFormatJson::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 43 of file ApiFormatJson.php.
References ApiBase::extractRequestParams().
ApiFormatJson::getNeedsRawData | ( | ) |
Whether this formatter needs raw data such as _element tags.
Reimplemented from ApiFormatBase.
Definition at line 52 of file ApiFormatJson.php.
ApiFormatJson::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 82 of file ApiFormatJson.php.
ApiFormatJson::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 95 of file ApiFormatJson.php.
ApiFormatJson::getWantsHelp | ( | ) |
Whether this formatter can format the help message in a nice way.
By default, this returns the same as getIsHtml(). When action=help is set explicitly, the help will always be shown
Reimplemented from ApiFormatBase.
Definition at line 56 of file ApiFormatJson.php.
ApiFormatJson::$mIsRaw [private] |
Definition at line 36 of file ApiFormatJson.php.