API YAML output formatter. More...
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. | |
Detailed Description
Member Function Documentation
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 ApiFormatJson.
Definition at line 38 of file ApiFormatYaml.php.
References ApiFormatBase\markDeprecated().
Returns the description string for this module.
- Returns:
- string|array
Reimplemented from ApiFormatJson.
Definition at line 43 of file ApiFormatYaml.php.
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 ApiFormatJson.
Definition at line 34 of file ApiFormatYaml.php.
The documentation for this class was generated from the following file:
- includes/api/ApiFormatYaml.php
