API module for sending out RSD information. More...
Public Member Functions | |
| 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. | |
| getCustomPrinter () | |
| If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. | |
| getDescription () | |
| Returns the description string for this module. | |
| getExamples () | |
| Returns usage examples for this module. | |
| getParamDescription () | |
| Returns an array of parameter descriptions. | |
Protected Member Functions | |
| formatRsdApiList () | |
| Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter. | |
| getRsdApiList () | |
| Builds an internal list of APIs to expose information about. | |
Detailed Description
API module for sending out RSD information.
Definition at line 32 of file ApiRsd.php.
Member Function Documentation
| ApiRsd::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 34 of file ApiRsd.php.
References $result, array(), formatRsdApiList(), ApiBase\getResult(), Title\newMainPage(), and ApiResult\setContent().
| ApiRsd::formatRsdApiList | ( | ) | [protected] |
Formats the internal list of exposed APIs into an array suitable to pass to the API's XML formatter.
- Returns:
- array
Definition at line 119 of file ApiRsd.php.
References $name, array(), as, ApiBase\getResult(), getRsdApiList(), ApiResult\setContent(), and wfBoolToStr().
Referenced by execute().
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.
Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.
- Returns:
- array|bool
Reimplemented from ApiBase.
Definition at line 54 of file ApiRsd.php.
References array().
If the module may only be used with a certain format module, it should override this method to return an instance of that formatter.
A value of null means the default format will be used.
- Returns:
- mixed instance of a derived class of ApiFormatBase, or null
Reimplemented from ApiBase.
Definition at line 50 of file ApiRsd.php.
References ApiBase\getMain().
Returns the description string for this module.
- Returns:
- mixed string or array of strings
Reimplemented from ApiBase.
Definition at line 62 of file ApiRsd.php.
Returns usage examples for this module.
Return false if no examples are available.
- Returns:
- bool|string|array
Reimplemented from ApiBase.
Definition at line 66 of file ApiRsd.php.
References array().
Returns an array of parameter descriptions.
Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
- Returns:
- array|bool False on no parameter descriptions
Reimplemented from ApiBase.
Definition at line 58 of file ApiRsd.php.
References array().
| ApiRsd::getRsdApiList | ( | ) | [protected] |
Builds an internal list of APIs to expose information about.
Normally this only lists the MediaWiki API, with its base URL, link to documentation, and a marker as to available authentication (to aid in OAuth client apps switching to support in the future).
Extensions can expose other APIs, such as WordPress or Twitter- compatible APIs, by hooking 'ApiRsdServiceApis' and adding more elements to the array.
See http://cyber.law.harvard.edu/blogs/gems/tech/rsd.html for the base RSD spec, and check WordPress and StatusNet sites for in-production examples listing several blogging and micrblogging APIs.
- Returns:
- array
Definition at line 89 of file ApiRsd.php.
References array(), wfExpandUrl(), wfRunHooks(), and wfScript().
Referenced by formatRsdApiList().
The documentation for this class was generated from the following file:
- includes/api/ApiRsd.php
