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. | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getDescription () | |
Returns the description string for this module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. |
Definition at line 34 of file ApiFormatYaml.php.
ApiFormatYaml::__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 36 of file ApiFormatYaml.php.
ApiFormatYaml::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 ApiFormatYaml.php.
References ApiBase::getResultData(), ApiFormatBase::printText(), and Spyc::YAMLDump().
ApiFormatYaml::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiFormatBase.
Definition at line 48 of file ApiFormatYaml.php.
ApiFormatYaml::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 40 of file ApiFormatYaml.php.
ApiFormatYaml::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 52 of file ApiFormatYaml.php.